Appendix A – Basic Definitions Definitions Data Type (DT) – The basic building block used to construct or restrict the contents of a data field. CE – element. CK – Composite ID with check digit. CM – Composite CN – Composite ID number and name. DT – Date, Date/time YYYYMMDD FN – Family name FT – Formatted text ID – Coded values for HL7 tables, all components are a ST data type IS – Coded value for user-defined table. PN – person name SI – Sequence ID. A positive integer in the form of an NM field. ST – String, alphanumeric. TQ – Timing/quantity TS – Times stamp, date/time. Exact time if the event, including date/time. TX – Text data Element/Field – A string of characters, see SEQ. Health Level 7 (HL7[1]) – HL7 is a Standards Development Organization (SDO) and focuses on the interface requirements between healthcare information systems. Maximum Length (LEN) – Maximum number of characters that one occurrence of the data field may occupy. Optionality (OPT) – Whether the is required, optional, or conditional in a segment. R – Required O – Optional C – Conditional Position (Sequence within the segment, SEQ) – See SEQ. Repetition (RP#) – Whether the field may repeat. N or – No repetition
1 3 ID B 00099 Event Type Code This field is for backward compatibility only. See MSH-9.2 allowable “trigger 2 26 TS R 00100 Recorded Date/Time 3 26 TS O 00101 Date/Time Planned Event 4 3 IS O 0062 00102 Event Reason Code 12 5 60 XCN O 00103 Operator ID 6 26 TS O 01278 Event Occurred Table 3 – HL7 – PID – Patient Identification Segment For column heading definitions, see Appendix A – Basic Definitions Example: PID|1| |123456| |SMITH^JOHN^^JR| |19650201|M| | | | | | | | | | | | | | | | | | | | | | | SEQ LEN DT OPT RP# TBL# ITEM# Element Name Comments and Examples 1 4 SI O [0..1] 00104 Set ID – PID This states the number of PID records 2 N/A 00105 Patient ID(external ID) Not used at this time for HL7 Discharge Summary Message(s) 3 20 CM R [1..*] 00106 Patient ID (Internal ID) Composite This includes the provider patient identification number and/or the attachment control number (see 3.5). 3.1 ST R ID Number The ID number for the 3.5 qualifier. 3.2 N/A 3.3 N/A 3.4 R Assigning Authority Refers to the source organization or enterprise 3.4.1 R Namespace ID Identifier to be defined by trading partner 3.4.2 O Universal ID 3.4.3 O Universal ID Type 3.5 R Identifier Type Code Provider patient identification number(s) values are
17 2 ID R 0271 00928 Document Completion Status Table 18 18 2 ID O 0272 00929 Document Confidentiality Status Table 19 19 2 ID O 0273 Document Availability Status Table 20 20 2 ID O 0275 Document Storage Status Table 21 21 30 ST C 00933 Document Change Reason Required if changes are made to the document 22 60 CM C Y Authentication Person, Time Stamp Required when is equal to “AU” or “LA “ Required if is an Authentication Person 22.1 C ID Number The ID number for the 22.13 qualifier. NOTE: The ID number is the NPI. 22.2 FN R Family Name 22.3 ST R Given Name 22.4 ST O Second and further given names or initials thereof Recommend use, if available 22.5 ST O Suffix Recommend use, if available 22.6 ST O Prefix 22.8 thru 22.12 N/A 22.13 ID C Identifier Type Code Values are limited:“NPI” NOTE: is limited to: “NPI”(National Provider Identifier) 23 60 XCN O Y 00935 Distributed Copies (Code and name of Recipients)
Table 7 – HL7 – MSH/ACK –Acknowledgement Header (Please reference Clinical Acknowledgment and Error Status Standard for those fields not addressed below) For column table heading definitions, see Appendix A – Basic Definitions Example MSH Segment- MSH| ^~\&| |9999^HT000346-001^UHIN| |1111^HT000346-002^UHIN|20060126130405| |ACK^T02 |20060126130405|P|2.3| | |ER SEQ LEN DT OPT RP# TBL# ITEM# Element Comments 9 13 CM R [1..1] 00009 Message Type Composite 9.1 ID R Message Type Use “ACK” 9.2 ID R Trigger Event Use the same trigger which was contained in the MSH-9.2 field(event type) in table 1. 12 8 CM R R [1..1] 00012 Version ID Composite 12.1 ID R Version ID Use “2.3” Table 8 – HL7 – MSA – Message Acknowledgement Segment (Please reference Clinical Acknowledgment and Error Status Standard) Table 9 – HL7 – ERR – Error Segment (Please reference Clinical Acknowledgment and Error Status Standard) 10 – HL7 User-Defined Table 0001 – Sex Value Description Comments F Female M Male O