28
MEDfx HL7 Interface Companion Guide Document Companion Guide Document ID 30-1310-007 Version 2.0 Date 10/10/2013 Author Jennifer Bessette

MEDfx HL7 Interface · MEDfx HL7 Interface . Companion Guide . Document Companion Guide Document ID 30-1310-007 Version 2.0 Date 10/10/2013 Author Jennifer Bessette

Embed Size (px)

Citation preview

MEDfx HL7 Interface Companion Guide

Document Companion Guide

Document ID 30-1310-007

Version 2.0

Date 10/10/2013

Author Jennifer Bessette

DOC ID: 30-1310-007 Companion Guide MEDfx HL7 Companion Guide, 2.0 Copyright © 2013, MEDfx and/or its affiliates. All rights reserved. This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable: U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007).MEDfx Corporation, 150 Lavan Street, Warwick, RI 02889. This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of this software. MEDfx Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications. MEDfx is a registered trademark of MEDfx Corporation and/or its affiliates. Other names may be trademarks of their respective owners. This software and documentation may provide access to or information on content, products, and services from third parties. MEDfx Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. MEDfx Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

Page 2 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide

Table of Contents

1 DOCUMENT ROADMAP AND CONTROL .............................................................................. 5

1.1 Revision History ....................................................................................................... 5

1.2 Access Control and Document Distribution ............................................................... 5

1.3 Purpose and Scope of this Document ....................................................................... 5

1.4 Process for Updating this Document ........................................................................ 5

1.5 Relationship to Other Documents ............................................................................ 5

Related MEDfx Documentation ...................................................................... 5 1.5.1

Related Third-Party Documentation ............................................................... 5 1.5.2

2 Introduction .................................................................................................................... 6

2.1 Purpose ................................................................................................................... 6

2.2 Intended Audience .................................................................................................. 6

2.1 Disclaimer ............................................................................................................... 6

3 Transport ......................................................................................................................... 6

3.1 Inbound .................................................................................................................. 6

3.2 Outbound ................................................................................................................ 6

4 Supported Messages ........................................................................................................ 6

4.1 Message Types ........................................................................................................ 6

4.2 Message Formats ..................................................................................................... 7

5 Segments ......................................................................................................................... 7

5.1 Notation .................................................................................................................. 7

5.2 AIP Segment ............................................................................................................ 7

5.3 DG1 Segment........................................................................................................... 8

5.4 EVN Segment ........................................................................................................... 8

5.5 FT1 Segment ............................................................................................................ 9

5.6 IN1 Segment ............................................................................................................ 9

5.7 MFE Segment ........................................................................................................ 11

5.8 MFI Segment ......................................................................................................... 11

5.9 MSH Segment ........................................................................................................ 12

5.10 PID Segment .......................................................................................................... 12

Page 3 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide

5.11 PRA Segment ......................................................................................................... 13

5.12 PV1 Segment ......................................................................................................... 14

5.13 RGS Segment ......................................................................................................... 15

5.14 ROL Segment ......................................................................................................... 15

5.15 SCH Segment ......................................................................................................... 16

5.16 STF Segment .......................................................................................................... 16

5.17 ZPL Segment .......................................................................................................... 17

6 Table Mappings ............................................................................................................. 17

6.1 Country Codes ....................................................................................................... 17

6.2 Death Indicator (see Table 136, Yes/No) ................................................................. 23

6.3 Ethnic Group Codes (Table 189) .............................................................................. 23

6.4 Filler Status Codes (Table 278)................................................................................ 23

6.5 Gender Codes (Table 1) .......................................................................................... 24

6.6 Language Codes (Table 296) ................................................................................... 24

6.7 Marital Status Codes (Table 2)................................................................................ 24

6.8 Master File Identification Codes (Table 175) ........................................................... 24

6.9 Race Codes (Table 5) .............................................................................................. 24

6.10 Record Level Event Codes (Table 180)..................................................................... 25

6.11 Relationship Codes (Table 63) ................................................................................ 25

6.12 Role Codes (Table 287) ........................................................................................... 25

6.13 State Codes ........................................................................................................... 25

6.14 Suffix Codes ........................................................................................................... 27

6.15 Yes/No (Table 136) ................................................................................................ 27

7 Unsupported Tables ....................................................................................................... 27

1

Page 4 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide

1 DOCUMENT ROADMAP AND CONTROL

1.1 Revision History

Version Revision Date

Implemented By Approved By Approval

Date Reason

1.0 07/13/2009 Initial Draft

2.0 10/08/2013 Jennifer Bessette MU additions

1.2 Access Control and Document Distribution This document is for licensed customers and is confidential. Distribution is prohibited.

1.3 Purpose and Scope of this Document These instructions are intended to provide operational information for a developer, system administrator or technician operating or supporting the system.

1.4 Process for Updating this Document If you would like to suggest modifications or corrections to this document, contact MEDfx.

1.5 Relationship to Other Documents This document may reference third-party URLs for more detailed technical information. Referencing this material does not constitute any form of endorsement or warranty.

Related MEDfx Documentation 1.5.1

ID Title Version

Related Third-Party Documentation 1.5.2

ID Title Version Location/URL

Health Level Seven: An Application Protocol for Electronic Data Exchange In Healthcare Environments

2.3 www.hl7.org

Page 5 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide

2 INTRODUCTION

2.1 Purpose This document augments the Health Level Seven v2.3 standard – upon which the guide is based – and details the following Electronic Data Interchange (EDI) functions:

• Outbound patient registration information (ADT) • Outbound scheduling information (SIU) • Inbound financial transaction information (DFT) • Outbound master file (MFN)

2.2 Intended Audience This document is intended for use by developers or technical resources responsible for EDI implementations between practice management and EMR systems.

2.1 Disclaimer This document contains the latest MEDfx PM specification and supersedes all previous versions. The contents of this document are subject to change at any time, without warning or prior notification.

3 TRANSPORT

3.1 Inbound Inbound interfaces can be setup to transport messages via any of the following:

• TCP/IP • SFTP • Filesystem Folder Monitoring

3.2 Outbound Inbound interfaces can be setup to transport messages via any of the following:

• TCP/IP • SFTP • Filesystem Folder Monitoring

4 SUPPORTED MESSAGES

4.1 Message Types The MEDfx HL7 interface supports the following outbound registration message types:

Message type code Message type description

A04 Register patient A08 Update patient information

Page 6 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide

M02 Master file, staff practitioner P03 Detail financial transaction S12 Add appointment S13, S14 Update appointment information S15, S22 Remove appointment S26 Missed appointment ZQ2 Master file, insurance plan

4.2 Message Formats The following describes the segments that make up each message type. Optional segments are surrounded by square brackets – i.e. [ ]. Segments that may be repeated are surrounded by curly braces – i.e. { }.

Message type code Segments A04, A08 MSH-EVN-PID-[ {IN1} ]–[ {ROL} ] M02 MSH-MFI-MFE-PRA-STF P03 MSH-EVN-PID-[ {PV1} ]-[ {FT1} ] S12, S13, S14, S15, S22 MSH-SCH-PID-RGS-{AIP} ZQ2 MSH-MFI-MFE-ZPL

5 SEGMENTS 5.1 Notation Each of the message types listed above requires a set of data segments. The elements of the data segments and their relationship to MEDfx data are described below.

For messages sent from MEDfx, the Outbound column under Usage indicates whether a sequence is:

• “M” for mandatory data elements • “O” for optional data elements (i.e. may be reported if available in MEDfx) • “X” for excluded data elements (i.e. data that is never included in an outgoing message)

For messages sent to MEDfx, the Inbound column under Usage indicates whether a sequence is:

• “M” for mandatory data elements • “X” for excluded data elements (i.e. data that is not manipulated or stored by MEDfx)

5.2 AIP Segment The AIP segment is used to exchange appointment personal resource information. An AIP segment is generated for each provider resource associated with the appointment. Below is a sample AIP segment along with a description of the format of the segment. AIP|1||1^SMITH^JOHN^S^MD

Usage

Seq. Element name Inbound Outbound Notes

1 Set id M Segment counter, incremental starting with 1

2 Segment action code X Table 53

3 Personal resource id M Composite of provider primary key and

Page 7 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide

name

4 Resource role X

5 Resource group X

5.3 DG1 Segment The DG1 segment is used to exchange diagnosis information. Below is a sample DG1 segment along with a description of the format of the segment. DG1|1||401.9^HYPERTENSION, NOS

Usage

Seq. Element name Inbound Outbound Notes

1 Set id M

2 Diagnosis coding method M Table 53

3 Diagnosis code Table 51

4 Diagnosis description

5 Diagnosis date/time

6 Diagnosis/DRG type M Table 52

7 Major diagnostic category Table 118

8 Diagnostic related group Table 55

9 DRG approval indicator

10 DRG grouper review code Table 56

11 Outlier type Table 83

12 Outlier days

13 Outlier cost

14 Grouper version and type

15 Diagnosis/DRG priority

16 Diagnosing clinician

17 Diagnosis classification

18 Confidential indicator Table 228

19 Attestation date/time

5.4 EVN Segment The EVN segment is used to exchange event information between sending and receiving applications. Below is a sample ENV segment along with a description of the format of the segment. EVN|A04|200804190917

Usage Seq. Element name Inbound Outbound Notes

1 Event type code M Table 3

2 Date/time of event M CCYYMMDDHHMM

3 Date/time planned event X

4 Event reason code X Table 62

Page 8 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide

5 Operator id X Table 188

6 Event occurred X

5.5 FT1 Segment The FT1 segment is used to exchange financial transaction information. Below is a sample FT1 segment along with a description of the format of the segment. FT1|1|||20080221||CG||||1||||||||||1012^WELBY^MARCUS^J^MD|||||99212^OFFICE VISIT, EST PAT

Usage

Seq. Element name Inbound Outbound Notes

1 Set id

2 Transaction id

3 Transaction batch id

4 Transaction date M Charge date of service

5 Transaction posting date

6 Transaction type X Table 17

7 Transaction code X Table 132

8 Transaction description X

9 Transaction description, alt X

10 Transaction quantity M Charge units

11 Transaction amount extended X

12 Transaction amount unit X

13 Department code X Table 49

14 Insurance plan id X Table 72

15 Insurance amount X

16 Assigned patient location M Service location. Only 4th component of field is used.

17 Fee schedule X Table 24

18 Patient type X Table 18

19 Diagnosis code M Table 51. Only first component of field is used. Repeating field.

20 Performed by code M Rendering provider; Table 84. Only first component of field is used.

21 Ordered by code X

22 Unit cost X

23 Filler order number X

24 Entered by code X

25 Procedure code M Procedure code; Table 88. Only first component of field is used.

26 Procedure code modifier Repeating field

5.6 IN1 Segment The IN1 segment is used to exchange insurance policy information. Below is a sample IN1 segment along with a description of the format of the segment.

Page 9 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide IN1|0|1023^BCBS||BCBS OF RI|PO BOX 99999^^ANYTOWN^RI^02888|||||||||||SMITH^ ANDREW^M|9|19410108|100 MAIN ST^APT 10B^ANYTOWN^RI^02888|||||||||||||||||XXA-12345678901-00|||||||M

Usage

Seq. Element name Inbound Outbound Notes

1 Set id M Segment counter, incremental starting with 0

2 Insurance plan id M Composite of insurance plan primary key (numeric) and mnemonic (code)

3 Insurance company id X

4 Insurance company name M Plan name

5 Insurance company address O Plan address

6 Insurance company contract X

7 Insurance company phone X

8 Group number O Insurance group number

9 Group name O Insurance group name

10 Insured’s group employer id X

11 Insured’s group employer name

X

12 Plan effective date O Insurance effective date

13 Plan expiration date O Insurance expiration date

14 Authorization information X

15 Plan type X Table 86

16 Name of insured M Insurance subscriber name

17 Insured’s relationship to patient

O Table 63

18 Insured’s date of birth O Insurance subscriber birth date

19 Insured’s address O Insurance subscriber address

20 Assignment of benefits X Table 135

21 Coordination of benefits X Table 173

22 Coordination of benefits priority

X

23 Notice of admission flag X

24 Notice of admission date X

25 Report of eligibility flag X

26 Report of eligibility date X

27 Release of information code X Table 93

28 Pre-admission certification X

29 Verification date/time X

30 Verification by X

31 Type of agreement code X Table 98

32 Billing status X Table 22

33 Lifetime reserve days X

34 Delay before L. R. day X

Page 10 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide

35 Company plan code X Table 42

36 Policy number M Insurance subscriber policy number

37 Policy deductible X

38 Policy limit, amount X

39 Policy limit, days X

40 Room rate, semi-private X

41 Room rate, private X

42 Insured’s employment status X Table 66

43 Insured’s sex O Insurance subscriber gender (Table 1)

44 Insured’s employer address X

45 Verification status X

46 Prior insurance plan id X Table 72

47 Coverage type X Table 309

48 Handicap X Table 310

49 Insured’s id number X

5.7 MFE Segment The MFE segment defines the record-level event type for a master file message. Below is a sample MFE segment along with a description of the format of the segment. MFE|MAD

Usage Seq. Element name Inbound Outbound Notes

1 Record level event code M Table 180

2 MFN control id X

3 Effective date/time X

4 Primary key value X

5.8 MFI Segment The MFI segment defines the master file for a master file message. Below is a sample MFI segment along with a description of the format of the segment. MFI|PRA

Usage Seq. Element name Inbound Outbound Notes

1 Master file identifier M Table 175

2 Master file application identifier

X Table 176

3 File level event code X Table 178

4 Entered date/time X

5 Effective date/time X

6 Response level code X Table 179

Page 11 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide 5.9 MSH Segment The MSH segment defines the intent, source, destination, and some specifics of the syntax of a message. Below is a sample MSH segment along with a description of the format of the segment. MSH|^~\@|MEDfx||||200804190917||ADT^A04|GBA0-1AB31|P|2.3||||AL

Usage Seq. Element name Inbound Outbound Notes

1 Field separator M |

2 Encoding characters M ^~\@

3 Sending application M Can be configured per interface instance; Default is “MEDfx”

4 Sending facility O Can be configured per interface instance

5 Receiving application O Can be configured per interface instance

6 Receiving facility O Can be configured per interface instance

7 Date/Time of message M Date/Time message created as YYYYMMDDHHMM

8 Security X

9 Message type M Composite of message type and subtype

10 Message control id M Unique identifier for interface/message

11 Processing id M P

12 Version id M 2.3, Table 104

13 Sequence number X

14 Continuation pointer X

15 Accept acknowledgement type

X Table 155

16 Application acknowledge type M AL

17 Country code X

18 Character set X Table 211

19 Principal language of message

X

5.10 PID Segment The PID segment is used to exchange patient identification information. Below is a sample PID segment along with a description of the format of the segment. PID|0|p12345|p12345||SMITH^ANDREW^M||19410108|M|||100 MAIN ST^APT 10B^ANYTOWN^RI^02888||(401)555-1212|(401)681-2000 X999||M||a12345^ins|999999999

Usage Seq. Element name Inbound Outbound Notes

1 Set id M Segment counter, incremental starting with 0

2 Patient id, external M Patient number

3 Patient id, internal M Patient number

4 Alternate patient id X

5 Patient name M

Page 12 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide

6 Mother’s maiden name X

7 Date of birth M YYYYMMDD

8 Sex M Table 1

9 Patient alias X

10 Race O Table 5

11 Patient address M

12 County code X

13 Phone number, home O

14 Phone number, business O

15 Language, patient O Table 296

16 Marital status O Table 2

17 Religion X Table 6

18 Patient account number O Account number with optional account type component

19 SSN, patient O

20 Driver’s license, patient X

21 Mother’s identifier X

22 Ethnic group O Table 189

23 Birth place X

24 Multiple birth indicator X Table 136

25 Birth order X

26 Citizenship X Table 171

27 Veteran’s military status X Table 172

28 Nationality X

29 Patient death date/time O YYYYMMDD

30 Patient death indicator O Table 136

5.11 PRA Segment The PRA segment is used to exchange practitioner detail information. Below is a sample PRA segment along with a description of the format of the segment. PRA|1012||||11|UPIN^A12345

Usage

Seq. Element name Inbound Outbound Notes

1 Primary key value M Provider primary key (numeric)

2 Practitioner group X

3 Practitioner category X

4 Provider billing X

5 Specialty M Provider specialty code

6 Practitioner id numbers O Provider UPIN

7 Privileges X

Page 13 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide 5.12 PV1 Segment The PV1 segment is used to exchange patient visit information. Below is a sample PV1 segment along with a description of the format of the segment. PV1|1|R|||||WELBY^MARCUS|MENACE^DENNIS||||||||||||||||||||||||||||||||||||20050221

Usage

Seq. Element name Inbound Outbound Notes

1 Set id

2 Patient class X Table 4

3 Assigned patient location Service location. Only last component of field is used.

4 Admission type X

5 Pre-admit number X

6 Prior patient location X

7 Attending doctor Rendering provider. Only the last name and first name components are used.

8 Referring doctor Referring provider. Only the last name and first name components are used.

9 Consulting doctor Supervising provider. Only the last name and first name components are used.

10 Hospital service X

11 Temporary location X

12 Pre-admit test indicator X

13 Re-admission indicator X

14 Admit source X

15 Ambulatory status X

16 VIP indicator X

17 Admitting doctor X

18 Patient type

19 Visit number X

20 Financial class X

21 Charge price indicator X

22 Courtesy code X

23 Credit rating X

24 Contract code X

25 Contract effective date X

26 Contract amount X

27 Contract period X

28 Interest code X

29 Transfer to bad debt code X

30 Transfer to bad debt date X

31 Bad debt agency code X

32 Bad debt transfer amount X

Page 14 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide

33 Bad debt recovery amount X

34 Delete account indicator X

35 Delete account date X

36 Discharge disposition X

37 Discharged to location X

38 Diet type X

39 Servicing facility X

40 Bed status X

41 Account status X

42 Pending location X

43 Prior temporary location X

44 Admit date/time X Visit date of service

45 Discharge date/time X

46 Current patient balance X

47 Total charges X

48 Total adjustments X

49 Total payments X

50 Alternate visit id X

51 Visit indicator X

52 Other healthcare provider X

5.13 RGS Segment The RGS segment is used to exchange resource group information. Below is a sample RGS segment along with a description of the format of the segment. RGS|1

Usage

Seq. Element name Inbound Outbound Notes

1 Set id M Segment counter, incremental starting with 1

5.14 ROL Segment The ROL segment is used to exchange provider information. Below is a sample ROL segment along with a description of the format of the segment. ROL|||RP|1012^WELBY^MARCUS^J

Usage

Seq. Element name Inbound Outbound Notes

1 Role Instance ID X

2 Action Code X

3 Role M Table 287

4 Role Person M Composite of provider primary key and name

5 Role Begin Date/Time X

6 Role End Date/Time X

Page 15 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide

7 Role Duration X

8 Role Action Reason X

5.15 SCH Segment The SCH segment is used to exchange appointment information. Below is a description of the format of the segment. SCH|98765|98765|||||NP^NEW PATIENT||||1^^30^20090109110000||||||||^^^^^^^OFFICE, WARWICK||||||

Usage

Seq. Element name Inbound Outbound Notes

1 Placer appointment id M Appointment primary key

2 Filler appointment id M Appointment primary key

3 Occurrence number X

4 Placer group number X

5 Schedule id X

6 Event reason O Free text appointment note

7 Appointment reason M Composite of appointment reason code and description

8 Appointment type X Table 277

9 Appointment duration X

10 Appointment duration units X

11 Appointment timing quantity M Composite of appointment duration, date and time

12 Placer contact person X

13 Placer contact phone number X

14 Placer contact address X

15 Placer contact location X

16 Filler contact person X

17 Filler contact phone number X

18 Filler contact address X

19 Filler contact location O Appointment location name (SCH-19.9)

20 Entered by person X

21 Entered by phone number X

22 Entered by location X

23 Parent placer appointment id X

24 Parent filler appointment id X

25 Filler status code M When message type is S15 then CANCELLED When message type is S12, S13, S14 or S15 then translation of MEDfx appointment status using Table 278

5.16 STF Segment The STF segment is used to exchange staff identification information. Below is a sample STF segment along with a description of the format of the segment.

Page 16 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide STF|1012||WELBY^MARCUS^J|||||||(401)555-1234|150 LAVAN ST^^WARWICK^RI^02888

Usage

Seq. Element name Inbound Outbound Notes

1 Primary key value M Provider primary key

2 Staff id code X

3 Staff name M Provider name

4 Staff type X Table 182

5 Sex X Table 2

6 Date of birth X

7 Active/Inactive X

8 Department X

9 Service X

10 Phone O Provider work phone

11 Office/Home address O Provider work address

12 Activation date X

13 Inactivation date X

14 Backup person id X

15 E-mail address X

16 Preferred phone X

5.17 ZPL Segment The ZPL segment is used to exchange insurance plan information. Below is a sample ZPL segment along with a description of the format of the segment. ZPL|123| BCBS OF RI|PO BOX 99999^^ANYTOWN^RI^02888

Usage

Seq. Element name Inbound Outbound Notes

1 Primary key value M Plan primary key

2 Plan name M Plan name

3 Plan address O Plan address

6 TABLE MAPPINGS The MEDfx HL7 interface supports the following mapped table values.

6.1 Country Codes Value Description

ALB Albania

DZA Algeria

ASM American Samoa

AND Andorra

AGO Angola

Page 17 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide

AIA Anguilla

ATA Antarctica

ATG Antigua and Barbuda

ARG Argentina

ARM Armenia

ABW Aruba

AUS Australia

AUT Austria

AZE Azerbaijan

BHS Bahamas

BHR Bahrain

BGD Bangladesh

BRB Barbados

BLR Belarus

BEL Belgium

BLZ Belize

BEN Benin

BMU Bermuda

BTN Bhutan

BOL Bolivia

BIH Bosnia and Herzegowina

BWA Botswana

BVT Bouvet Island

BRA Brazil

IOT British Indian Ocean Territory

BRN Brunei Darussalam

BGR Bulgaria

BFA Burkina Faso

BDI Burundi

KHM Cambodia

CMR Cameroon

CAN Canada

CPV Cape Verde

CYM Cayman Islands

CAF Central African Republic

TCD Chad

CHL Chile

CHN China

CXR Christmas Island

CCK Cocos (keeling) Islands

Page 18 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide

COL Colombia

COM Comoros

COG Congo

COK Cook Islands

CRI Costa Rica

CIV Cote d'ivoire

HRV Croatia (local name: Hrvatska)

CUB Cuba

CYP Cyprus

CZE Czech Republic

DNK Denmark

DJI Djibouti

DMA Dominica

DOM Dominican Republic

TMP East Timor

ECU Ecuador

EGY Egypt

SLV El Salvador

GNQ Equatorial Guinea

ERI Eritrea

EST Estonia

ETH Ethiopia

FLK Falkland Islands (malvinas)

FRO Faroe Islands

FJI Fiji

FIN Finland

FRA France

FXX France, Metropolitan

GUF French Guiana

PYF French Polynesia

ATF French Southern Territories

GAB Gabon

GMB Gambia

GEO Georgia

DEU Germany

GHA Ghana

GIB Gibraltar

GRC Greece

GRL Greenland

GRD Grenada

Page 19 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide

GLP Guadeloupe

GUM Guam

GTM Guatemala

GIN Guinea

GNB Guinea-bissau

GUY Guyana

HTI Haiti

HMD Heard and Mc Donald Islands

HND Honduras

HKG Hong Kong

HUN Hungary

ISL Iceland

IND India

IDN Indonesia

IRN Iran

IRQ Iraq

IRL Ireland

ISR Israel

ITA Italy

JAM Jamaica

JPN Japan

JOR Jordan

KAZ Kazakhstan

KEN Kenya

KIR Kiribati

PRK Korea, Democratic People's Republic of

KOR Korea, Republic of

KWT Kuwait

KGZ Kyrgyzstan

LAO Lao People's Democratic Republic

LVA Latvia

LBN Lebanon

LSO Lesotho

LBR Liberia

LBY Libyan Arab Jamahiriya

LIE Liechtenstein

LTU Lithuania

LUX Luxembourg

MAC Macau

MKD Macedonia

Page 20 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide

MDG Madagascar

MWI Malawi

MYS Malaysia

MDV Maldives

MLI Mali

MLT Malta

MHL Marshall Islands

MTQ Martinique

MRT Mauritania

MUS Mauritius

MYT Mayotte

MEX Mexico

FSM Micronesia

MDA Moldova

MCO Monaco

MNG Mongolia

MSR Montserrat

MAR Morocco

MOZ Mozambique

MMR Myanmar

NAM Namibia

NRU Nauru

NPL Nepal

NLD Netherlands

ANT Netherlands Antilles

NCL New Caledonia

NZL New Zealand

NIC Nicaragua

NER Niger

NGA Nigeria

NIU Niue

NFK Norfolk Island

MNP Northern Mariana Islands

NOR Norway

OMN Oman

PAK Pakistan

PLW Palau

PAN Panama

PNG Papua New Guinea

PRY Paraguay

Page 21 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide

PER Peru

PHL Philippines

PCN Pitcairn

POL Poland

PRT Portugal

PRI Puerto Rico

QAT Qatar

REU Reunion

ROU* Romania

RUS Russian Federation

RWA Rwanda

KNA Saint Kitts and Nevis

LCA Saint Lucia

VCT Saint Vincent and the Grenadines

WSM Samoa

SMR San Marino

STP Sao Tome and Principe

SAU Saudi Arabia

SEN Senegal

SYC Seychelles

SLE Sierra Leone

SGP Singapore

SVK Slovakia

SVN Slovenia

SLB Solomon Islands

SOM Somalia

ZAF South Africa

ESP Spain

LKA Sri Lanka

SHN St. Helena

SPM St. Pierre and Miquelon

SDN Sudan

SUR Suriname

SJM Svalbard and Jan Mayen Islands

SWZ Swaziland

SWE Sweden

CHE Switzerland

SYR Syrian Arab Republic

TWN Taiwan

TJK Tajikistan

Page 22 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide

TZA Tanzania

THA Thailand

TGO Togo

TKL Tokelau

TON Tonga

TTO Trinidad and Tobago

TUN Tunisia

TUR Turkey

TKM Turkmenistan

TCA Turks and Caicos Islands

TUV Tuvalu

UGA Uganda

UKR Ukraine

ARE United Arab Emirates

GBR United Kingdom

USA United States

UMI United States minor outlying Islands

URY Uruguay

UZB Uzbekistan

VUT Vanuatu

VAT Vatican City

VEN Venezuela

VNM Viet Nam

VGB Virgin Islands (british)

VIR Virgin Islands (u.s.)

WLF Wallis and Futuna Islands

ESH Western Sahara

YEM Yemen

YUG Yugoslavia

ZAR Zaire

ZMB Zambia

ZWE Zimbabwe

6.2 Death Indicator (see Table 136, Yes/No) 6.3 Ethnic Group Codes (Table 189)

Value Description

H Hispanic N Non-Hispanic U Unknown

6.4 Filler Status Codes (Table 278) Value Description

Page 23 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide

BOOKED Booked CANCELLED Cancelled CHECKED_IN Checked-In MISSED Missed RESCHEDULED Rescheduled SEEN Seen

6.5 Gender Codes (Table 1) Value Description

F Female M Male O Other U Unknown

6.6 Language Codes (Table 296) Value Description

AMERICAN_SIGN_LANGUAGE American Sign Language ARABIC Arabic BURMESE Burmese CREOLIZED_ENGLISH Creolized English ENGLISH English FRENCH French GERMAN German HMONG Hmong OTHER Other PORTUGUESE Portuguese SOMALI Somali SPANISH Spanish

6.7 Marital Status Codes (Table 2) Value Description

D Divorced X Legally separated M Married Other/Unknown S Single W Widowed

6.8 Master File Identification Codes (Table 175) Value Description

ZPL Plan file PRA Provider file

6.9 Race Codes (Table 5) Value Description

2054-5 African-American 1002-5 American Indian or Alaskan Native 2028-9 Asian 2076-8 Native Hawaiian or Pacific Islander 2131-1 Other 2106-3 White

Page 24 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide 6.10 Record Level Event Codes (Table 180)

Value Description

MAD Add record MDL Delete record MUP Update record

6.11 Relationship Codes (Table 63) Value Description

5 Adopted child 22 Cadaver donor 10 Child 24 Child where insured has no financial responsibility 15 Dependent of a minor dependent 20 Emancipated minor 11 Employee 18 Father 6 Foster child 2 Grandfather/Grandmother 3 Grandson/Granddaughter 13 Handicapped dependent 23 Injured plaintiff 25 Life partner 17 Mother 4 Nephew/Niece 21 Organ donor 19 Other adult 26 Other relationship 9 Self 16 Significant other 14 Sponsored dependent 1 Spouse 8 Stepson/Stepdaughter 12 Unknown 7 Ward

6.12 Role Codes (Table 287) Value Description

PP Primary care provider RP Referring provider

6.13 State Codes Value Description

AL Alabama

AK Alaska

AZ Arizona

AR Arkansas

CA California

CZ Canal Zone

CO Colorado

Page 25 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide

CT Connecticut

DE Delaware

DC District Of Columbia

FL Florida

GA Georgia

GU Guam

HI Hawaii

ID Idaho

IL Illinois

IN Indiana

IA Iowa

KS Kansas

KY Kentucky

LA Louisiana

ME Maine

MD Maryland

MA Massachusetts

MI Michigan

MN Minnesota

MS Mississippi

MO Missouri

MT Montana

NE Nebraska

NV Nevada

NH New Hampshire

NJ New Jersey

NM New Mexico

NY New York

NC North Carolina

ND North Dakota

OH Ohio

OK Oklahoma

OR Oregon

PA Pennsylvania

PR Puerto Rico

RI Rhode Island

SC South Carolina

SD South Dakota

TN Tennessee

TX Texas

Page 26 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide

UT Utah

VT Vermont

VA Virginia

WA Washington

WV West Virginia

WI Wisconsin

WY Wyoming

6.14 Suffix Codes Value Description

D.C. Chiropractic D.D.S. Dentistry D.O. Osteopathic D.P.M. Podiatry Esq. Esquire I First generation II Second generation III Third generation Jr. Junior L.I.C.S.W. Licensed Independent Clinical Social Worker L.P.N. Licensed Practical Nurse M.D. Medical Doctor N.D. Naturopathic N.P. Nurse Practitioner O.D. Optometry P.A. Physician’s Assistant Ph.D. Doctor of Philosophy P.T. Physical Therapist R.N. Registered Nurse R.Ph. Registered Pharmacist Sr. Senior

6.15 Yes/No (Table 136) Value Description

Y Yes N No

7 UNSUPPORTED TABLES MEDfx does not store the following tables:

• Education level • Facility • Financial Class • HIPAA Flag • Hospital Service • Patient Class • Patient Type

Page 27 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published

DOC ID: 30-1310-007 Companion Guide

• Religion • Restricted Access (VIP) • Veteran Status

Page 28 of 28 Proprietary and Confidential Copyright ©2013 MEDfx Corporation

All Rights Reserved Published