Message Structures

255 structures in HL7 v2.3.1

§2.5.1 Messages:Message structures define the ordered sequence of segments that make up a complete HL7 message. Each structure specifies which segments are required, optional, or repeating, and how they nest into segment groups for complex data relationships.
ACK
Standard Acknowlegdement
3 segments105 events
ACK_A01
3.2.1 ADT/ACK - Admit/Visit Notification (event A01)
3 segments
ACK_A02
3.2.2 ADT/ACK - Transfer a Patient (event A02)
3 segments
ACK_A03
3.2.3 ADT/ACK - Discharge/End Visit (event A03)
3 segments
ACK_A04
3.2.4 ADT/ACK - Register a Patient (event A04)
3 segments
ACK_A05
3.2.5 ADT/ACK - Pre-admit a Patient (event A05)
3 segments
ACK_A06
3.2.6 ADT/ACK - Change an Outpatient to an Inpatient (event A06)
3 segments
ACK_A07
3.2.7 ADT/ACK - Change an Inpatient to an Outpatient (event A07)
3 segments
ACK_A08
3.2.8 ADT/ACK - Update Patient Information (event A08)
3 segments
ACK_A09
3.2.9 ADT/ACK - Patient Departing - Tracking (event A09)
3 segments
ACK_A10
3.2.10 ADT/ACK - Patient Arriving - Tracking (event A10)
3 segments
ACK_A11
3.2.11 ADT/ACK - Cancel Admit / Visit Notification (event A11)
3 segments
ACK_A12
3.2.12 ADT/ACK - Cancel Transfer (event A12)
3 segments
ACK_A13
3.2.13 ADT/ACK - Cancel Discharge / End Visit (event A13)
3 segments
ACK_A14
3.2.14 ADT/ACK - Pending Admit (event A14)
3 segments
ACK_A15
3.2.15 ADT/ACK - Pending Transfer (event A15)
3 segments
ACK_A16
3.2.16 ADT/ACK - Pending Discharge (event A16)
3 segments
ACK_A17
3.2.17 ADT/ACK - Swap Patients (event A17)
3 segments
ACK_A18
3.2.18 ADT/ACK - Merge Patient Information (event A18)
3 segments
ACK_A20
3.2.20 ADT/ACK - Bed Status Update (event A20)
3 segments
ACK_A21
3.2.21 ADT/ACK - Patient Goes on a "leave of Absence (event A21)
3 segments
ACK_A22
3.2.22 ADT/ACK - Patient Returns From a "leave of Absence (event A22)
3 segments
ACK_A23
3.2.23 ADT/ACK - Delete a Patient Record (event A23)
3 segments
ACK_A24
3.2.24 ADT/ACK - Link Patient Information (event A24)
3 segments
ACK_A25
3.2.25 ADT/ACK - Cancel Pending Discharge (event A25)
3 segments
ACK_A26
3.2.26 ADT/ACK - Cancel Pending Transfer (event A26)
3 segments
ACK_A27
3.2.27 ADT/ACK - Cancel Pending Admit (event A27)
3 segments
ACK_A28
3.2.28 ADT/ACK - Add Person Information (event A28)
3 segments
ACK_A29
3.2.29 ADT/ACK - Delete Person Information (event A29)
3 segments
ACK_A30
3.2.30 ADT/ACK - Merge Person Information (event A30)
3 segments
ACK_A31
3.2.31 ADT/ACK - Update Person Information (event A31)
3 segments
ACK_A32
3.2.32 ADT/ACK - Cancel Patient Arriving - Tracking (event A32)
3 segments
ACK_A33
3.2.33 ADT/ACK - Cancel Patient Departing - Tracking (event A33)
3 segments
ACK_A34
3.2.34 ACK/ADT - Merge Patient Information - Patient ID Only (event A34)
3 segments
ACK_A35
3.2.35 ADT/ACK - Merge Patient Information - Account Number Only (event A35)
3 segments
ACK_A36
3.2.36 ADT/ACK - Merge Patient Information - Patient ID & Account Number (event A36)
3 segments
ACK_A37
3.2.37 ADT/ACK - Unlink Patient Information (event A37)
3 segments
ACK_A38
3.2.38 ADT/ACK - Cancel Pre-admit (event A38)
3 segments
ACK_A39
3.2.39 ADT/ACK - Merge Person - Patient ID (event A39)
3 segments
ACK_A40
3.2.40 ADT/ACK - Merge Patient - Patient Identifier List (event A40)
3 segments
ACK_A41
3.2.41 ADT/ACK - Merge Account - Patient Account Number (event A41)
3 segments
ACK_A42
3.2.42 ADT/ACK - Merge Visit - Visit Number (event A42)
3 segments
ACK_A43
3.2.43 ADT/ACK - Move Patient Information - Patient Identifier List (event A43)
3 segments
ACK_A44
3.2.44 ADT/ACK - Move Account Information - Patient Account Number (event A44)
3 segments
ACK_A45
3.2.45 ADT/ACK - Move Visit Information - Visit Number (event A45)
3 segments
ACK_A46
3.2.46 ADT/ACK - Change Patient ID (event A46)
3 segments
ACK_A47
3.2.47 ADT/ACK - Change Patient Identifier List (event A47)
3 segments
ACK_A48
3.2.48 ADT/ACK - Change Alternate Patient ID (event A48)
3 segments
ACK_A49
3.2.49 ADT/ACK - Change Patient Account Number (event A49)
3 segments
ACK_A50
3.2.50 ADT/ACK - Change Visit Number (event A50)
3 segments
ACK_A51
3.2.51 ADT/ACK - Change Alternate Visit ID (event A51)
3 segments
ACK_I07
11.2.7 PIN/ACK - Unsolicited Insurance Information (event I07)
3 segments
ACK_P01
6.3.1 BAR/ACK - Add Patient Account (event P01)
3 segments
ACK_P02
6.3.2 BAR/ACK - Purge Patient Accounts (event P02)
3 segments
ACK_P03
6.3.3 DFT/ACK - Post Detail Financial Transactions (event P03)
3 segments
ACK_P05
6.3.5 BAR/ACK - Update Account (event P05)
3 segments
ACK_P06
6.3.6 BAR/ACK - End Account (event P06)
3 segments
ACK_Q03
2.18.2 DSR/ACK - Deferred Response to a Query (event Q03)
3 segments
ACK_Q05
2.14.2 UDM/ACK - Unsolicited Display Update Message (event Q05)
3 segments
ACK_R01
7.2.1 ORU/ACK - Unsolicited Transmission of an Observation Message (event R01)
2 segments
ACK_T01
9.4.1 MDM/ACK - Original Document Notification (event T01)
3 segments
ACK_T02
9.4.2 MDM/ACK - Original Document Notification and Content (event T02)
3 segments
ACK_T03
9.4.3 MDM/ACK - Document Status Change Notification (event T03)
3 segments
ACK_T04
9.4.4 MDM/ACK - Document Status Change Notification and Content (event T04)
3 segments
ACK_T05
9.4.5 MDM/ACK - Document Addendum Notification (event T05)
3 segments
ACK_T06
9.4.6 MDM/ACK - Document Addendum Notification and Content (event T06)
3 segments
ACK_T07
9.4.7 Document Edit Notification (event T07)
3 segments
ACK_T08
9.4.8 MDM/ACK - Document Edit Notification and Content (event T08)
3 segments
ACK_T09
9.4.9 MDM/ACK - Document Replacement Notification (event T09)
3 segments
ACK_T10
9.4.10 MDM/ACK - Document Replacement Notification and Content (event T10)
3 segments
ACK_T11
9.4.11 MDM/ACK - Document Cancel Notification (event T11)
3 segments
ADR_A19
27 segments
27 segments1 event
ADT_A01
General
21 segments8 events
ADT_A02
Transfer
8 segments10 events
ADT_A03
Discharge
12 segments1 event
ADT_A04
3.2.4 ADT/ACK - Register a Patient (event A04)
21 segments
ADT_A05
3.2.5 ADT/ACK - Pre-admit a Patient (event A05)
21 segments
ADT_A06
22 segments
22 segments2 events
ADT_A07
3.2.7 ADT/ACK - Change an Inpatient to an Outpatient (event A07)
22 segments
ADT_A08
3.2.8 ADT/ACK - Update Patient Information (event A08)
21 segments
ADT_A09
Track/Cancel
9 segments4 events
ADT_A10
3.2.10 ADT/ACK - Patient Arriving - Tracking (event A10)
9 segments
ADT_A11
3.2.11 ADT/ACK - Cancel Admit / Visit Notification (event A11)
9 segments
ADT_A12
Track/Cancel (2)
9 segments1 event
ADT_A13
3.2.13 ADT/ACK - Cancel Discharge / End Visit (event A13)
21 segments
ADT_A14
3.2.14 ADT/ACK - Pending Admit (event A14)
21 segments
ADT_A15
3.2.15 ADT/ACK - Pending Transfer (event A15)
9 segments
ADT_A16
Pending Discharge
10 segments1 event
ADT_A17
Swap
14 segments1 event
ADT_A18
6 segments
6 segments1 event
ADT_A20
3 segments
3 segments1 event
ADT_A21
3.2.21 ADT/ACK - Patient Goes on a "leave of Absence (event A21)
8 segments
ADT_A22
3.2.22 ADT/ACK - Patient Returns From a "leave of Absence (event A22)
8 segments
ADT_A23
3.2.23 ADT/ACK - Delete a Patient Record (event A23)
8 segments
ADT_A24
Link Patient Information
10 segments2 events
ADT_A25
3.2.25 ADT/ACK - Cancel Pending Discharge (event A25)
8 segments
ADT_A26
3.2.26 ADT/ACK - Cancel Pending Transfer (event A26)
8 segments
ADT_A27
3.2.27 ADT/ACK - Cancel Pending Admit (event A27)
8 segments
ADT_A28
3.2.28 ADT/ACK - Add Person Information (event A28)
21 segments
ADT_A29
3.2.29 ADT/ACK - Delete Person Information (event A29)
8 segments
ADT_A30
5 segments
5 segments8 events
ADT_A31
3.2.31 ADT/ACK - Update Person Information (event A31)
21 segments
ADT_A32
3.2.32 ADT/ACK - Cancel Patient Arriving - Tracking (event A32)
8 segments
ADT_A33
3.2.33 ADT/ACK - Cancel Patient Departing - Tracking (event A33)
8 segments
ADT_A34
3.2.34 ACK/ADT - Merge Patient Information - Patient ID Only (event A34)
5 segments
ADT_A35
3.2.35 ADT/ACK - Merge Patient Information - Account Number Only (event A35)
5 segments
ADT_A36
3.2.36 ADT/ACK - Merge Patient Information - Patient ID & Account Number (event A36)
5 segments
ADT_A37
10 segments
10 segments
ADT_A38
Swap (2)
10 segments1 event
ADT_A39
6 segments
6 segments4 events
ADT_A40
3.2.40 ADT/ACK - Merge Patient - Patient Identifier List (event A40)
6 segments
ADT_A41
3.2.41 ADT/ACK - Merge Account - Patient Account Number (event A41)
6 segments
ADT_A42
3.2.42 ADT/ACK - Merge Visit - Visit Number (event A42)
6 segments
ADT_A43
5 segments
5 segments2 events
ADT_A44
3.2.44 ADT/ACK - Move Account Information - Patient Account Number (event A44)
5 segments
ADT_A45
6 segments
6 segments1 event
ADT_A46
3.2.46 ADT/ACK - Change Patient ID (event A46)
5 segments
ADT_A47
3.2.47 ADT/ACK - Change Patient Identifier List (event A47)
5 segments
ADT_A48
3.2.48 ADT/ACK - Change Alternate Patient ID (event A48)
5 segments
ADT_A49
3.2.49 ADT/ACK - Change Patient Account Number (event A49)
5 segments
ADT_A50
6 segments
6 segments2 events
ADT_A51
3.2.51 ADT/ACK - Change Alternate Visit ID (event A51)
6 segments
BAR_P01
Open Account
21 segments2 events
BAR_P02
Purge Billing Account
6 segments1 event
BAR_P05
6.3.5 BAR/ACK - Update Account (event P05)
21 segments
BAR_P06
End Billing Account
4 segments1 event
CRM_C01
Clinical Trial Message
5 segments8 events
CSU_C09
Clinical Trial Message
15 segments4 events
DFT_P03
18 segments
18 segments1 event
DOC_T12
11 segments
11 segments1 event
DSR_Q01
8 segments
8 segments1 event
DSR_Q03
8 segments
8 segments1 event
EDR_Q01
0 segments
0 segments
EDR_R07
6 segments
6 segments1 event
EQQ_Q04
3 segments
3 segments1 event
ERP_Q01
0 segments
0 segments
ERP_R09
6 segments
6 segments1 event
MDM_T01
5 segments
5 segments6 events
MDM_T02
6 segments
6 segments5 events
MDM_T03
9.4.3 MDM/ACK - Document Status Change Notification (event T03)
5 segments
MDM_T04
9.4.4 MDM/ACK - Document Status Change Notification and Content (event T04)
6 segments
MDM_T05
9.4.5 MDM/ACK - Document Addendum Notification (event T05)
5 segments
MDM_T06
9.4.6 MDM/ACK - Document Addendum Notification and Content (event T06)
6 segments
MDM_T07
9.4.7 Document Edit Notification (event T07)
5 segments
MDM_T08
9.4.8 MDM/ACK - Document Edit Notification and Content (event T08)
6 segments
MDM_T09
9.4.9 MDM/ACK - Document Replacement Notification (event T09)
5 segments
MDM_T10
9.4.10 MDM/ACK - Document Replacement Notification and Content (event T10)
6 segments
MDM_T11
9.4.11 MDM/ACK - Document Cancel Notification (event T11)
5 segments
MFD_P09
0 segments
0 segments
MFK_M01
Master File Acknowledgment
5 segments11 events
MFK_M04
4 segments
4 segments
MFK_M05
4 segments
4 segments
MFK_M06
4 segments
4 segments
MFN_M01
4 segments
4 segments5 events
MFN_M02
Master File Notification for Staff/Practitioner
5 segments1 event
MFN_M03
5 segments
5 segments
MFN_M04
Master File Notification - Charge Description
5 segments
MFN_M05
Master File Notification - Patient Location
9 segments
MFN_M06
Master File Notification - Clinical Study With Phases and Schedules
6 segments
MFN_M07
Master File Notification - Clinical Study Without
0 segments1 event
MFN_M08
Master File Notification - Test/Observation (Numeric)
7 segments1 event
MFN_M09
Master File Notification - Test/Observation (Categorical)
6 segments1 event
MFN_M10
Master File Notification - Test/Observation Batteries
6 segments1 event
MFN_M11
Master File Notification - Test/Calculated Observations
6 segments1 event
MFQ_M01
4 segments
4 segments6 events
MFR_M01
10 segments
10 segments6 events
NMD_N02
Application Management Data
7 segments1 event
NMQ_N01
6 segments
6 segments1 event
NMR_N01
Application Management Response Message
10 segments1 event
OMD_O01
4.6 DIET ORDERS
20 segments1 event
OMN_O01
4.7 SUPPLY ORDERS
19 segments1 event
OMS_O01
4.7 SUPPLY ORDERS
18 segments1 event
ORD_O02
4.6 DIET ORDERS
12 segments1 event
ORF_R04
15 segments
15 segments1 event
ORM_O01
4.2.1 ORM - General Order Message (O01)
25 segments1 event
ORM_Q06
0 segments
0 segments
ORN_O02
4.7 SUPPLY ORDERS
10 segments1 event
ORR_O02
4.2.2 ORR - General Order Response Message Response to Any ORM (O02)
15 segments1 event
ORR_Q06
0 segments
0 segments
ORS_O02
4.7 SUPPLY ORDERS
9 segments1 event
ORU_R01
Observation Message
14 segments1 event
ORU_W01
0 segments
0 segments
OSQ_Q06
4 segments
4 segments1 event
OSR_Q06
6 segments
6 segments1 event
PEX_P07
Product Experience Message
26 segments2 events
PGL_PC6
Patient Goal Message
28 segments3 events
PIN_I07
5 segments
5 segments1 event
PPG_PCG
Patient Pathway Goal-Oriented Message
31 segments3 events
PPP_PCB
Patient Pathway Problem-Oriented Message
31 segments3 events
PPR_PC1
Patient Problem Message
28 segments3 events
PPT_PCL
Patient Pathway Goal-Oriented Response
35 segments1 event
PPV_PCA
Goal Query Response
32 segments1 event
PRR_PC5
Problem Query Response
32 segments1 event
PTR_PCF
Patient Pathway Problem-Oriented Response
35 segments1 event
QCK_Q02
4 segments
4 segments1 event
QRY_A19
3 segments
3 segments1 event
QRY_PC4
3 segments
3 segments4 events
QRY_PC9
12.2.7 QRY - Patient Goal Query (event PC9)
3 segments
QRY_PCE
12.2.9 QRY - Patient Pathway (problem-oriented) Query (event PCE)
3 segments
QRY_PCK
12.2.11 QRY - Patient Pathway (goal-oriented) Query (event PCK)
3 segments
QRY_Q01
4 segments
4 segments1 event
QRY_Q02
4 segments
4 segments1 event
QRY_R02
3 segments
3 segments1 event
QRY_T12
3 segments
3 segments1 event
RAR_RAR
14 segments
14 segments1 event
RAS_O01
22 segments
22 segments1 event
RCI_I05
Return Clinical Information
15 segments1 event
RCL_I06
Return Clinical List
13 segments1 event
RDE_O01
24 segments
24 segments1 event
RDO_O01
4.8.1 ORM - Pharmacy/Treatment Order Message
21 segments1 event
RDR_RDR
Pharmacy/Treatment Dispense Information
15 segments1 event
RDS_O01
22 segments
22 segments1 event
REF_I12
Patient Referral
26 segments4 events
RER_RER
12 segments
12 segments1 event
RGR_RGR
15 segments
15 segments1 event
RGV_O01
21 segments
21 segments1 event
ROR_R0R
4.8.17 R0R - Pharmacy/Treatment Order Response R0R)
12 segments
ROR_ROR
0 segments
0 segments1 event
RPA_I08
Return Patient Authorization
27 segments4 events
RPI_I01
Return Patient Information
6 segments2 events
RPI_I04
11.2.4 RQP/RPI - Request for Patient Demographic Data (event I04)
6 segments
RPL_I02
Return Patient Display List
7 segments2 events
RPR_I03
Return Patient List
6 segments
RQA_I08
Request Patient Authorization
26 segments4 events
RQC_I05
Request Clinical Information
9 segments1 event
RQC_I06
9 segments
9 segments1 event
RQI_I01
Patient Insurance Information
5 segments3 events
RQI_I02
11.2.2 RQI/RPL - Request/Receipt of Patient Selection Display List (event I02)
5 segments
RQI_I03
11.2.3 RQI/RPR - Request/Receipt of Patient Selection List (event I03)
5 segments
RQP_I04
Request Patient Demographics
7 segments1 event
RQQ_Q09
3 segments
3 segments1 event
RRA_O02
4 segments
4 segments1 event
RRD_O02
4 segments
4 segments1 event
RRE_O01
0 segments
0 segments
RRE_O02
4 segments
4 segments1 event
RRG_O02
4 segments
4 segments1 event
RRI_I12
Return Referral Information
22 segments4 events
RRO_O02
4.8.1 ORM - Pharmacy/Treatment Order Message
12 segments1 event
SIU_S12
Schedule Information Unsolicited
18 segments14 events
SPQ_Q08
4 segments
4 segments1 event
SQM_S25
3 segments
3 segments1 event
SQR_S25
20 segments
20 segments1 event
SRM_S01
Schedule Request Message
22 segments11 events
SRM_T12
0 segments
0 segments
SRR_S01
Scheduled Request Response
18 segments11 events
SRR_T12
0 segments
0 segments
SUR_P09
8 segments
8 segments1 event
TBR_QQ0
0 segments
0 segments
TBR_R08
7 segments
7 segments1 event
UDM_Q05
Unsolicited Display Message
5 segments1 event
VQQ_Q07
4 segments
4 segments1 event
VXQ_V01
Query Vaccine Record
3 segments1 event
VXR_V03
Response Single
17 segments1 event
VXU_V04
Unsolicited Vaccination Update
14 segments1 event
VXX_V02
Response Multiple
6 segments1 event