Patient Demographic Synchronization Patient Appointment Schedules Synchronization Patient Context August 24, 2010
Table of Contents SLUTIN VERVIEW...3 VERVIEW...3 PATIENT DEMGRAPHICS SYNCHRNIZATIN...3 PATIENT APPINTMENT SCHEDULES SYNCHRNIZATIN...3 PATIENT CNTEXT...3 PATIENT DEMGRAPHICS SYNCHRNIZATIN VERVIEW...4 PATIENT APPINTMENT SCHEDULE SYNCHRNIZATIN VERVIEW...6 CNNECTIVITY PTINS AND REQUIREMENTS...8 CNNECTIVITY PTINS...8 CNNECTIVITY REQUIREMENTS...8 Secure HTTP (HTTP/SSL) over Internet...8 Mailbox...8 Persistent...8 HTTP over IPSec VPN...8 Mailbox...8 Persistent...9 Secure FTP (FTP/SSL) over Internet...9 FTP over IPSec VPN...9 Lower Layer Protocol (LLP) over IPSec VPN...9 AS2 Connector...10 WebSphere MQ...10 Covisint Scout...10 PATIENT DEMGRAPHICS MESSAGING PTINS AND REQUIREMENTS...11 MESSAGE VERSIN...11 HL7 ADT STANDARD...11 ADT Events...11 HL7 ADT^A01 Message Structure v2.3...11 Supported ADT Segments...12 Supported Acknowledgements...12 PATIENT DEMGRAPHICS ADT SEGMENTS/FIELDS...13 SAMPLE HL7 ADT V2.3...25 PATIENT APPINTMENT SCHEDULE MESSAGING PTINS AND REQUIREMENTS...26 MESSAGE VERSIN...26 HL7 SIU STANDARD...26 SIU Events...26 HL7 SIU^S12 Message Structure v2.3...26 Supported SIU Segments...27 Page Page 11
Supported Acknowledgements...27 PATIENT APPINTMENT SCHEDULE SIU SEGMENTS/FIELDS...28 SAMPLE HL7 SIU V2.3...37 TRANSMISSIN LEVEL HL7 ACK/NACK SEGMENTS/FIELDS...38 ERRR CDES AND MESSAGES...39 PATIENT CNTEXT...40 Page Page 22
Solution verview verview The purpose of this document is to describe the scope of the Covisint Patient Sync solution which is used to push patient demographics and patient appointment schedules, which are initiated in a PMS system, to an Application Provider. And to describe the Patient Context solution which is used to provide the Application Provider with a Patient Identifier when a user federates to an application. Patient Demographics Synchronization nce the initial load of patient records for a practice is completed, the PMS systems will send real-time Add and Update HL7 ADT messages to Covisint. The patient synchronization solution allows PMS systems to send patient demographic messages on behalf of physician practices to Covisint, which will then be forwarded on to any application for which the physician is signed up. Patient Appointment Schedules Synchronization PMS systems will send real-time HL7 SIU messages to Covisint. The patient synchronization solution allows PMS systems to send Appointment Schedule data on behalf of physician practices to Covisint, which will then be forwarded on to any application through received HL7 Schedule Information Unsolicited (SIU) transactions. Patient Context Patient Context is a federation extension that is used to send a Patient Identifier to an Application Provider when a user federates to an Application Provider s application. nce the application has the Patient Identifier, it can then be used to retrieve a specific patient record that was obtained using Patient Synch Page Page 33
Patient Demographics Synchronization verview Covisint Environment Start Create/Update Patient 1 Practice PMS HL7 ADT Demographic Message w/patient_ Views Patient In Patient Search Portlet on Sponsor s portal HL7 ACK 6 2 Messaging Hub 3 Route w/trading Partner and format requirements Sponsor s Portal 4 5 Lookup Destination and Format 6 Add/Update Patient Mapping, Translation, And Routing Trading Partner Profiles Patient Sync Database User 7 HL7 ADT w/ Trading Partner And Patient Ack/Nack 8 Application Provider Environment Views Patient Record In Application Provider s Application HL7 Messaging Engine 11 9 Practice 10 Lookup w/ Trading Partner Add/Update Patient Practice Crosswalk Finish Target Application Practice Datastore Figure 1: Patient Demographics Synchronization Process Page Page 44
1. Practice Management System: (PMS) Sends Demographic Message When the user adds or updates patient demographic information in the PMS system, a real-time HL7 ADT message is sent to the Covisint Messaging Hub. 2. Covisint Returns HL7 Transmission Level ACK Message Upon receipt, Covisint returns an acknowledgement message back to the PMS system. 3. Trading Partner Profile Lookup Covisint retrieves trading partner information (e.g., routing rules, transformation requirements). 4. Message Routed by Trading Partner Covisint routes the message to the trading partner that uniquely identifies the source practice. 5. Patient Synchronization Database Add/Update Covisint stores patient demographic and appointments information discretely by practice domain. 6. User Views Patient in Sponsor s Portal Portlet Users can access patient demographic information, from the message via the Sponsor s portal (e.g., Patient Search portlet, Patient Synchronization Status portlet). 7. Covisint Sends Demographic Message to Application Provider An HL7 ADT message is sent to the Application Provider per the Application Provider s mapping requirements 8. Application Provider Returns ACK Application Provider returns acknowledgement to Covisint. 9. Application Provider Trading Partner Crosswalk Application Provider performs trading partner crosswalk to their internal practice. 10. Application Provider Add/Update Application Provider adds/updates the patient information in their application. 11. User Views Patient Record in Application Provider s Application When the user accesses the Application Provider s application, the patient record has been pre-populated, or updated. No user action is required to create/update the patient record in the application. Page Page 55
Patient Appointment Schedule Synchronization verview Figure 2: Patient Appointment Schedule Synchronization Process Page Page 66
1. Practice Management System: (PMS) Sends Appointment Schedule Message When the user adds or updates appointment schedule information in the PMS system, a real-time HL7 SIU message is sent to the Covisint Messaging Hub. 2. Covisint Returns HL7 Transmission Level ACK Message Upon receipt, Covisint returns an acknowledgement message back to the PMS system. 3. Trading Partner Profile Lookup Covisint retrieves trading partner information (e.g., routing rules, transformation requirements). 4. Message Routed by Trading Partner Covisint routes the message to the trading partner that uniquely identifies the source practice. 5. Patient Synchronization Database Add/Update Covisint stores appointment schedules discretely by practice domain. 6. User Views Appointment Schedule in Sponsor s Portal Portlet Users can access appointment schedule, from the Sponsor s portal. 7. Covisint Sends Appointment Schedule Message to Application Provider An HL7 SIU message is sent to the Application Provider per the Application Provider s mapping requirements 8. Application Provider Returns ACK Application Provider returns acknowledgement to Covisint. 9. Application Provider Trading Partner Crosswalk Application Provider performs trading partner crosswalk to their internal practice. 10. Application Provider Add/Update Application Provider adds/updates the appointment schedule in their application. 11. User Views Appointment Schedule in Application Provider s Application When the user accesses the Application Provider s application, the appointment schedule has been pre-populated, or updated. No user action is required to create/update the appointment schedule in the application. Page Page 77
Connectivity ptions and Requirements Connectivity ptions Secure HTTP (HTTP/SSL) over Internet HTTP over IPSec VPN Secure FTP (FTP/SSL) over Internet FTP over IPSec VPN LLP over IPSec VPN AS2 Connector WebSphere MQ Covisint Scout (Installable agent) Connectivity Requirements The following describes solutions for setting up connectivity with Covisint Connect. Page Page 88 Secure HTTP (HTTP/SSL) over Internet Mailbox Connect to the Covisint messaging hub using unidirectional TCP/IP link over the public Internet. Application Provider sends (PST) and retrieves (GET) from Covisint mailbox No network setup required. Production URL: i. https://messaging.covisint.com/invoke/httpconnector.mailbox/post ii. https://messaging.covisint.com/invoke/httpconnector.mailbox/get Staging (test) URL: iii. https://messaging2.stg.covisint.com/invoke/httpconnector.mailbox/post iv. https://messaging2.stg.covisint.com/invoke/httpconnector.mailbox/get Covisint perations will provide username/password for both test and production. Persistent Connect to Covisint using a TCP/IP link over the public Internet. Covisint sends (PST) to Application Provider. Firewall must be opened for the IP/URL on port 443 that the customer provides. Production URL: i. https://messaging.covisint.com Staging (test) URL: ii. https://messaging2.stg.covisint.com Covisint perations will provide username/password for both test and production. HTTP over IPSec VPN Mailbox Connect to the Covisint messaging hub using unidirectional TCP/IP link over a VPN tunnel. Application Provider sends (PST) and retrieves (GET) from Covisint mailbox No network setup required. Production URL: v. https://messaging.covisint.com/invoke/httpconnector.mailbox/post
vi. https://messaging.covisint.com/invoke/httpconnector.mailbox/get Staging (test) URL: vii. https://messaging2.stg.covisint.com/invoke/httpconnector.mailbox/post viii. https://messaging2.stg.covisint.com/invoke/httpconnector.mailbox/get Covisint perations will provide username/password for both test and production. Persistent Connect to Covisint using a TCP/IP link over a VPN tunnel. Covisint sends (PST) to Application Provider. Firewall must be opened for the IP/URL on port 443 that the customer provides. Production URL: iii. https://messaging.covisint.com Staging (test) URL: iv. https://messaging2.stg.covisint.com Covisint perations will provide username/password for both test and production. Secure FTP (FTP/SSL) over Internet To use the FTP Connector, you should have prior knowledge of FTP commands and how to use them Connect to Covisint messaging hub using standard FTP client software and TCP/IP communications. Network setup required (open firewall for specific IP and port). Available in two methods i. Mailbox (push-pull) Application Provider sends (PUT) and retrieves (GET) from Covisint mailbox. ii. Persistent (push) - Covisint sends (PST) to Application Provider. Pre-Prod IP address: i. 64.14.228.122 ii. Ports 21, 990 and range 20900 through 20999 Production IP address: i. 64.37.249.13 ii. Ports 21, 990 and range 20900 through 20999 Covisint perations will provide username/password for both test and production. FTP over IPSec VPN To use the FTP Connector, you should have prior knowledge of FTP commands and how to use them. Connect to Covisint messaging hub using standard FTP client software and TCP/IP communications over a VPN tunnel. Available in two methods: i. Mailbox (push-pull) Application Provider sends (PUT) and retrieves (GET) from Covisint mailbox. ii. Persistent (push) - Covisint sends (PST) to Application Provider. Public Internet IP Addresses for messaging i. Production: 64.37.249.63 ii. Staging: 64.14.228.160 Firewall access required. Lower Layer Protocol (LLP) over IPSec VPN Standard for transmitting HL7 messages via TCP/IP Network setup required (open firewall for specific IP and port) and VPN i. Provide IPSec VPN Tunnel application to Network team Page Page 99
ii. iii. Network team will provide port number to use specific to the IP address Persistent connections: Request network team to permit persistent connection for the IP address. Network team will need to configure the IP address on the load balancer and firewall to allow this. therwise, Covisint default behavior is to close idle connections after one hour. Application Provider sends to Covisint with sync ack. Covisint sends to Application Provider with sync ack, if applicable. AS2 Connector Transmits HL7 messages as MIME/SMIME messages. Encryption and digital signature are both optional. Following are the modes for sending a message: i. Signed only ii. iii. Encrypted only No signature, No encryption The messages are sent in a MIME message. This option is not recommended for secure transmission using AS2 protocol. NTE: Signed and encrypted recommended Message Disposition Notification (MDN): The MDN is an acknowledgement receipt sent by the receiver that indicates a secure and successful receipt of the message. Firewall must be opened for the outbound channel IP/URL that the customer provides. Inbound access is already permitted. Inbound URLs v. Production: https://messaging.covisint.com/invoke/as2connector.inbound/receive vi. Test: https://messaging2.stg.covisint.com/invoke/as2connector.inbound/receive AS2 Certificate Required. Covisint operations will provide username/password for both test and production. WebSphere MQ WebSphere MQ is a popular system for messaging across multiple platforms, including Windows, Linux, IBM mainframe and midrange, and Unix. There are two parts to message queuing: i. Messages are collections of binary or character (for instance ASCII or EBCDIC) data that have some meaning to a participating program. As in other communications protocols, storage, routing, and delivery information is added to the message before transmission and stripped from the message prior to delivery to the receiving application. ii. Message queues are objects that store messages in an application. Production i. mq.covisint.com ii. Internet IP: 64.37.249.29: 1414, 443 Test i. mq2.stg.covisint.com ii. Internet IP: 64.14.228.140 Port 1414 Firewall access required. Covisint Scout Scout is a lightweight secure software agent that will be installed on your local machine and configured by Covisint. Makes integration simple and fast with a proven solution. Additional information is located at: https://portal.covisint.com/web/supportscout Page Page 10 10
Patient Demographics Messaging ptions and Requirements Message Version HL7 v2.3 HL7 ADT Standard ADT Events ADT^A01 - Admit/visit notification ADT^A04 - Register a patient ADT^A08 - Update patient information ADT^A28 - Add person information ADT^A31 - Update person information NTE: The events listed above all use the ADT^A01 message structure. HL7 ADT^A01 Message Structure v2.3 Segment PT/REQ Iteration Response Grammar: Group Control Comment MSH R 1:1 Message Header EVN R 1:1 Event Type R 1:1 PATIENT P R 1:1 Patient Identification [ PD1 ] 0:1 Additional Demographics Where [ ] shows segment is optional [ { NK1 } ] 0:S Next to Kin Information Where { } shows multiple iteration R 1:1 PATIENT_VISIT PV1 R 1:1 Patient Visit [ PV2 ] 0:1 Patient Visit Additional Info. Not used for processing [ { DB1 } ] 0:S Disability Information Not used for processing [ { BX } ] 0:S bservation/result Not used for processing [ { AL1 } ] 0:S Allergy Information Not used for processing [ { DG1 } ] 0:S Diagnosis Information Not used for processing [ DRG ] 0:1 Diagnosis Related Group Not used for processing [ { 0:S PRCEDURE PR1 R 1:1 Procedures Not used for processing [{RL}] 0:S Role Not used for processing } ] Not used for processing [ { GT1 } ] 0:S Guarantor [ { 0:S INSURANCE IN1 R 1:1 Insurance [ IN2 ] 0:1 Insurance Additional Info Not used for processing Page Page 11 11
[ IN3 ] 0:1 Insurance Add'l Info - Cert Not used for processing } ] Not used for processing [ ACC ] 0:1 Accident Information Not used for processing [ UB1 ] 0:1 Universal Bill Information Not used for processing [ UB2 ] 0:1 Universal Bill 92 Information Not used for processing Supported ADT Segments MSH, EVN, P, PD1, NK1, PV1, PV2, DB1, BX, AL1, DG1, DRG, PR1, RL, GT1, IN1, IN2, IN3, ACC, UB1, UB2 Supported Acknowledgements Ack_General, riginal Mode Page Page 12 12
Patient Demographics ADT Segments/Fields Covisint Standard External Interface HL7 v2.3 Ref Segment Length Table 1 Segment MSH Message Header R N Page Page 13 13 External Interface r/o/c/b Rep# Description Item Section Data Structure 2 MSH.1 1 R Field Separator 1 2.24.1.1 ST 3 MSH.2 4 R Encoding Characters 2 2.24.1.2 ST ^~\& 4 MSH.3 180 Sending Application 3 2.24.1.3 HD 5 MSH.4 180 Sending Facility 4 2.24.1.4 HD 6 MSH.5 180 Receiving Application 5 2.24.1.5 HD 7 MSH.6 180 C Receiving Facility 6 2.24.1.6 HD 8 MSH.7 26 R Date / Time of Message 7 2.24.1.7 TS 9 MSH.8 40 Security 8 2.24.1.8 ST 10 MSH.9 7 R Message Type 9 2.24.1.9 CM_MSG Required Value Formatted as YYYYMMDDHHMMSS 11 MSH.9.1 76 R 'ADT' 'A01', 'A04', 'A08', 'A28', 12 MSH.9.2 3 R or,'a31' 13 MSH.10 20 R Message Control 10 2.24.1.10 ST 14 MSH.11 3 R Processing 11 2.24.1.11 PT 'P' 15 MSH.12 8 104 R Version 12 2.24.1.12 '2.3' 16 MSH.13 15 Sequence Number 13 2.24.1.13 NM 17 MSH.14 180 Continuation Pointer 14 2.24.1.14 ST 18 MSH.15 2 155 Accept Acknowledgement Type 15 2.24.1.15 19 MSH.16 2 155 Application Acknowledgement Type 16 2.24.1.16 20 MSH.17 2 Country Code 17 2.24.1.17 21 MSH.18 6 211 Y Character Set 692 2.24.1.18 Principal Language of 22 MSH.19 60 Message 693 2.24.1.19 CE Segment EVN 23 Event Type R N 24 EVN.1 3 3 R Event Type Code 99 3.3.1.1 25 EVN.2 26 R Recorded Date/Time 100 3.3.1.2 TS 26 EVN.3 26 Date/Time Planned Event 101 3.3.1.3 TS 27 EVN.4 3 62 Event Reason Code 102 3.3.1.4 28 EVN.5 60 188 perator 103 3.3.1.5 CN 29 EVN.6 26 N Event occurred 1278 3.3.1.6 TS 30 Segment P Patient Identification R N
31 P.1 4 Set - Patient 104 3.3.2.1 SI 32 P.2 20 Patient (External ) 105 3.3.2.2 CX 33 P.3 20 R Y Patient (Internal ) 106 3.3.2.3 CX 34 P.3.1 R (ST) ST 35 P.3.2 check digit ST code identifying the check 36 P.3.3 61 digit scheme employed 37 P.3.4 assigning authority HD 38 P.3.4.1 namespace IS 39 P.3.4.2 universal ST 40 P.3.4.3 universal type 41 P.3.8 identifier type code IS 42 P.3.9 assigning facility HD 43 P.3.9.1 namespace IS 44 P.3.9.2 universal ST 45 P.3.9.3 universal type 46 P.4 20 Y Alternate Patient 107 3.3.2.4 CX 47 P.5 48 R Y Patient Name 108 3.3.2.5 XPN 48 P.5.1 R family name ST 49 P.5.2 R given name ST 50 P.5.3 middle initial or name ST 51 P.5.4 suffix (e.g., JR or III) ST 52 P.5.5 prefix (e.g., DR) ST 53 P.5.6 degree (e.g., MD) ST 54 P.5.7 200 name type code 55 P.6 48 Mother's Maiden Name 109 3.3.2.6 XPN 56 P.7 26 C Date of Birth 110 3.3.2.7 TS 57 P.8 1 1 C Sex 111 3.3.2.8 IS 58 P.9 48 Y Patient Alias 112 3.3.2.9 XPN 59 P.10 1 5 Race 113 3.3.2.10 IS 60 P.11 106 Y Patient Address 114 3.3.2.11 XAD 61 P.11.1 street address ST 62 P.11.2 other designation ST 63 P.11.3 City ST 64 P.11.4 state or province ST 65 P.11.5 C zip or postal code ST 66 P.11.6 Country 67 P.11.7 190 address type other geographic 68 P.11.8 designation ST First Instance of the P.3.1 will be the Noneditable Unique Patient from the source PMS system Page Page 14 14
69 P.11.9 county/parish code IS 70 P.11.10 census tract IS 71 P.12 4 County Code 115 3.3.2.12 IS 72 P.13 40 Y Phone Number - Home 116 3.3.2.13 TN Phone Number - 73 P.14 40 Y Business 117 3.3.2.14 TN 74 P.15 60 296 Primary Language 118 3.3.2.15 CE 75 P.16 1 2 Marital Status 119 3.3.2.16 IS 76 P.17 3 6 Religion 120 3.3.2.17 IS 77 P.18 20 Patient Account Number 121 3.3.2.18 CX 78 P.19 16 SSN Number - Patient 122 3.3.2.19 ST 79 P.20 25 Driver's License Number 123 3.3.2.20 DLN 80 P.21 20 Y Mother's Identifier 124 3.3.2.21 CX 81 P.22 3 189 Ethnic Group 125 3.3.2.22 IS 82 P.23 60 Birth Place 126 3.3.2.23 ST 83 P.24 2 136 Multiple Birth Indicator 127 3.3.2.24 84 P.25 2 Birth rder 128 3.3.2.25 NM 85 P.26 4 171 Citizenship 129 3.3.2.26 IS 86 P.27 60 172 Veterans Military Status 130 3.3.2.27 CE 87 P.28 80 212 Nationality Code 739 3.3.2.28 CE Patient Death Date and 88 P.29 26 Time 740 3.3.2.29 TS 89 P.30 1 136 Patient Death Indicator 741 3.3.2.30 Segment PD1 Formatted as (999)999-9999 Formatted as (999)999-9999 Formatted as 999-99- 9999 or 999999999 90 Patient Demographic Information Y 91 PD1.1 2 223 Y Living Dependency 755 3.3.9.1 IS 92 PD1.2 2 220 Living Arrangement 742 3.3.9.2 IS 93 PD1.3 90 Y Patient Primary Facility 756 3.3.9.3 XN 94 PD1.3.1 organization name ST organization name type 95 PD1.3.2 204 code 96 PD1.3.3 number (NM) 97 PD1.3.4 check digit NM 98 PD1.3.5 61 code identifying the check digit scheme employed 99 PD1.3.6 assigning authority HD 100 PD1.3.7 203 identifier type code 101 PD1.3.8 assigning facility HD Patient Primary Care 102 PD1.4 90 C Y Provider Name & No. 757 3.3.9.4 XCN 103 PD1.4.1 number (ST) ST 104 PD1.4.2 family name ST Page Page 15 15
105 PD1.4.3 given name ST 106 PD1.4.4 middle initial or name ST 107 PD1.4.5 suffix (e.g., JR or III) ST 108 PD1.4.6 prefix (e.g., DR) ST 109 PD1.4.7 degree (e.g., MD) ST 110 PD1.4.8 297 source table IS 111 PD1.4.9 assigning authority HD 112 PD1.4.10 200 name type 113 PD1.4.11 identifier check digit ST 114 PD1.4.12 61 code identifying the check digit scheme employed 115 PD1.4.13 203 identifier type code IS 116 PD1.4.14 assigning facility HD 117 PD1.5 2 231 Student Indicator 745 3.3.9.5 IS 118 PD1.6 2 310 Handicap 753 3.3.9.6 IS 119 PD1.7 2 315 Living Will 759 3.3.9.7 IS 120 PD1.8 2 316 rgan Donor 760 3.3.9.8 IS 121 PD1.9 2 136 Separate Bill 761 3.3.9.9 122 PD1.10 2 Y Duplicate Patient 762 3.3.9.10 CX 123 PD1.10.1 ST 124 PD1.10.2 check digit ST 125 PD1.10.3 61 code identifying the check digit scheme employed 126 PD1.10.4 assigning authority HD 127 PD1.10.5 203 identifier type code IS 128 PD1.10.6 assigning facility HD 129 PD1.11 1 125 Publicity Indicator 743 3.3.9.11 CE 130 PD1.12 1 136 Y Protection Indicator 1283 Segment NK1 131 Next of Kin Y 132 NK1.1 4 R Set - NK1 190 3.3.5.1 SI 133 NK1.2 48 C Y Name 191 3.3.5.2 XPN 134 NK1.2.1 family name ST 135 NK1.2.2 given name ST 136 NK1.2.3 middle initial or name ST 137 NK1.2.4 suffix (e.g., JR or III) ST 138 NK1.2.5 prefix (e.g., DR) ST 139 NK1.2.6 degree (e.g., MD) ST 140 NK1.2.7 200 name type code Name Representation 141 NK1.2.8 4000 code 142 NK1.3 60 63 Relationship 192 3.3.5.3 CE Page Page 16 16
143 NK1.3.1 63 identifier 144 NK1.3.2 text ST 145 NK1.3.3 name of coding system ST 146 NK1.3.4 alternate identifier 147 NK1.3.5 alternate text ST name of alternate coding 148 NK1.3.6 system ST 149 NK1.4 106 Y Address 193 3.3.5.4 XAD 150 NK1.4.1 street address ST 151 NK1.4.2 other designation ST 152 NK1.4.3 city ST 153 NK1.4.4 state or province ST 154 NK1.4.5 zip or postal code ST 155 NK1.4.6 country 156 NK1.4.7 190 address type other geographic 157 NK1.4.8 designation ST 158 NK1.4.9 county/parish code IS 159 NK1.4.10 census tract IS 160 NK1.5 40 Y Phone Number 194 3.3.5.5 XTN 161 NK1.5.1 telecommunication number TN telecommunication use 162 NK1.5.2 201 code telecommunication 163 NK1.5.3 202 equipment type () 164 NK1.5.4 Email address ST 165 NK1.5.5 Country Code NM 166 NK1.5.6 Area/city code NM 167 NK1.5.7 Phone number NM 168 NK1.5.8 Extension NM 169 NK1.5.9 any text ST 170 NK1.6 40 Y Business Phone Number 195 3.3.5.6 XTN 171 NK1.6.1 telecommunication number TN telecommunication use 172 NK1.6.2 201 code telecommunication 173 NK1.6.3 202 equipment type () 174 NK1.6.4 Email address ST 175 NK1.6.5 Country Code NM 176 NK1.6.6 Area/city code NM 177 NK1.6.7 Phone number NM 178 NK1.6.8 Extension NM 179 NK1.6.9 any text ST 180 NK1.7 60 131 Contact Role 196 3.3.5.7 CE 181 NK1.8 8 Start Date 197 3.3.5.8 DT Formatted as (999)999-9999 Formatted as (999)999-9999 Page Page 17 17
182 NK1.9 8 183 NK1.10 60 184 NK1.11 20 185 NK1.12 20 Page Page 18 18 End Date 198 3.3.5.9 DT Next of Kin / Associated Parties Job Title 199 3.3.5.10 ST Next of Kin / Associated Parties Job Code/Class 200 3.3.5.11 JCC Next of Kin / Associated Parties Employee Number 201 3.3.5.12 CX 186 NK1.12.1 ST 187 NK1.12.2 check digit ST 188 NK1.12.3 61 code identifying the check digit scheme employed 189 NK1.12.4 assigning authority HD 190 NK1.12.5 203 identifier type code IS 191 NK1.12.6 assigning facility HD 192 NK1.13 60 Y rganization Name 202 3.3.5.13 XN 193 NK1.13.1 organization name ST organization name type 194 NK1.13.2 204 code IS 195 NK1.13.3 number (NM) NM 196 NK1.13.4 check digit ST 197 NK1.13.5 61 code identifying the check digit scheme employed 198 NK1.13.6 assigning authority HD 199 NK1.13.7 203 identifier type code IS 200 NK1.13.8 assigning facility HD 201 NK1.14 2 2 Marital Status 119 3.3.5.14 IS 202 NK1.15 1 1 Sex 111 3.3.5.15 IS 203 NK1.16 26 Date/Time of Birth 110 3.3.5.16 TS 204 NK1.16.1 time of an event ST 205 NK1.16.2 degree of precision ST 206 NK1.17 2 223 Y Living Dependency 755 3.3.5.17 IS 207 NK1.18 2 9 Y Ambulatory Status 145 3.3.5.18 IS 208 NK1.19 4 171 Y Citizenship 129 3.3.5.19 IS 209 NK1.20 60 296 Primary Language 118 3.3.5.20 CE 210 NK1.20.1 identifier 211 NK1.20.2 text ST 212 NK1.20.3 name of coding system ST 213 NK1.20.4 alternate identifier 214 NK1.20.5 alternate text ST 215 NK1.20.6 name of alternate coding system ST 216 NK1.21 2 220 Living Arrangement 742 3.3.5.21 IS 217 NK1.22 1 215 Publicity Indicator 743 3.3.5.22 CE 218 NK1.23 1 136 Protection Indicator 744 3.3.5.23 219 NK1.24 2 231 Student Indicator 745 3.3.5.24 IS
220 NK1.25 3 6 221 NK1.26 48 Religion 120 3.3.5.25 IS Mother's Maiden Name 746 3.3.5.26 XPN 222 NK1.26.1 family name ST 223 NK1.26.2 given name ST 224 NK1.26.3 middle initial or name ST 225 NK1.26.4 suffix (e.g., JR or III) ST 226 NK1.26.5 prefix (e.g., DR) ST 227 NK1.26.6 degree (e.g., MD) ST 228 NK1.26.7 200 name type code Name Representation 229 NK1.26.8 4000 code 230 NK1.27 80 212 Nationality 739 3.3.5.27 CE 231 NK1.27.1 identifier 232 NK1.27.2 text ST 233 NK1.27.3 name of coding system ST 234 NK1.27.4 alternate identifier 235 NK1.27.5 alternate text ST 236 NK1.27.6 name of alternate coding system ST 237 NK1.28 3 189 Ethnic Group 125 3.3.5.28 IS 238 NK1.29 80 222 Y Contact Reason 747 3.3.5.29 CE 239 NK1.29.1 identifier 240 NK1.29.2 text ST 241 NK1.29.3 name of coding system ST 242 NK1.29.4 alternate identifier 243 NK1.29.5 alternate text ST name of alternate coding 244 NK1.29.6 system ST 245 NK1.30 48 Y Contact Person's Name 748 3.3.5.30 XPN 246 NK1.30.1 family name ST 247 NK1.30.2 given name ST 248 NK1.30.3 middle initial or name ST 249 NK1.30.4 suffix (e.g., JR or III) ST 250 NK1.30.5 prefix (e.g., DR) ST 251 NK1.30.6 degree (e.g., MD) ST 252 NK1.30.7 200 name type code 253 NK1.30.8 4000 Name Representation code Contact Person's 254 NK1.31 40 Y Telephone Number 749 3.3.5.31 XTN 255 NK1.31.1 telecommunication number TN telecommunication use 256 NK1.31.2 201 code telecommunication 257 NK1.31.3 202 equipment type () 258 NK1.31.4 Email address ST Formatted as (999)999-9999 Page Page 19 19
259 NK1.31.5 Country Code NM 260 NK1.31.6 Area/city code NM 261 NK1.31.7 Phone number NM 262 NK1.31.8 Extension NM 263 NK1.31.9 any text ST 264 NK1.32 106 Y Contact Person's Address 750 3.3.5.32 XAD 265 NK1.32.1 street address ST 266 NK1.32.2 other designation ST 267 NK1.32.3 city ST 268 NK1.32.4 state or province ST 269 NK1.32.5 zip or postal code ST 270 NK1.32.6 country 271 NK1.32.7 190 address type other geographic 272 NK1.32.8 designation ST 273 NK1.32.9 county/parish code IS 274 NK1.32.10 census tract IS Next of Kin/Associated 275 NK1.33 32 Y Party's Identifiers 751 3.3.5.33 CX 276 NK1.33.1 ST 277 NK1.33.2 check digit ST 278 NK1.33.3 61 code identifying the check digit scheme employed 279 NK1.33.4 assigning authority HD 280 NK1.33.5 203 identifier type code IS 281 NK1.33.6 assigning facility HD 282 NK1.34 2 311 Job Status 752 3.3.5.34 IS 283 NK1.35 1 5 Race 113 3.3.5.35 IS 284 NK1.36 2 295 Handicap 753 3.3.5.36 IS 285 NK1.37 16 Contact Person Social Security Number 754 3.3.5.37 ST Segment PV1 286 Patient Visit R N 287 PV1.1 4 Set - Patient Visit 131 3.3.3.1 SI 288 PV1.2 1 4 R Patient Class 132 3.3.3.2 289 PV1.3 80 Assigned Patient Location 133 3.3.3.3 PL 290 PV1.4 2 7 Admission Type 134 3.3.3.4 291 PV1.5 20 Preadmit Number 135 3.3.3.5 CX 292 PV1.6 80 Prior Patient Location 136 3.3.3.6 PL 293 PV1.7 60 10 Y Attending Doctor 137 3.3.3.7 XCN Formatted as 999-99- 9999 or 999999999 E - Emergency I - Inpatient - utpatient P - Preadmit R - Recurring Patient B - bstetrics Page Page 20 20
294 PV1.8 60 10 Y Referring Doctor 138 3.3.3.8 XCN 295 PV1.9 60 10 Y Consulting Doctor 139 3.3.3.9 XCN 296 PV1.10 3 69 Hospital Service 140 3.3.3.10 297 PV1.11 80 Temporary Location 141 3.3.3.11 PL 298 PV1.12 2 87 Preadmit Test Indicator 142 3.3.3.12 299 PV1.13 2 92 Readmission Indicator 143 3.3.3.13 300 PV1.14 3 23 Admit Source 144 3.3.3.14 301 PV1.15 2 9 Y Ambulatory Status 145 3.3.3.15 IS 302 PV1.16 2 99 VIP Indicator 146 3.3.3.16 303 PV1.17 60 10 Y Admitting Doctor 147 3.3.3.17 XCN 304 PV1.18 2 18 Patient Type 148 3.3.3.18 305 PV1.19 20 Visit Number 149 3.3.3.19 CX 306 PV1.20 50 64 Y Financial Class 150 3.3.3.20 FC 307 PV1.21 2 32 Charge Price Indicator 151 3.3.3.21 308 PV1.22 2 45 Courtesy Code 152 3.3.3.22 309 PV1.23 2 46 Credit Rating 153 3.3.3.23 310 PV1.24 2 44 Y Contract Code 154 3.3.3.24 311 PV1.25 8 Y Contract Effective Date 155 3.3.3.25 DT 312 PV1.26 12 Y Contract Amount 156 3.3.3.26 NM 313 PV1.27 3 Y Contract Period 157 3.3.3.27 NM 314 PV1.28 2 73 Interest Code 158 3.3.3.28 315 PV1.29 1 110 Transfer to Bad Debt Code 159 3.3.3.29 316 PV1.30 8 Transfer to Bad Debt Date 160 3.3.3.30 DT 317 PV1.31 10 21 Bad Debt Agency Code 161 3.3.3.31 318 PV1.32 12 Bad Debt Transfer Amount 162 3.3.3.32 NM 319 PV1.33 12 Bad Debt Recovery Amount 163 3.3.3.33 NM 320 PV1.34 1 111 Delete Account Indicator 164 3.3.3.34 321 PV1.35 8 Delete Account Date 165 3.3.3.35 DT 322 PV1.36 3 112 Discharge Disposition 166 3.3.3.36 323 PV1.37 25 113 Discharged to Location 167 3.3.3.37 CM_DLD 324 PV1.38 2 114 Diet Type 168 3.3.3.38 325 PV1.39 2 115 Servicing Facility 169 3.3.3.39 326 PV1.40 1 116 Bed Status 170 3.3.3.40 IS 327 PV1.41 2 117 Account Status 171 3.3.3.41 328 PV1.42 80 Pending Location 172 3.3.3.42 PL 329 PV1.43 80 Prior Temporary Location 173 3.3.3.43 PL 330 PV1.44 26 Admit Date/Time 174 3.3.3.44 TS 331 PV1.45 26 Discharge Date/Time 175 3.3.3.45 TS 332 PV1.46 12 Current Patient Balance 176 3.3.3.46 NM 333 PV1.47 12 Total Charges 177 3.3.3.47 NM 334 PV1.48 12 Total Adjustments 178 3.3.3.48 NM Page Page 21 21
335 PV1.49 12 Total Payments 179 3.3.3.49 NM 336 PV1.50 20 192 Alternate Visit 180 3.3.3.50 CX 337 PV1.51 1 326 Visit Indicator 1226 3.3.3.51 IS 338 PV1.52 60 10 Y ther Healthcare Provider 1274 3.3.3.52 XCN Segment GT1 339 Guarantor Y 340 GT1.1 4 Set - GT1 405 6.4.5.1 SI 341 GT1.2 59 Y Guarantor Number 406 6.4.5.2 CX 342 GT1.3 48 R Y Guarantor Name 407 6.4.5.3 XPN 343 GT1.4 48 Y Guarantor Spouse Name 408 6.4.5.4 XPN 344 GT1.5 106 Y Guarantor Address 409 6.4.5.5 XAD 345 GT1.6 40 Y Guarantor Ph Num- Home 410 6.4.5.6 XTN Guarantor Ph Num- 346 GT1.7 40 Y Business 411 6.4.5.7 XTN Guarantor Date/Time of 347 GT1.8 26 Birth 412 6.4.5.8 TS 348 GT1.9 1 1 Guarantor Sex 413 6.4.5.9 IS 349 GT1.10 2 68 Guarantor Type 414 6.4.5.10 IS 350 GT1.11 2 63 Guarantor Relationship 415 6.4.5.11 IS 351 GT1.12 11 Guarantor SSN 416 6.4.5.12 ST 352 GT1.13 8 Guarantor Date - Begin 417 6.4.5.13 DT 353 GT1.14 8 Guarantor Date - End 418 6.4.5.14 DT 354 GT1.15 2 Guarantor Priority 419 6.4.5.15 NM 355 GT1.16 130 Y Guarantor Employer Name 420 6.4.5.16 XPN 356 GT1.17 106 Y Guarantor Employer Address 421 6.4.5.17 XAD 357 GT1.18 40 Y Guarantor Employ Phone Number 422 6.4.5.18 XTN Guarantor Employee 358 GT1.19 20 Y Number 423 6.4.5.19 CX Guarantor Employment 359 GT1.20 2 66 Status 424 6.4.5.20 IS 360 GT1.21 130 Y Guarantor rganization 425 6.4.5.21 XN Guarantor Billing Hold 361 GT1.22 1 136 Flag 773 6.4.5.22 362 GT1.23 80 Guarantor Credit Rating Code 774 6.4.5.23 CE 363 GT1.24 26 Guarantor Death Date And Time 775 6.4.5.24 TS 364 GT1.25 1 136 Guarantor Death Flag 776 6.4.5.25 365 GT1.26 80 218 Guarantor Charge Adjustment Code 777 6.4.5.26 CE 366 GT1.27 10 Guarantor Household Annual Income 778 6.4.5.27 CP 367 GT1.28 3 Guarantor Household Size 779 6.4.5.28 NM 368 GT1.29 20 Y Guarantor Employer Number 780 6.4.5.29 CX 369 GT1.30 1 Guarantor Marital Status Code 781 6.4.5.30 IS Formatted as (999)999-9999 Formatted as (999)999-9999 Formatted as 999-99- 9999 or 999999999 Formatted as (999)999-9999 Page Page 22 22
370 GT1.31 8 Guarantor Hire Effective Date 782 6.4.5.31 DT 371 GT1.32 8 Employment Stop Date 783 6.4.5.32 DT 372 GT1.33 2 223 Living Dependency 755 6.4.5.33 IS 373 GT1.34 2 9 Ambulatory Status 145 6.4.5.34 IS 374 GT1.35 4 171 Citizenship 129 6.4.5.35 IS 375 GT1.36 60 296 Primary Language 118 6.4.5.36 CE 376 GT1.37 2 220 Living Arrangement 742 6.4.5.37 IS 377 GT1.38 1 215 Publicity Indicator 743 6.4.5.38 CE 378 GT1.39 1 136 Protection Indicator 744 6.4.5.39 379 GT1.40 2 231 Student Indicator 745 6.4.5.40 IS 380 GT1.41 3 6 Religion 120 6.4.5.41 IS 381 GT1.42 48 Mother s Maiden Name 746 6.4.5.42 XPN 382 GT1.43 80 212 Nationality Code 739 6.4.5.43 CE 383 GT1.44 1 189 Ethnic Group 125 6.4.5.44 IS 384 GT1.45 48 Y Contact Person's Name 748 6.4.5.45 XPN Contact Person s 385 GT1.46 40 Y Telephone Number 749 6.4.5.46 XTN 386 GT1.47 2 222 Contact Reason 747 6.4.5.47 CE 387 GT1.48 2 63 Contact Relationship Code 784 6.4.5.48 IS 388 GT1.49 20 Job Title 785 6.4.5.49 ST 389 GT1.50 20 Job Code/Class 786 6.4.5.50 JCC Guarantor Employer's 390 GT1.51 130 Y rganization Name 1299 6.4.5.51 XN 391 GT1.52 2 310 Handicap 753 6.4.5.52 IS 392 GT1.53 2 311 Job Status 752 6.4.5.53 IS 393 GT1.54 50 64 Guarantor Financial Class 1231 6.4.5.54 FC 394 GT1.55 1 5 Guarantor Race 1291 6.4.5.55 IS 395 Segment IN1 Insurance Segment Y 3 Iterations 396 IN1.1 4 Set - Insurance 426 6.4.6.1 SI 397 IN1.2 60 72 R Insurance Plan 368 CE 398 IN1.3 59 Y Insurance Company 428 6.4.6.3 CX 399 IN1.4 130 R Y Insurance Company Name 429 6.4.6.4 XN 400 IN1.5 106 Y Insurance Company Address 430 6.4.6.5 XAD 401 IN1.6 48 Y Insurance Co. Contact Person 431 6.4.6.6 XPN 402 IN1.7 40 Y Insurance Co Phone Number 432 6.4.6.7 XTN 403 IN1.8 25* Group Number 433 6.4.6.8 ST 404 IN1.9 130 Y Group Name 434 6.4.6.9 XN Insured's group employer 405 IN1.10 12 Y 435 6.4.6.10 CX Formatted as (999)999-9999 Formatted as (999)999-9999 IN1.8 Group Number field lengths has been extended to 25 characters Page Page 23 23
406 IN1.11 130 Y Insured's Group Emp Name 436 6.4.6.11 XN 407 IN1.12 8 Plan Effective Date 437 6.4.6.12 DT 408 IN1.13 8 Plan Expiration Date 438 6.4.6.13 DT 409 IN1.14 55 Authorization Information 439 6.4.6.14 CM_AUI 410 IN1.15 3 86 Plan Type 440 6.4.6.15 IS 411 IN1.16 48 R Y Name of Insured 441 6.4.6.16 XPN Insured's Relationship to 412 IN1.17 2 63 Patient 442 6.4.6.17 IS 413 IN1.18 26 R Insured's Date of Birth 443 6.4.6.18 TS 414 IN1.19 106 Y Insured's Address 444 6.4.6.19 XAD 415 IN1.20 2 135 Assignment of Benefits 445 6.4.6.20 IS 416 IN1.21 2 173 Coordination of Benefits 446 6.4.6.21 IS Coordination of Ben. 417 IN1.22 2 Priority 447 6.4.6.22 ST 418 IN1.23 2 136 Notice of Admission Code 448 6.4.6.23 419 IN1.24 8 Notice of Admission Date 449 6.4.6.24 DT 420 IN1.25 2 136 Rpt of Eligibility Code 450 6.4.6.25 421 IN1.26 8 Rpt of Eligibility Date 451 6.4.6.26 DT 422 IN1.27 2 93 Release Information Code 452 6.4.6.27 IS 423 IN1.28 15 Pre-Admit Cert (PAC) 453 6.4.6.28 ST 424 IN1.29 26 Verification Date/Time 454 6.4.6.29 TS 425 IN1.30 60 Verification By 455 6.4.6.30 XPN 426 IN1.31 2 98 Type of Agreement Code 456 6.4.6.31 IS 427 IN1.32 2 22 Billing Status 457 6.4.6.32 IS 428 IN1.33 4 Lifetime Reserve Days 458 6.4.6.33 NM Delay before lifetime 429 IN1.34 4 reserve days 459 6.4.6.34 NM 430 IN1.35 8 42 Company Plan Code 460 6.4.6.35 IS 431 IN1.36 25* R Policy Number 461 6.4.6.36 ST 432 IN1.37 12 Policy Deductible 462 6.4.6.37 CP 433 IN1.38 12 Policy Limit - Amount 463 6.4.6.38 CP 434 IN1.39 4 Policy Limit - Days 464 6.4.6.39 NM 435 IN1.40 12 Room Rate - Semi-Private 465 6.4.6.40 CP 436 IN1.41 12 Room Rate - Private 466 6.4.6.41 CP Insured's Employment 437 IN1.42 60 66 Status 467 6.4.6.42 CE 438 IN1.43 1 1 Insured's Sex 468 6.4.6.43 IS Insured's Employer 439 IN1.44 106 Y Address 469 6.4.6.44 XAD 440 IN1.45 2 Verification Status 470 6.4.6.45 ST 441 IN1.46 8 72 Prior Insurance Plan 471 6.4.6.46 IS 442 IN1.47 3 309 Coverage Type 1277 6.4.6.47 IS Page Page 24 24
443 IN1.48 2 310 Handicap 753 6.4.6.48 IS 444 IN1.49 12 Y Insured's Number 1230 6.4.6.49 CX Sample HL7 ADT^A08 v2.3 Note: ADT^A08 is the default message that will be sent to an Application Provider unless another option is specified. MSH ^~\& PATACCT ABC Hospital^10112236^CV CVISINT 100 20100104185425 ADT^A08 39806 P 2.3 EVN A08 20100104185100 P 1 12345 MILLER^JAMES 19400203 M W P BX 71^^ATWD^K^748270000 063 (555)555-5555 M 1054813 123456789 PD1 53^BARLW^M^ELISABETH^MD N 1 N NK1 1 MILLER^JDI 01^SPUSE (313)595-1111 01^SPUSE PV1 1 ER 1020^BLXHAM^BRANDN^D^D ER 1 1020^BLXHAM^BRANDN^D^D E S 20100104185100 GT1 1 2003095 MILLER^JAMES P BX 71^^ATWD^K^74827 (999)999-9999 19400203 M 123456789 1 IN1 1 9037^BCBS-TN: BCBS F TENNESSEE (PP) 9037^BCBS-TN: BCBS F TENNESSEE (PP) BCBS-TN: BCBS F TENNESSEE (PP) P BX 180150^^CHATTANGA^TN^37401 ^ (800)705-0391 20070619 SETSER^VICTRIA^ 19590404 1 ABC123456789 F NTE: Carriage Return (CR) Hex decimal value of [0D ] must be used for segment terminator. Page Page 25 25
Patient Appointment Schedule Messaging ptions and Requirements Message Version HL7 v2.3 HL7 SIU Standard SIU Events SIU^S12 - Notification of new appointment booking SIU^S13 - Notification of appointment rescheduling SIU^S14 - Notification of appointment modification SIU^S15 - Notification of appointment cancellation SIU^S17- Notification of appointment deletion NTE: The events listed above all use the SIU^S12 message structure. HL7 SIU^S12 Message Structure v2.3 Segment PT/REQ Iteratio n MSH R 1:1 Message Header Response Grammar: Group Control Comment SCH R 1:1 Schedule Activity Information [ { NTE } ] 0:S Notes and comments segment Not used for processing { R 1:S PATIENT P R 1:1 Patient Identification 0:1 PATIENT_VISIT [ PV1] 0:1 Patient Visit [ PV2 ] 0:1 Patient Visit Additional Info. Not used for processing [ { BX } ] 0:S bservation/result Not used for processing [ { DG1 } ] 0:S Diagnosis Information Not used for processing } { R 1:S RESURCES RGS R 1:1 Resource Group } ] } ] [ { 0:S SERVICE Not used for processing AIS R 1:1 Appointment Information Not used for processing Service [{NTE}] 0:S Notes and comments segment Not used for processing [ { 0:S GENERAL_RES URCE AIG R 1:1 Appointment Information - General Resource Not used for processing Not used for processing [{NTE}] 0:S Notes and comments segment Not used for processing [ { 0:S LCATIN_RES Not used for processing Page Page 26 26
} ] } ] } AIL R 1:1 Appointment Information - Location Resource URCE Not used for processing [{NTE}] 0:S Notes and comments segment Not used for processing [ { 0:S PERSNNEL_RES URCE AIP R 1:1 Appointment Information - Personnel Resource Not used for processing Not used for processing [{NTE}] 0:S Notes and comments segment Not used for processing Supported SIU Segments MSH, SCH, NTE, P, PV1, PV2, BX, DG1, RGS, AIS, AIG Supported Acknowledgements Ack_General, riginal Mode Page Page 27 27
Patient Appointment Schedule SIU Segments/Fields Patient Appointment Schedules - SIU Segments/Fields Standard External Interface HL7 v2.3 Ref Segment Length Table External Interface r/o/c/b Rep# Description Item Section Segment MSH Message 1 Header R N Page Page 28 28 Data Structure 2 MSH.1 1 R Field Separator 1 2.24.1.1 ST Required Value 3 MSH.2 4 R Encoding Characters 2 2.24.1.2 ST ^~\& 4 MSH.3 180 Sending Application 3 2.24.1.3 HD 5 MSH.4 180 Sending Facility 4 2.24.1.4 HD 6 MSH.5 180 Receiving Application 5 2.24.1.5 HD 7 MSH.6 180 Receiving Facility 6 2.24.1.6 HD 8 MSH.7 26 R Date / Time of Message 7 2.24.1.7 TS Formatted as YYYYMMDDHHMMSS 9 MSH.8 40 Security 8 2.24.1.8 ST 10 MSH.9 7 R Message Type 9 2.24.1.9 CM_MSG 11 MSH.9.1 0076 R 'SIU' 12 MSH.9.2 0003 R 13 MSH.10 20 R Message Control 10 2.24.1.10 ST 14 MSH.11 3 R Processing 11 2.24.1.11 PT 'P' 15 MSH.12 8 104 R Version 12 2.24.1.12 '2.3' 16 MSH.13 15 Sequence Number 13 2.24.1.13 NM 17 MSH.14 180 Continuation Pointer 14 2.24.1.14 ST 18 MSH.15 2 155 Accept Acknowledgement Type 15 2.24.1.15 19 MSH.16 2 155 Application Acknowledgement Type 16 2.24.1.16 20 MSH.17 2 Country Code 17 2.24.1.17 21 MSH.18 6 211 Y Character Set 692 2.24.1.18 22 MSH.19 60 Principal Language of Message 693 2.24.1.19 CE 23 Segment SCH Patient Identification R N 24 SCH.1 75 R Placer Appointment 860 10.5.2.1 EI 25 SCH.1.1 R entity Identifier ST 26 SCH.1.1.1 0300 namespace IS 27 SCH.1.1.2 universal ST universal 28 SCH.1.1.3 0301 type 29 SCH.2 75 C Filler Appointment 861 10.5.2.2 EI 30 SCH.2.1 R entity Identifier ST 31 SCH.2.1.1 0300 namespace IS 32 SCH.2.1.2 universal ST 33 SCH.2.1.3 0301 universal type 34 SCH.3 5 C ccurrence Number 862 10.5.2.3 NM 35 SCH.4 75 Placer Group Number 863 10.5.2.4 EI 'S12', 'S13', 'S14', 'S15', or,'s17'
36 SCH.5 200 Schedule 864 10.5.2.5 CE 37 SCH.6 200 R Event Reason 865 10.5.2.6 CE 38 SCH.6.1 R Identifier 39 SCH.6.2 Test ST 40 SCH.6.3 Name of Coding System ST 41 SCH.6.4 Alternative Identifier 42 SCH.6.5. Alternative Text ST 43 SCH.6.6 Name of Alternative coding system ST 44 SCH.7 200 0276 Appointment Reason 867 10.5.2.7 CE 45 SCH.8 200 0277 Appointment Type 868 10.5.2.8 CE 46 SCH.9 20 Appointment Duration 869 10.5.2.9 NM 47 SCH.10 200 Appointment Duration Units 870 10.5.2.10 CE 48 SCH.11 200 R Y Appointment Timing Quantity 871 10.5.2.11 TQ 49 SCH.11.1 quantity CQ 50 SCH.11.2 interval CM 51 SCH.11.3 duration ST 52 SCH.11.4 R start date/time TS 53 SCH.11.5 end date/time TS 54 SCH.11.6 Priority ST 55 SCH.11.7 condition ST 56 SCH.11.8 Text TX 57 SCH.11.9 conjunction ST order 58 SCH.11.10 sequencing CM 59 SCH.12 48 Placer Contact Person 872 10.5.2.12 XCN 60 SCH.13 40 Placer Contact Phone Number 873 10.5.2.13 XTN 61 SCH.14 106 Placer Contact Address 874 10.5.2.14 XAD 62 SCH.15 80 Placer Contact Location 875 10.5.2.15 PL 63 SCH.16 38 R Filler Contact Person 876 10.5.2.16 XCN SCH.16.1 64 R Id Number ST SCH.16.2 65 66 67 68 SCH.16.3 SCH.16.4 SCH.16.5 R family name ST R given name ST middle initial or name ST suffix (e.g., JR or III) ST 69 SCH.16.6 prefix (e.g., DR) ST 70 SCH.16.7 degree (e.g., MD) ST 71 SCH.16.8 0297 Source table ST 72 SCH.16.9 Assigning authority HD 73 SCH.16.10 0200 name type code 74 SCH.16.11 Identifier check digit ST SCH.16.12 Code identifying the check digit scheme 75 0061 employed 76 SCH.16.13 0203 Identifier type code IS Formatted as (999)999-9999 If this info is not available default to 0 If this info is not available default to UNKNWN If this info is not available default to UNKNWN Page Page 29 29
77 SCH.16.14 Assigning facility HD Filler Contact Phone 78 SCH.17 40 Number 877 10.5.2.17 XTN 79 SCH.18 106 Filler Contact Address 878 10.5.2.18 XAD 80 SCH.19 80 Filler Contact Location 879 10.5.2.19 PL 81 SCH.20 48 R Entered by Person 880 10.5.2.20 XCN SCH.20.1 82 R Id Number ST SCH.20.2 83 SCH.20.3 R family name ST 84 R given name ST SCH.20.4 middle initial or 85 name ST SCH.20.5 suffix (e.g., JR or 86 III) ST 87 SCH.20.6 prefix (e.g., DR) ST 88 SCH.20.7 degree (e.g., MD) ST 89 SCH.20.8 0297 Source table ST 90 SCH.20.9 Assigning authority HD 91 SCH.20.10 0200 name type code SCH.20.11 Identifier check 92 digit ST SCH.20.12 Code identifying the check digit scheme 93 0061 employed 94 SCH.20.13 0203 Identifier type code IS 95 SCH.20.14 Assigning facility HD 96 SCH.21 40 Y Entered by Phone Number 881 10.5.2.21 XTN 97 SCH.22 80 Entered by Location 882 10.5.2.22 PL 98 SCH.23 75 Parent Placer Appointment 883 10.5.2.23 EI 99 SCH.24 75 Parent Filler Appointment 884 10.5.2.24 EI 100 SCH.25 200 0278 Filler Status Code 885 10.5.2.25 CE 101 Segment NTE Notes and Comments Y 102 NTE.1 4 Set Notes and Comments 96 2.24.15.1 SI 103 NTE.2 8 Source of Comment 97 2.24.15.2 104 NTE.3 65536 Y Comment 98 2.24.15.3 FT 105 Segment P Patient Identification R N 106 P.1 4 Set - Patient 104 3.3.2.1 SI 107 P.2 20 Patient (External ) 105 3.3.2.2 CX 108 P.3 20 R Y Patient (Internal ) 106 3.3.2.3 CX 109 P.3.1 R (ST) ST 110 P.3.2 check digit ST Formatted as (999)999-9999 If this info is not available default to 0 If this info is not available default to UNKNWN If this info is not available default to UNKNWN Formatted as (999)999-9999 First Instance of the P.3.1 MUST be the Non-editable Unique Patient from the source PMS system). Page Page 30 30
111 P.3.3 0061 code identifying the check digit scheme employed 112 P.3.4 assigning authority HD 113 P.3.4.1 namespace IS 114 P.3.4.2 universal ST 115 P.3.4.3 universal type 116 P.3.8 identifier type code IS 117 P.3.9 assigning facility HD 118 P.3.9.1 namespace IS 119 P.3.9.2 universal ST 120 P.3.9.3 universal type 121 P.4 20 Y Alternate Patient 107 3.3.2.4 CX 122 P.5 48 R Y Patient Name 108 3.3.2.5 XPN 123 P.5.1 R family name ST 124 P.5.2 R given name ST 125 P.5.3 middle initial or name ST 126 P.5.4 suffix (e.g., JR or III) ST 127 P.5.5 prefix (e.g., DR) ST 128 P.5.6 degree (e.g., MD) ST 129 P.5.7 0200 name type code 130 P.6 48 Mother's Maiden Name 109 3.3.2.6 XPN 131 P.7 26 Date of Birth 110 3.3.2.7 TS 132 P.8 1 001 Sex 111 3.3.2.8 IS 133 P.9 48 Y Patient Alias 112 3.3.2.9 XPN 134 P.10 1 005 Race 113 3.3.2.10 IS 135 P.11 106 Y Patient Address 114 3.3.2.11 XAD 136 P.11.1 street address ST 137 P.11.2 other designation ST 138 P.11.3 City ST 139 P.11.4 state or province ST 140 P.11.5 zip or postal code ST 141 P.11.6 Country 142 P.11.7 0190 address type 143 P.11.8 other geographic designation ST 144 P.11.9 county/parish code IS 145 P.11.10 census tract IS 146 P.12 4 County Code 115 3.3.2.12 IS 147 P.13 40 Y Phone Number - Home 116 3.3.2.13 TN 147 P.14 40 Y Phone Number - Business 117 3.3.2.14 TN 149 P.15 60 296 Primary Language 118 3.3.2.15 CE 150 P.16 1 2 Marital Status 119 3.3.2.16 IS 151 P.17 3 6 Religion 120 3.3.2.17 IS 152 P.18 20 Patient Account Number 121 3.3.2.18 CX 153 P.19 16 SSN Number - Patient 122 3.3.2.19 ST 154 P.20 25 Driver's License Number 123 3.3.2.20 DLN 155 P.21 20 Y Mother's Identifier 124 3.3.2.21 CX 156 P.22 3 189 Ethnic Group 125 3.3.2.22 IS 157 P.23 60 Birth Place 126 3.3.2.23 ST Formatted as (999)999-9999 Formatted as (999)999-9999 Formatted as 999-99- 9999 Page Page 31 31
158 P.24 2 136 Multiple Birth Indicator 127 3.3.2.24 159 P.25 2 Birth rder 128 3.3.2.25 NM 160 P.26 4 171 Y Citizenship 129 3.3.2.26 IS 161 P.27 60 172 Veterans Military Status 130 3.3.2.27 CE 162 P.28 80 212 Nationality Code 739 3.3.2.28 CE 163 P.29 26 Patient Death Date and Time 740 3.3.2.29 TS 164 P.30 1 136 Patient Death Indicator 741 3.3.2.30 165 Segment PV1 Patient Visit N 166 PV1.1 4 Set - Patient Visit 131 3.3.3.1 SI 167 PV1.2 1 4 R Patient Class 132 3.3.3.2 168 PV1.3 80 Assigned Patient Location 133 3.3.3.3 PL 169 PV1.4 2 7 Admission Type 134 3.3.3.4 170 PV1.5 20 Preadmit Number 135 3.3.3.5 CX 171 PV1.6 80 Prior Patient Location 136 3.3.3.6 PL 172 PV1.7 60 10 Y Attending Doctor 137 3.3.3.7 XCN 173 PV1.8 60 10 Y Referring Doctor 138 3.3.3.8 XCN 174 PV1.9 60 10 Y Consulting Doctor 139 3.3.3.9 XCN 175 PV1.10 3 69 Hospital Service 140 3.3.3.10 176 PV1.11 80 Temporary Location 141 3.3.3.11 PL 177 PV1.12 2 87 Preadmit Test Indicator 142 3.3.3.12 178 PV1.13 2 92 Readmission Indicator 143 3.3.3.13 179 PV1.14 3 23 Admit Source 144 3.3.3.14 180 PV1.15 2 9 Y Ambulatory Status 145 3.3.3.15 IS 181 PV1.16 2 99 VIP Indicator 146 3.3.3.16 182 PV1.17 60 10 Y Admitting Doctor 147 3.3.3.17 XCN 183 PV1.18 2 18 Patient Type 148 3.3.3.18 184 PV1.19 20 Visit Number 149 3.3.3.19 CX 185 PV1.20 50 64 Y Financial Class 150 3.3.3.20 FC 186 PV1.21 2 32 Charge Price Indicator 151 3.3.3.21 187 PV1.22 2 45 Courtesy Code 152 3.3.3.22 188 PV1.23 2 46 Credit Rating 153 3.3.3.23 189 PV1.24 2 44 Y Contract Code 154 3.3.3.24 190 PV1.25 8 Y Contract Effective Date 155 3.3.3.25 DT 191 PV1.26 12 Y Contract Amount 156 3.3.3.26 NM 192 PV1.27 3 Y Contract Period 157 3.3.3.27 NM 193 PV1.28 2 73 Interest Code 158 3.3.3.28 194 PV1.29 1 110 Transfer to Bad Debt Code 159 3.3.3.29 195 PV1.30 8 Transfer to Bad Debt Date 160 3.3.3.30 DT 196 PV1.31 10 21 Bad Debt Agency Code 161 3.3.3.31 197 PV1.32 12 Bad Debt Transfer Amount 162 3.3.3.32 NM 198 PV1.33 12 Bad Debt Recovery Amount 163 3.3.3.33 NM 199 PV1.34 1 111 Delete Account Indicator 164 3.3.3.34 200 PV1.35 8 Delete Account Date 165 3.3.3.35 DT 201 PV1.36 3 112 Discharge Disposition 166 3.3.3.36 E - Emergency I - Inpatient - utpatient P - Preadmit R - Recurring Patient B - bstetrics Page Page 32 32
202 PV1.37 25 113 Discharged to Location 167 3.3.3.37 CM 203 PV1.38 2 114 Diet Type 168 3.3.3.38 204 PV1.39 2 115 Servicing Facility 169 3.3.3.39 205 PV1.40 1 116 Bed Status 170 3.3.3.40 IS 206 PV1.41 2 117 Account Status 171 3.3.3.41 207 PV1.42 80 Pending Location 172 3.3.3.42 PL 208 PV1.43 80 Prior Temporary Location 173 3.3.3.43 PL 209 PV1.44 26 Admit Date/Time 174 3.3.3.44 TS 210 PV1.45 26 Discharge Date/Time 175 3.3.3.45 TS 211 PV1.46 12 Current Patient Balance 176 3.3.3.46 NM 212 PV1.47 12 Total Charges 177 3.3.3.47 NM 213 PV1.48 12 Total Adjustments 178 3.3.3.48 NM 214 PV1.49 12 Total Payments 179 3.3.3.49 NM 215 PV1.50 20 192 Alternate Visit 180 3.3.3.50 CX 216 PV1.51 1 326 Visit Indicator 1226 3.3.3.51 IS 217 PV1.52 60 10 Y ther Healthcare Provider 1274 3.3.3.52 XCN 218 Segment PV2 - Patient Visit Additional Information N 219 PV2.1 80 C Prior Pending Location 181 3.3.4.1 PL 220 PV2.2 60 129 Accommodation Code 182 3.3.4.2 CE 221 PV2.3 60 Admit Reason 183 3.3.4.3 CE 222 PV2.4 60 Transfer Reason 184 3.3.4.4 CE 223 PV2.5 25 Y Patient Valuables 185 3.3.4.5 ST 224 PV2.6 25 Patient Valuables Location 186 3.3.4.6 ST 225 PV2.7 2 130 Visit User Code 187 3.3.4.7 IS 226 PV2.8 26 Expected Admit Date/Time 188 3.3.4.8 TS 227 PV2.9 26 Expected Discharge Date/Time 189 3.3.4.9 TS 228 PV2.10 3 Estimated Length of Inpatient Stay 711 3.3.4.10 NM 229 PV2.11 3 Actual Length of Inpatient Stay 712 3.3.4.11 NM 230 PV2.12 50 Visit Description 713 3.3.4.12 ST 231 PV2.13 90 Referral Source Code 714 3.3.4.13 XCN 232 PV2.14 8 Previous Service Date 715 3.3.4.14 DT 233 PV2.15 1 136 Employment Illness Related Indicator 716 3.3.4.15 234 PV2.16 1 213 Purge Status Code 717 3.3.4.16 IS 235 PV2.17 8 Purge Status Date 718 3.3.4.17 DT 236 PV2.18 2 214 Special Program Code 719 3.3.4.18 IS 237 PV2.19 1 136 Retention Indicator 720 3.3.4.19 238 PV2.20 1 Expected Number of Insurance Plans 721 3.3.4.20 NM 239 PV2.21 1 215 Visit Publicity Code 722 3.3.4.21 IS 240 PV2.22 1 136 Visit Protection Indicator 723 3.3.4.22 241 PV2.23 90 Y Clinic rganization Name 724 3.3.4.23 XN 242 PV2.24 2 216 Patient Status Code 725 3.3.4.24 IS 243 PV2.25 1 217 Visit Priority Code 726 3.3.4.25 IS 244 PV2.26 8 Previous Treatment Date 727 3.3.4.26 DT 245 PV2.27 2 112 Expected Discharge Disposition 728 3.3.4.27 IS 246 PV2.28 8 Signature on File Date 729 3.3.4.28 DT Page Page 33 33
247 PV2.29 8 First Similar Illness Date 730 3.3.4.29 DT Patient Charge Adjustment 248 PV2.30 3 218 Code 731 3.3.4.30 IS 249 PV2.31 2 219 Recurring Service Code 732 3.3.4.31 IS 250 PV2.32 1 136 Billing Media Code 733 3.3.4.32 Expected Surgery Date & 251 PV2.33 26 Time 734 3.3.4.33 TS 252 PV2.34 2 136 Military Partnership Code 735 3.3.4.34 253 PV2.35 2 136 Military Non-Availability Code 736 3.3.4.35 254 PV2.36 2 136 Newborn Baby Indicator 737 3.3.4.36 255 PV2.37 1 136 Baby Detained Indicator 738 3.3.4.37 256 Segment BX - bservation N 257 BX.1 10 Set - BX 569 7.3.2.1 SI 258 BX.2 2 125 C Value Type 570 7.3.2.2 259 BX.3 590 R bservation Identifier 571 7.3.2.3 CE 260 BX.4 20 C bservation Sub- 572 7.3.2.4 ST 261 BX.5 65536 C Y bservation Value 573 7.3.2.5 * 262 BX.6 60 Units 574 7.3.2.6 CE 263 BX.7 10 References Range 575 7.3.2.7 ST 264 BX.8 5 78 Y Abnormal Flags 576 7.3.2.8 265 BX.9 5 Probability 577 7.3.2.9 NM 266 BX.10 2 80 Y Nature of Abnormal Test 578 7.3.2.10 267 BX.11 1 85 R bserv Result Status 579 7.3.2.11 268 BX.12 26 Date Last bs Normal Values 580 7.3.2.12 TS 269 BX.13 20 User Defined Access Checks 581 7.3.2.13 ST 270 BX.14 26 Date/Time of the bservation 582 7.3.2.14 TS 271 BX.15 60 Producer's 583 7.3.2.15 CE 272 BX.16 80 Responsible bserver 584 7.3.2.16 XCN 273 BX.17 60 Y bservation Method 936 7.3.2.17 CE Segment DG1-274 Diagnosis N 275 DG1.1 4 R Set - DG1 375 6.4.2.1 SI 276 DG1.2 2 53 R Diagnosis Coding Method 376 6.4.2.2 277 DG1.3 60 51 Diagnosis Code 377 6.4.2.3 CE 278 DG1.4 40 Diagnosis Description 378 6.4.2.4 ST 279 DG1.5 26 Diagnosis Date/Time 379 6.4.2.5 TS 280 DG1.6 2 52 R Diagnosis Type 380 6.4.2.6 IS 281 DG1.7 60 118 B Major Diagnostic Category 381 6.4.2.7 CE 282 DG1.8 60 55 B Diagnostic Related Group 382 6.4.2.8 CE 283 DG1.9 2 B DRG Approval Indicator 383 6.4.2.9 284 DG1.10 2 56 B DRG Grouper Review Code 384 6.4.2.10 IS 285 DG1.11 60 83 B utlier Type 385 6.4.2.11 CE 286 DG1.12 3 B utlier Days 386 6.4.2.12 NM 287 DG1.13 12 B utlier Cost 387 6.4.2.13 CP Grouper Version And 288 DG1.14 4 B Type 388 6.4.2.14 ST 289 DG1.15 2 B Diagnosis Priority 389 6.4.2.15 NM Page Page 34 34
290 DG1.16 60 Diagnosing Clinician 390 6.4.2.16 XCN 291 DG1.17 3 Diagnosis Classification 766 6.4.2.17 IS 292 DG1.18 1 228 Confidential Indicator 767 6.4.2.18 293 DG1.19 26 136 Attestation Date/Time 768 6.4.2.19 TS Segment RGS Resource 294 Group R Y 295 RGS.1 4 R Set - RGS 1203 10.5.3.1 SI 296 RGS.2 3 206 Segment Action 763 10.5.3.2 297 RGS.3 200 Resource Group 1204 10.5.3.3 CE Segment AIS Appointment Information 298 Resource Y 299 AIS.1 4 R Set - AIS 890 10.5.4.1 SI 300 AIS.2 3 206 C Segment Action 763 10.5.4.2 301 AIS.3 200 R Universal Service Identifier 238 10.5.4.3 CE 302 AIS.4 26 C Start Date/Time 1202 10.5.4.4 TS 303 AIS.5 20 C Start Date/Time ffset 891 10.5.4.5 NM 304 AIS.6 200 C Start Date/Time ffset Units 892 10.5.4.6 CE 305 AIS.7 20 Duration 893 10.5.4.7 NM 306 AIS.8 200 Duration Units 894 10.5.4.8 CE 307 AIS.9 10 279 C Allow Substitution Code 895 10.5.4.9 IS 306 AIS.10 200 278 C Filler Status Code 889 10.5.4.10 CE 307 Segment NTE Notes and Comments Y 308 NTE.1 4 Set Notes and Comments 96 2.24.15.1 SI 309 NTE.2 8 Source of Comment 97 2.24.15.2 310 NTE.3 65536 Y Comment 98 2.24.15.3 FT 311 Segment AIG Appointment Information General Y 312 313 AIG.1 4 R Set - AIG 896 10.5.5.1 SI 314 AIG.2 3 206 C Segment Action 763 10.5.5.2 315 AIG.3 200 C Resource 897 10.5.5.3 CE 316 AIG.4 200 R Resource Type 898 10.5.5.4 CE 317 AIG.5 200 Resource Group 899 10.5.5.5 CE 318 AIG.6 5 Resource Quantity 900 10.55.6 NM 319 AIG.7 200 Y Resource Quantity Units 901 10.5.5.7 CE 320 AIG.8 26 C Start Date/Time 1202 10.5.5.8 TS 321 AIG.9 20 C Start Date/Time ffset 891 10.5.5.9 NM 322 AIG10 200 C Start Date/Time ffset Units 892 10.5.5.10 CE 323 AIG.11 20 Duration 893 10.5.5.11 NM 324 AIG.12 200 Duration Units 894 10.5.5.12 CE 325 AIG.13 10 279 C Allow Substitution Code 895 10.5.5.13 IS 326 AIG.14 200 278 C Filler Status Code 889 10.5.5.14 CE Page Page 35 35
327 Segment NTE Notes and Comments Y 328 NTE.1 4 Set Notes and Comments 96 2.24.15.1 SI 329 NTE.2 8 Source of Comment 97 2.24.15.2 330 NTE.3 65536 Y Comment 98 2.24.15.3 FT 331 Segment AIL Appointment Information Location Resource Y 332 AIL.1 4 R Set - AIL 903 10.5.6.1 SI 333 AIL.2 1 206 C Segment Action 763 10.5.6.2 334 AIL.3 80 C Location Resource 903 10.5.6.3 PL 335 AIL.4 200 R Location Type 904 10.5.6.4 CE 336 AIL.5 200 Location Group 905 10.5.6.5 CE 337 AIL.6 26 C Start Date/Time 1202 10.5.6.6 TS 338 AIL.7 20 C Start Date/Time ffset 891 10.5.6.7 NM 339 AIL8 200 C Start Date/Time ffset Units 892 10.5.6.8 CE 340 AIL.9 20 Duration 893 10.5.6.9 NM 341 AIL.10 200 Duration Units 894 10.5.5.10 CE 342 AIL.11 10 279 C Allow Substitution Code 895 10.5.5.11 IS 343 AIL.12 200 278 C Filler Status Code 889 10.5.5.12 CE 344 Segment NTE Notes and Comments Y 345 NTE.1 4 Set Notes and Comments 96 2.24.15.1 SI 346 NTE.2 8 Source of Comment 97 2.24.15.2 347 NTE.3 65536 Y Comment 98 2.24.15.3 FT 348 Segment AIP Appointment Information Personnel Resource Y 349 AIP.1 4 R Set - AIP 906 10.5.7.1 SI 350 AIP.2 1 206 C Segment Action 763 10.5.7.2 351 AIP.3 80 C Personnel Resource 913 10.5.7.3 XCN 352 AIP.4 200 R Personnel Type 907 10.5.7.4 CE 353 AIP.5 200 Personnel Group 899 10.5.7.5 CE 354 AIP.6 26 C Start Date/Time 1202 10.5.7.6 TS 355 AIP.7 20 C Start Date/Time ffset 893 10.5.7.7 NM 356 AIP.8 200 C Start Date/Time ffset Units 894 10.5.7.8 CE 357 AIP.9 20 Duration 893 10.5.7.9 NM 358 AIP.10 200 Duration Units 894 10.5.7.10 CE 359 AIP.11 10 279 C Allow Substitution Code 895 10.5.7.11 IS 360 AIP.12 200 278 C Filler Status Code 889 10.5.7.12 CE 361 Segment NTE Notes and Comments Y 362 NTE.1 4 Set Notes and Comments 96 2.24.15.1 SI Page Page 36 36
363 NTE.2 8 Source of Comment 97 2.24.15.2 363 NTE.3 65536 Y Comment 98 2.24.15.3 FT Sample HL7 SIU v2.3 MSH ^~\& SDGMSYNC Medical Group PMP_SYNC 20100303080231 20100303080231108 SIU^S12 20100303080231638 P 2.3 SCH 82760 82760 82760 DIGESPRB RBERTA RSS 30 M ^^015^20100303144500 555^JHN^SMITH 0^UNKNWN^UNKNWN P 1 39164 2345678 165001 LILLY^LILLY 19740118 F 555 WDWARD^^PNTIAC^MI^48340^USA (444)999-1234 RGS 1 A AIP 1 A 000777^JNES^MICHAEL NTE: Carriage Return (CR) Hex decimal value of [0D] must be used for segment terminator. Page Page 37 37
Transmission Level HL7 ACK/NACK Segments/Fields Covisint HL7 ADT ACK Ref Seq Length Table r/o/c Rep# Description Item Section Data Structure 1 Segment MSH - Message Header R N 2 MSH.1 1 R Field Separator 1 2.24.1.1 ST 3 MSH.2 4 R Encoding Characters 2 2.24.1.2 ST ^~\& Expected Value returned by receiver 4 MSH.3 180 Sending Application 3 2.24.1.3 HD MSH.5 from the ADT msg 5 MSH.4 180 Sending Facility 4 2.24.1.4 HD MSH.6 from the ADT msg 6 MSH.5 180 Receiving Application 5 2.24.1.5 HD MSH.3 from the ADT msg 7 MSH.6 180 Receiving Facility 6 2.24.1.6 HD MSH.4 from the ADT msg 8 MSH.7 26 Date / Time of Message 7 2.24.1.7 TS System timestamp when ACK was generated. Format = ccyymmddhhmmss 9 MSH.8 40 Security 8 2.24.1.8 ST CM_MS 10 MSH.9 7 R Message Type 9 2.24.1.9 G 11 MSH.9.1 R message type ACK See component mappings 12 MSH.9.2 R trigger event MSH.9.2 from the ADT msg Unique for this message, 13 MSH.10 20 R Message Control 10 2.24.1.10 ST generated by Connect. 14 MSH.11 3 R Processing 11 2.24.1.11 PT MSH.11 from the ADT msg 15 MSH.12 8 104 R Version 12 2.24.1.12 2.3 16 MSH.13 15 Sequence Number 13 2.24.1.13 NM 17 MSH.14 180 Continuation Pointer 14 2.24.1.14 ST Accept Acknowledgement 18 MSH.15 2 155 Type 15 2.24.1.15 19 MSH.16 2 155 Application Acknowledgement Type 16 2.24.1.16 20 MSH.17 2 Country Code 17 2.24.1.17 21 MSH.18 6 211 Character Set 692 2.24.1.18 22 MSH.19 3 Principal Language of Message 693 2.24.1.19 CE 23 Segment MSA - Message Acknowledgement 24 MSA.1 2 8 R Acknowledgement code 18 2.24.2.1 25 MSA.2 20 R Message Control 10 2.24.2.2 ST 26 MSA.3 80 Text Message 20 2.24.2.3 ST Expected Sequence 27 MSA.4 15 Number 21 2.24.2.4 NM Delayed 28 MSA.5 1 102 Acknowledgement Type 22 2.24.2.5 29 MSA.6 100 Error Condition 23 2.24.2.6 CE 30 Segment ERR - Error Segment Future Use 31 ERR.1 80 60 R Y Error Code and Location 24 2.24.3.1 CM_ELD 'AA' for ADT msg accepted. 'AR' for ADT msg rejected. See HL7 table 0008. MSH.10 from the acknowledged ADT message Mapped only if an error occurs. See the Error Messages for Error text. Mapped only if an error occurs. See the Error Messages for Error codes. Page Page 38 38
Error Codes and Messages Covisint HL7 ACK Error Codes and Messages Ref Error Code Error Type Description 1 100 Segment sequence error Rejection: Segments out of order, or A required segment is missing: [seg tag]. 2 101 Required field missing Rejection: A required field is missing from a segment: [Field - Field Name]. 3 102 Data type error Rejection: The field contained data of the wrong data type: [Field - Field Name] 4 103 Table value not found Rejection: Encoding character was not found in corresponding table: [Field - Field Name]. 5 200 Unsupported message type Rejection: The Message Type is not supported. 6 201 Unsupported event code Rejection: The Event Code is not supported. 7 202 Unsupported processing id Rejection: The Processing is not supported. 8 203 Unsupported version id Rejection: The Version is not supported. 9 207 Application internal error Rejection: [other error not explicitly covered by other codes.] Page Page 39 39
Patient Context Patient Context is a federation extension that is used to send an Application Provider information that is required to uniquely identify a Patient when a user federates to an Application Provider s application (see AppCloud TM Federation Integration Guide for additional details on federation). nce the application has the information required to uniquely identify the Patient, it can then be used to retrieve a specific patient record that was obtained using Patient Sync. A Trading Partner and associated Patient are both required to uniquely identify a Patient. A typical scenario, and the associated process flow, would be the following: 1. A user that is reviewing information about a specific patient in a portal wants more information about that patient (which is located in an application at the Application Provider s site). 2. The user selects a link to the application that is associated with the patient of interest. 3. Patient identifier information is included in the federation assertion that is sent to the Application Provider. 4. The application receives the patient identifier information and uses it to provide the user with the specific information of interest, in the appropriate context, when the user accesses the application. The result of the process is a seamless experience that provides the user with the specific patient information of interest directly upon accessing the application. Patient Context is implemented by including the Trading Partner (which is associated with a specific practice s PMS system) and the Patient (Patient Identifier used in the specific PMS system) in the federation assertion. Page Page 40 40