WIXLIB

HL7 v2 Inbound RDESpecificationVersion 0.1Healthix, Inc.40 Worth St., 5th FloorNew York, NY 100131-877-695-4749 Ext. 1healthix.org

Table of Contents1.1.1.2.Overview of RDE Docs: Message Types. 3Important Points to Note . 31.1.1Patient Identifiers . 31.1.2Guidelines for RDE Docs messages . 3RDE - Segments & Groups of segments in the RDE message. 42.1.RDE Message Content . 42.2.RDE Docs Segment Attribute Table Abbreviations . 4MSH - Message Header Segment . 5PID – Patient Identification Segment . 5PV1 – Patient Visit Segment . 7PV2 – Patient Visit Additional Information Segment . 9IN1 – Insurance Segment . 9AL1 – Patient Allergy Information Segment . 10ORC – Common order segment . 10RXO– Pharmacy prescription order segment . 12RXR– Pharmacy route segment . 13RXC– Pharmacy/Treatment Component Order Segment . 13RXE– Pharmacy/Treatment Encoded Order Segment . 14OBX – Observation Result Segment . 16CTI – Clinical Trial Identification. 173.Appendix . 18RDE Sample Message - . 18

1. Overview of RDE Docs: Message TypesThis specification is for organizations preparing HL7 interfaces to Healthix. It dictates the format and context ofrequired and required if available RDE message types, segments and fields. Healthix prefers HL7 version 2.5 messagesbut will accept well-formed HL7 2.x messages.Healthix requires data providers to include all required data elements in their feeds (denoted by an R in the “use”column of the segment tables). Healthix also requires data providers to include all ‘required if available’ dataelements if they are available (denoted by an A in the “use” column of the segment tables). The value of Healthix isdirectly related to the quality of accurate, consistent, and complete information. The inclusion of all required dataelements increases the value of Healthix to users and patients. Consequently, it is imperative that you send allrequired and ‘required if available’ data elements through the interfaces.This specification is for RDE message types only. Non-RDE specifications are documented separately.1.1.1.1.1Important Points to NotePatient IdentifiersHealthix patient encounters are identified by Visit Numbers. To tie all this information to the visit, correspondingvisit numbers must be present in all related RDEs.Healthix uses the following identifier hierarchy:External Patient IDInternal Patient IDEncounter ID Healthix-generated ID (MPI) Unique MRN from a site (PID-3 or PID-2) Unique visit number from a site (PV1-19) A single patient can have different MRNs from different sites A single patient can have multiple encounters from one siteHealthcare information systems may use Account Numbers or Case Numbers for billing purposes and consequentlyan encounter number, as well. In these cases, an encounter number may reside in PID-18 and/or PV1-19. If PID-18 isused consistently for an encounter instead of PV1-19, the Account Number in PID-18 should be copied to the VisitNumber in PV1-19. A case or account may correspond to multiple visits. In that instance, the encounter is either asingle visit or series of visits associated with a single case or account. Either way, the unique identifier for theencounter must reside in PV1-19.1.1.2Guidelines for RDE Docs messagesAn identifier is associated with a set (or sets) of data. For example, an identifier (PID-3 - Patient Identifier List) may be an MRNwhich has account numbers (PID-18 - Patient Account Number) associated with it. Account number (PID-18 – Patient AccountNumber) is a type of identifier which may have visit numbers (PV1-19 – Visit Number) associated with it.

2. RDE - Segments & Groups of segments in the RDE messageThe segments and groups of segments in the RDE message are as follows, and apply for all trigger events:2.1.RDE Message ContentSegmentDescriptionMSHMessage HeaderNTENotes and commentsPIDPatient identificationPID1Patient demographicsNTE-1Notes and eatingRequiredPV1Patient visitPV2Patient visit – additional infoIN1InsuranceIN2Insurance additional infoIN3Insurance additional info certificationGT1GuarantorAL1Patient allergy informationORCCommon order segmentRequiredRXOPharmacy prescription order segmentRequiredNTE-2Notes and comments segmentOptionalRXRPharmacy route segmentOptionalRXCPharmacy component order segmentOptionalNTE-3Notes and comments segmentOptionalRXEPharmacy encoded order segmentRXR-1Pharmacy route segmentRXC-1Pharmacy component order segmentOptionalOBXObservation segmentOptionalNTE-4Notes and comments segmentOptionalCTIClinical Trial nalRepeatingRepeatingRequiredRepeatingRepeatingKey to symbols used in this section. 2.2.Brackets [ ] indicate that the segment is an optional item in the message.Braces { } indicate that the segment can be a repeating item in the message.RDE Docs Segment Attribute Table AbbreviationsThe abbreviated terms and their definitions, as used in the segment table headings, are as follows:KEY - SEGMENT ATTRIBUTESAbbreviationSeqDefinitionSequence of the elements as they are numbered in the HL7 segment.Maximum length of the element. Length of an element is calculated using the following rules:LenField length (Sum of all supported component lengths) (component number of the last supportedcomponent) – 1.Component length (Sum of all supported sub-component lengths) (sub-component number of the lastsupported component) – 1.DTData type used for HL7 element. (Refer to Chapter 2A of HL7 V2.5 standard)

Usage indicates that the field or sub-field is required, expected, or optional. R –Required. Must be populated.UseE – Expected. Must be populated if available. O –Optional. May be populated.Cardinality indicates the minimum and maximum number of times the element may appear. [0.0]Element never present.Card[0.1]Element may be omitted and it can have at most, one Occurrence.[1.1]Element must have exactly one Occurrence.[0.n]Element may be omitted or may repeat up to n times.[1.n]Element must appear at least once, and may repeat up to n times. [0.*]Element may be omitted or repeat for an unlimited number of times.[1.*]HL7 Element NameElement must appear at least once, and may repeat unlimited number of times. [m.n]Element must appear at least “m” and at most “n” times.HL7 descriptor of the element in the segment.MSH - Message Header SegmentThe message header is mandatory for every message.MESSAGE HEADER SEGMENT 1.1][1.1][1.1][1.1][0.1][0.1][1.1]1ST4ST227 HD227 HD227 HD227 HD26TS40ST15 MSG3ID3ID7ID50ST3PT60 VIDHL7 Element NameField SeparatorEncoding CharactersSending ApplicationSending FacilityReceiving ApplicationReceiving FacilityDate/Time Of MessageSecurityMessage TypeMessage CodeTrigger EventMessage StructureMessage Control IDProcessing IDVersion ID (v2.5)PID – Patient Identification SegmentThe Patient Identification Segment is used as the primary means of conveying patient identification information.PATIENT IDENTIFICATION SEGMENT ][0.1][1.1][1.1]HL7 Element NameSet ID - PIDPatient IDPatient Identifier ListID Number

PATIENT IDENTIFICATION SEGMENT 0.1][0.1][0.1][0.1][0.1][0.1]HL7 Element NameCheck DigitCheck Digit SchemeAssigning AuthorityIdentifier Type Code (default MRN)Alternate Patient ID - PIDPatient NameMother’s Maiden NameDate/Time of BirthAdministrative Sex*Patient AliasRacePatient AddressStreet AddressOther DesignationCityState or ProvinceZip or Postal CodeCountryCounty CodePhone Number – HomePhone Number – BusinessPrimary LanguageMarital StatusReligionPatient Account NumberSSN NumberDriver’s License NumberMother’s IdentifierEthnic GroupBirth PlaceMultiple Birth IndicatorBirth OrderCitizenshipVeterans Military StatusNationalityPatient Death Date and TimePatient Death IndicatorIdentity Unknown IndicatorIdentity Reliability CodeLast Update Date/Time

PATIENT IDENTIFICATION SEGMENT (PID)Seq34LenDTUse241HDECardHL7 Element Name[0.1] Last Update Facility*PID-8 Administrative Sex (IS)Healthix uses this to determine the sex of the patient and must be contain one of the following mbiguous or Not applicableNot applicablePV1 – Patient Visit SegmentThe Patient Visit Segment is used to transmit encounter-specific information.PATIENT VISIT SEGMENT WEPLISISISCWECXPLXCNXCNXCNCWESTST80PL2IS2IS250 CWESTST2IS2IS250 .1][0.1][0.1]HL7 Element NameSet ID - PV1Patient Class*Assigned Patient LocationPoint of CareRoomBedAdmission TypePre-admit NumberPrior Patient LocationAttending DoctorReferring DoctorConsulting DoctorHospital ServiceIdentifierTextTemporary LocationPre-admit Test IndicatorRe-admission IndicatorAdmit SourceIdentifierTextAmbulatory StatusVIP IndicatorAdmitting DoctorPatient Type

PATIENT VISIT SEGMENT 404142434445LenDT250 CX50FC2IS2IS2IS2IS8DT12 NM3NM2IS4IS8DT10IS12 NM12 NM1IS8DT250 CWE47 DLD250 CE199 .1][0.1][0.1][0.1][0.1][0.1][0.1][0.1][0.1]HL7 Element NameVisit NumberFinancial ClassCharge Price IndicatorCourtesy CodeCredit RatingContract CodeContract Effective DateContract AmountContract PeriodInterest CodeTransfer to Bad Debt CodeTransfer to Bad Debt DateBad Debt Agency CodeBad Debt Transfer AmountBad Debt Recovery AmountDelete Account IndicatorDelete Account DateDischarge DispositionDischarged to LocationDiet TypeServicing FacilityBed StatusAccount StatusPending LocationPrior Temporary LocationAdmit Date/TimeDischarge Date/Time*PV1-2 Patient Class (IS)Healthix uses this to categorize patients by class codes like the following user defined tpatientPreadmitRecurring PatientObstetricsCommercial AccountNot ApplicableUnknown

PV2 – Patient Visit Additional Information SegmentThe Patient Visit Additional Information Segment is a continuation of visit-specific information and should contain the AdmitReason, Visit Reason, Chief Complaint information.PATIENT VISIT ADDITIONAL INFORMATION SEGMENT ][0.1][0.1][0.1][0.*]2502525226263350250HL7 Element NamePrior Pending LocationAccommodation CodeAdmit ReasonIdentifierTextTransfer ReasonPatient ValuablesPatient Valuables LocationVisit User CodeExpected Admit Date/TimeExpected Discharge Date/TimeEstimated Length of Inpatient StayActual Length of Inpatient StayVisit DescriptionTransfer ReasonIN1 – Insurance SegmentThe Insurance Segment contains insurance policy coverage information.INSURANCE SEGMENT ][0.1][0.1][0.1][0.1][0.*][0.1]HL7 Element NameSet ID - IN1Insurance Plan IDInsurance Company IDInsurance Company NameInsurance Company AddressInsurance Co Contact PersonInsurance Co Phone NumberGroup NumberGroup NameInsured’s Group Emp IDInsured’s Group Emp NamePlan Effective DatePlan Expiration DateAuthorization InformationPlan TypeName of InsuredInsured’s Relationship to Patient

INSURANCE SEGMENT 0.1][0.*][0.1][0.1][0.1][0.1][0.1][0.1]HL7 Element NameInsured’s DOBInsured’s AddressAssignment Of BenefitsCoordination Of BenefitsCoordination Of Benefits PriorityNotice Of Admission FlagNotice Of Admission DateReport Of Eligibility FlagReport Of Eligibility DateRelease Information CodePre-Admit Cert (PAC)Verification Date/TimeVerification ByType Of Agreement CodeBilling StatusLifetime Reserve DaysDelay Before L.R. DayCompany Plan CodePolicy NumberAL1 – Patient Allergy Information SegmentThe AL1 segment contains patient allergy information of various types. This information should be derived from user-definedtables. Each AL1 segment describes a single patient allergy.PATIENT ALLERGY INFORMATION SEGMENT (AL1)SeqLenDTUseCardHL7 Element t ID – AL1Allergen Type CodeAllergen Code/Mnemonic/DescriptionIdentifierTextAllergy Severity CodeAllergy Reaction CodeIdentification DateORC – Common order segmentThe Common Order segment (ORC) is used to transmit fields that are common to all orders (all types of services that arerequested). The ORC segment is required in the Order (ORM) message. ORC is mandatory in Order Acknowledgment (ORR)messages if an order detail segment is present, but is not required otherwise.