JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle Java CAPS Message Library for HL7 User's Guide     Java CAPS Documentation
search filter icon
search icon

Document Information

Working With the Message Library for HL7

Overview of HL7 and the Message Library for HL7

About HL7

The HL7 Standard

Components of the HL7 Message

Segments

Fields

Message Delimiters

Escape Sequences in Text

HL7 Message Sets

Control

Patient Administration

Order Entry

Query

Financial Management

Observation Reporting

Master File

Medical Records/Information Management

Scheduling

Patient Referral

Patient Care

Laboratory Automation

Application Management

Personnel Management

Working With HL7 Message Libraries

Viewing a Message Library Using the Message Library Editor

To View a Message Library

Copying a Message Library to a Project

To Copy a Message Library to the Project

Modifying a Message Library Using the Message Library Editor

Message Library Check Out and Check In

Adding and Replacing Message Library Segments

Managing Message Library Nodes, Elements, and Fields

Message Library Properties

Node Properties

Element Properties

Field Properties

Specifying the Node Type

Editing the Message Library Delimiters

Changing HL7 Standard Encoding Characters

Specifying Delimiters

Using the Message Library Tester

To Use the Message Library Tester

To Test Unmarshal Functionality

To Test Data Marshal Functionality

HL7 Message Library Methods

HL7 Version 3 Message Library Structure

HL7 Version 2.6 Message Library Structure

HL7 Version 2.5.1 Message Library Structure

HL7 Version 2.5 Message Library Structure

HL7 Version 2.4 Message Library Structure

HL7 Version 2.3.1 Message Library Structure

HL7 Version 2.3 Message Library Structure

HL7 Version 2.2 Message Library Structure

HL7 Version 2.1 Message Library Structure

HL7 Version 2.3.1 Message Library Structure

The following table describes the HL7 Version 2.3.1 Message Library.

HL7 2.3.1 Segment
HL7 Description
HL7_231_ACC
Segment Message Library
HL7_231_ACK
Segment Message Library
HL7_231_ADR_A19
Segment Message Library
HL7_231_ADT_A01
Admit/Visit Notification
HL7_231_ADT_A02
Transfer a Patient
HL7_231_ADT_A03
Discharge/End Visit
HL7_231_ADT_A04
Register a Patient
HL7_231_ADT_A05
Pre-Admit a Patient
HL7_231_ADT_A06
Change an Outpatient to an Inpatient
HL7_231_ADT_A07
Change an Inpatient to an Outpatient
HL7_231_ADT_A08
Update Patient Information
HL7_231_ADT_A09
Patient Departing - Tracking
HL7_231_ADT_A10
Patient Arriving - Tracking
HL7_231_ADT_A11
Cancel Admit/Visit Notification
HL7_231_ADT_A12
Cancel Transfer
HL7_231_ADT_A13
Cancel Discharge/End Visit
HL7_231_ADT_A14
Pending Admit
HL7_231_ADT_A15
Pending Transfer
HL7_231_ADT_A16
Pending Discharge
HL7_231_ADT_A17
Swap Patients
HL7_231_ADT_A18
Merge Patient Information
HL7_231_ADT_A20
Bed Status Update
HL7_231_ADT_A21
Patient Goes on a Leave of Absence
HL7_231_ADT_A22
Patient Returns from a Leave of Absence
HL7_231_ADT_A23
Delete a Patient Record
HL7_231_ADT_A24
Link Patient Information
HL7_231_ADT_A25
Cancel Pending Discharge
HL7_231_ADT_A26
Cancel Pending Transfer
HL7_231_ADT_A27
Cancel Pending Admit
HL7_231_ADT_A28
Add Person or Patient Information
HL7_231_ADT_A29
Delete Person Information
HL7_231_ADT_A30
Merge Person Information
HL7_231_ADT_A31
Update Person Information
HL7_231_ADT_A32
Cancel Patient Arriving - Tracking
HL7_231_ADT_A33
Cancel Patient Departing - Tracking
HL7_231_ADT_A34
Merge Patient Information - Patient ID Only
HL7_231_ADT_A35
Merge Patient Information - Account Number Only
HL7_231_ADT_A36
Merge Patient Information - Patient ID & Account Number
HL7_231_ADT_A37
Unlink Patient Information
HL7_231_ADT_A38
Cancel Pre-Admit
HL7_231_ADT_A39
Merge Patient - Patient ID
HL7_231_ADT_A40
Merge Patient - Patient Identifier List
HL7_231_ADT_A41
Merge Account - Patient Account Number
HL7_231_ADT_A42
Merge Visit - Visit Number
HL7_231_ADT_A43
Move Patient Information - Patient Identifier List
HL7_231_ADT_A44
Move Account Information - Patient Account Number
HL7_231_ADT_A45
Move Visit Information - Visit Number
HL7_231_ADT_A46
Change Patient ID
HL7_231_ADT_A47
Change Patient Identifier List
HL7_231_ADT_A48
Change Alternate
HL7_231_ADT_A49
Change Patient Account Number
HL7_231_ADT_A50
Change Visit Number
HL7_231_ADT_A51
Change Alternate Visit ID
HL7_231_AIG
Segment Message Library
HL7_231_AIL
Segment Message Library
HL7_231_AIP
Segment Message Library
HL7_231_AIS
Segment Message Library
HL7_231_AL1
Segment Message Library
HL7_231_APR
Segment Message Library
HL7_231_AQR
Segment Message Library
HL7_231_AUT
Segment Message Library
HL7_231_BAR_P01
Add Patient Account
HL7_231_BAR_P02
Purge Patient Accounts
HL7_231_BAR_P05
Update Account
HL7_231_BAR_P06
End Account
HL7_231_BLG
Segment Message Library
HL7_231_CRM_C01
Register a Patient on a Clinical Trial
HL7_231_CRM_C02
Cancel a Patient Registration on Clinical Trial
HL7_231_CRM_C03
Correct/Update Registration Information
HL7_231_CRM_C04
Patient has Gone Off a Clinical Trial
HL7_231_CRM_C05
Patient Enters Phase of Clinical Trial
HL7_231_CRM_C06
Cancel Patient Entering a Phase
HL7_231_CRM_C07
Correct/Update Phase Information
HL7_231_CRM_C08
Patient has Gone Off Phase of Clinical Trial
HL7_231_CSP
Segment Message Library
HL7_231_CSR
Segment Message Library
HL7_231_CSS
Segment Message Library
HL7_231_CSU_C09
Automated Time Intervals for Reporting, Like Monthly
HL7_231_CSU_C10
Patient Completes the Clinical Trial
HL7_231_CSU_C11
Patient Completes a Phase of the Clinical Trial
HL7_231_CSU_C12
Update/Correction of Patient Order/Result Information
HL7_231_CTD
Segment Message Library
HL7_231_CTI
Segment Message Library
HL7_231_DB1
Segment Message Library
HL7_231_DFT_P03
Post Detail Financial Transactions
HL7_231_DG1
Segment Message Library
HL7_231_DOC_T12
Segment Message Library
HL7_231_DRG
Segment Message Library
HL7_231_DSC
Segment Message Library
HL7_231_DSP
Segment Message Library
HL7_231_DSR_Q01
Segment Message Library
HL7_231_DSR_Q03
Post Detail Financial Transactions - Expanded
HL7_231_EDR_R07
Enhanced Display Response
HL7_231_EQL
Segment Message Library
HL7_231_EQQ_Q04
Embedded Query Language Query
HL7_231_ERP_R09
Event Replay Response
HL7_231_ERQ
Segment Message Library
HL7_231_ERR
Segment Message Library
HL7_231_EVN
Segment Message Library
HL7_231_FAC
Segment Message Library
HL7_231_FT1
Segment Message Library
HL7_231_GOL
Segment Message Library
HL7_231_GT1
Segment Message Library
HL7_231_IN1
Segment Message Library
HL7_231_IN2
Segment Message Library
HL7_231_IN3
Segment Message Library
HL7_231_MDM_T01
Original Document Notification
HL7_231_MDM_T02
Original Document Notification and Content
HL7_231_MDM_T03
Document Status Change Notification
HL7_231_MDM_T04
Document Status Change Notification and Content
HL7_231_MDM_T05
Document Addendum Notification
HL7_231_MDM_T06
Document Addendum Notification and Content
HL7_231_MDM_T07
Document Edit Notification
HL7_231_MDM_T08
Document Edit Notification and Content
HL7_231_MDM_T09
Document Replacement Notification
HL7_231_MDM_T10
Document Replacement Notification and Content
HL7_231_MDM_T11
Document Cancel Notification
HL7_231_MFA
Segment Message Library
HL7_231_MFE
Segment Message Library
HL7_231_MFI
Segment Message Library
HL7_231_MFK_M01
Segment Message Library
HL7_231_MFK_M02
Segment Message Library
HL7_231_MFK_M03
Segment Message Library
HL7_231_MFK_M04
Segment Message Library
HL7_231_MFK_M05
Segment Message Library
HL7_231_MFK_M06
Segment Message Library
HL7_231_MFK_M07
Segment Message Library
HL7_231_MFK_M08
Segment Message Library
HL7_231_MFK_M09
Segment Message Library
HL7_231_MFK_M010
Segment Message Library
HL7_231_MFK_M11
Segment Message Library
HL7_231_MFN_M01
Master File Notification
HL7_231_MFN_M02
Staff/Practitioner Master File Message
HL7_231_MFN_M03
Master File Notification - Test/Observation
HL7_231_MFN_M04
Charge Description Master File Message
HL7_231_MFN_M05
Patient Location Master File Message
HL7_231_MFN_M06
Clinical Trials Master File Message (Identifier Code CMA)
HL7_231_MFN_M08
Master File Notification - Test/Observation (Numeric)
HL7_231_MFN_M09
Master File Notification - Test/Observation (Categorical)
HL7_231_MFN_M10
Master File Notification - Test/Observation Batteries
HL7_231_MFN_M11
Master File Notification - Test/Calculated Observations
HL7_231_MFQ_M01
Master Files Query - Not Otherwise Specified (for backward compatibility only)
HL7_231_MFQ_M02
Master Files Query - Staff/Practitioner
HL7_231_MFQ_M03
Master Files Query - Test/Observation (for backward compatibility only)
HL7_231_MFQ_M04
Master Files Query - Charge Description
HL7_231_MFQ_M05
Master Files Query - Patient Location
HL7_231_MFQ_M06
Master Files Query - Clinical Study with Phases and Schedules
HL7_231_MFR_M01
Segment Message Library
HL7_231_MFR_M02
Segment Message Library
HL7_231_MFR_M03
Segment Message Library
HL7_231_MFR_M04
Segment Message Library
HL7_231_MFR_M05
Segment Message Library
HL7_231_MFR_M06
Segment Message Library
HL7_231_MRG
Segment Message Library
HL7_231_MSA
Segment Message Library
HL7_231_MSH
Segment Message Library
HL7_231_NCK
Segment Message Library
HL7_231_NK1
Segment Message Library
HL7_231_NMD_N02
Application Management Data Message
HL7_231_NMQ_N01
Application Management Query Message
HL7_231_NMR_N01
Segment Message Library
HL7_231_NPU
Segment Message Library
HL7_231_NSC
Segment Message Library
HL7_231_NST
Segment Message Library
HL7_231_NTE
Segment Message Library
HL7_231_OBR
Segment Message Library
HL7_231_OBX
Segment Message Library
HL7_231_ODS
Segment Message Library
HL7_231_ODT
Segment Message Library
HL7_231_OM1
Segment Message Library
HL7_231_OM2
Segment Message Library
HL7_231_OM3
Segment Message Library
HL7_231_OM4
Segment Message Library
HL7_231_OM5
Segment Message Library
HL7_231_OM6
Segment Message Library
HL7_231_OMD_O01
Dietary Order
HL7_231_OMN_O01
Non-Stock Requisition Order Message
HL7_231_OMS_O01
Stock Requisition Order Message
HL7_231_ORC
Segment
HL7_231_ORD_O02
Dietary Order Acknowledgment Message
HL7_231_ORF_R04
Segment
HL7_231_ORM_O01
Pharmacy/Treatment Order Message
HL7_231_ORN_O02
General Order Acknowledgment Message
HL7_231_ORR_O02
General Order Response Message Response to any ORM
HL7_231_ORS_O02
Stock Requisition Acknowledgment
HL7_231_ORU_R01
Unsolicited Transmission of an Observation Message
HL7_231_OSQ_Q06
Query for Order Status
HL7_231_OSR_Q06
Segment Message Library
HL7_231_PCR
Segment Message Library
HL7_231_PD1
Segment Message Library
HL7_231_PDC
Segment Message Library
HL7_231_PEO
Segment Message Library
HL7_231_PES
Segment Message Library
HL7_231_PEX_P07
Unsolicited Initial Individual Product Experience Report
HL7_231_PEX_P08
Unsolicited Update Individual Product Experience Report
HL7_231_PGL_PC6
Patient Goal Message - Goal Add
HL7_231_PGL_PC7
Patient Goal Message - Goal Update
HL7_231_PGL_PC8
Patient Goal Message - Goal Delete
HL7_231_PID
Segment Message Library
HL7_231_PIN_I07
Patient Insurance Information - Unsolicited
HL7_231_PPG_PCG
Pathway (Goal-Oriented) Add
HL7_231_PPG_PCH
Pathway (Goal-Oriented) Update
HL7_231_PPG_PCJ
Pathway (Goal-Oriented) Delete
HL7_231_PPP_PCB
Pathway (Problem-Oriented) Add
HL7_231_PPP_PCC
Pathway (Problem-Oriented) Update
HL7_231_PPP_PCD
Pathway (Problem-Oriented) Delete
HL7_231_PPR_PC1
Problem Add
HL7_231_PPR_PC2
Problem Update
HL7_231_PPR_PC3
Problem Delete
HL7_231_PPT_PCL
Pathway (Goal-Oriented) Query Response
HL7_231_PPV_PCA
Goal Response
HL7_231_PR1
Segment Message Library
HL7_231_PRA
Segment Message Library
HL7_231_PRB
Segment Message Library
HL7_231_PRD
Segment Message Library
HL7_231_PRR_PC5
Problem Response
HL7_231_PSH
Segment Message Library
HL7_231_PTH
Segment Message Library
HL7_231_PTR_PCF
Pathway (Problem-Oriented) Query Response
HL7_231_PV1
Segment Message Library
HL7_231_PV2
Segment Message Library
HL7_231_QAK
Segment Message Library
HL7_231_QCK_Q02
Segment Message Library
HL7_231_QRD
Segment Message Library
HL7_231_QRF
Segment Message Library
HL7_231_QRY_A19
Patient Query
HL7_231_QRY_PC4
Problem Query
HL7_231_QRY_PC9
Goal Query
HL7_231_QRY_PCE
Pathway (Problem-Oriented) Query
HL7_231_QRY_PCK
Pathway (Goal-Oriented) Query
HL7_231_QRY_Q01
Query Sent for Immediate Response
HL7_231_QRY_Q02
Query Sent for Deferred Response
HL7_231_QRY_R02
Query for Results of Observation
HL7_231_QRY_T12
Document Query
HL7_231_RAR_RAR
Pharmacy Administration Information
HL7_231_RAS_O01
Pharmacy/Treatment Administration Order Message
HL7_231_RCI_I05
Segment Message Library
HL7_231_RCL_I06
Segment Message Library
HL7_231_RDE_O01
Pharmacy/Treatment Encoded Order Message
HL7_231_RDF
Segment Message Library
HL7_231_RDO_O01
Pharmacy/Treatment Order Message
HL7_231_RDR_RDR
Pharmacy/Treatment Dispense Information
HL7_231_RDS_O01
Pharmacy/Treatment Dispense Order Message
HL7_231_RDT
Segment Message Library
HL7_231_REF_I12
Patient Referral
HL7_231_REF_I13
Modify Patient Referral
HL7_231_REF_I14
Cancel Patient Referral
HL7_231_REF_I15
Request Patient Referral Status
HL7_231_RER_RER
Pharmacy/Treatment Encoded Order Information
HL7_231_RF1
Segment Message Library
HL7_231_RGR_RGR
Pharmacy/Treatment Dose Information
HL7_231_RGS
Segment Message Library
HL7_231_RGV_O01
Pharmacy/Treatment Give - Order Message
HL7_231_ROL
Segment Message Library
HL7_231_ROR_R0R
Pharmacy/Treatment Order Response
HL7_231_RPA_I08
Segment Message Library
HL7_231_RPA_I09
Segment Message Library
HL7_231_RPA_I10
Segment Message Library
HL7_231_RPA_I11
Segment Message Library
HL7_231_RPI_I01
Segment Message Library
HL7_231_RPI_I04
Segment Message Library
HL7_231_RPL_I02
Segment Message Library
HL7_231_RPR_I03
Segment Message Library
HL7_231_RQ1
Segment Message Library
HL7_231_RQA_I08
Request for Treatment Authorization Information
HL7_231_RQA_I09
Request for Modification to an Authorization
HL7_231_RQA_I10
Request for Re-submission of an Authorization
HL7_231_RQA_I11
Request for Cancellation of an Authorization
HL7_231_RQC_I05
Request for Patient Clinical Information
HL7_231_RQC_I06
Request/Receipt of Clinical Data Listing
HL7_231_RQD
Segment Message Library
HL7_231_RQI_I01
Request for Insurance Information
HL7_231_RQI_I02
Request/Receipt of Patient Selection Display List
HL7_231_RQI_I03
Request/Receipt of Patient Selection List
HL7_231_RQP_I04
Request for Patient Demographic Data
HL7_231_RQQ_Q09
Event Replay Query
HL7_231_RRA_O02
Pharmacy/Treatment Administration Acknowledgment Message
HL7_231_RRD_O02
Pharmacy/Treatment Dispense Acknowledgment Message
HL7_231_RRE_O02
Pharmacy/Treatment Encoded Order Acknowledgment Message
HL7_231_RRG_O02
Pharmacy/Treatment Give Acknowledgment Message
HL7_231_RRI_I12
Segment Message Library
HL7_231_RRI_I13
Segment Message Library
HL7_231_RRI_I14
Segment Message Library
HL7_231_RRI_I15
Segment Message Library
HL7_231_RRO_O02
ORR Message for Pharmacy/Treatment - Order Response
HL7_231_RXA
Segment Message Library
HL7_231_RXC
Segment Message Library
HL7_231_RXD
Segment Message Library
HL7_231_RXE
Segment Message Library
HL7_231_RXG
Segment Message Library
HL7_231_RXO
Segment Message Library
HL7_231_RXR
Segment Message Library
HL7_231_SCH
Segment Message Library
HL7_231_SIU_S12
Schedule Information Unsolicited - Notification of new appointment booking
HL7_231_SIU_S13
Schedule Information Unsolicited - Notification of Appointment Rescheduling
HL7_231_SIU_S14
Schedule Information Unsolicited - Notification of Appointment Modification
HL7_231_SIU_S15
Schedule Information Unsolicited - Notification of Appointment Cancellation
HL7_231_SIU_S16
Schedule Information Unsolicited - Notification of Appointment Discontinuation
HL7_231_SIU_S17
Schedule Information Unsolicited - Notification of Appointment Deletion
HL7_231_SIU_S18
Schedule Information Unsolicited - Notification of Addition of Service/Resource on Appointment
HL7_231_SIU_S19
Schedule Information Unsolicited - Notification of Modification of Service/Resource on Appointment
HL7_231_SIU_S20
Schedule Information Unsolicited - Notification of Cancellation of Service/Resource on Appointment
HL7_231_SIU_S21
Schedule Information Unsolicited - Notification of Discontinuation of Service/Resource on Appointment
HL7_231_SIU_S22
Schedule Information Unsolicited - Notification of Deletion of Service/Resource on Appointment
HL7_231_SIU_S23
Schedule Information Unsolicited - Notification of Blocked Schedule Time Slot(s)
HL7_231_SIU_S24
Schedule Information Unsolicited - Notification of Opened (_unblocked_) Schedule Time Slot(s)
HL7_231_SIU_S26
Schedule Information Unsolicited - Notification that Patient did Not Show Up for Schedule Appointment
HL7_231_SPQ_Q08
Stored Procedure Request
HL7_231_SPR
Segment Message Library
HL7_231_SQM_S25
Schedule Query Message and Response
HL7_231_SRM_S01
Schedule Request Message - Request New Appointment Booking
HL7_231_SRM_S02
Schedule Request Message - Request Appointment Rescheduling
HL7_231_SRM_S03
Schedule Request Message - Request Appointment Modification
HL7_231_SRM_S04
Schedule Request Message - Request Appointment Cancellation
HL7_231_SRM_S05
Schedule Request Message - Request Appointment Discontinuation
HL7_231_SRM_S06
Schedule Request Message - Request Appointment Deletion
HL7_231_SRM_S07
Schedule Request Message - Request Addition of Service/Resource on Appointment
HL7_231_SRM_S08
Schedule Request Message - Request Modification of Service/ Resource on Appointment
HL7_231_SRM_S09
Schedule Request Message - Request Cancellation of Service/ Resource on Appointment
HL7_231_SRM_S10
Schedule Request Message - Request Discontinuation of Service/ Resource on Appointment
HL7_231_SRM_S11
Schedule Request Message - Request Deletion of Service/Resource on Appointment
HL7_231_SRR_S01
Segment Message Library
HL7_231_SRR_S02
Segment Message Library
HL7_231_SRR_S03
Segment Message Library
HL7_231_SRR_S04
Segment Message Library
HL7_231_SRR_S05
Segment Message Library
HL7_231_SRR_S06
Segment Message Library
HL7_231_SRR_S07
Segment Message Library
HL7_231_SRR_S08
Segment Message Library
HL7_231_SRR_S09
Segment Message Library
HL7_231_SRR_S10
Segment Message Library
HL7_231_SRR_S11
Segment Message Library
HL7_231_STF
Segment Message Library
HL7_231_SUR_P09
Summary Product Experience Report
HL7_231_TBR_R08
Tabular Data Response
HL7_231_TXA
Segment Message Library
HL7_231_UB1
Segment Message Library
HL7_231_UB2
Segment Message Library
HL7_231_UDM_Q05
Unsolicited Display Update Message
HL7_231_URD
Segment Message Library
HL7_231_URS
Segment Message Library
HL7_231_VAR
Segment Message Library
HL7_231_VQQ_Q07
Virtual Table Query
HL7_231_VTQ
Segment Message Library
HL7_231_VXQ_V01
Query for Vaccination Record
HL7_231_VXR_V03
Vaccination Record Response
HL7_231_VXU_V04
Unsolicited Vaccination Record Update
HL7_231_VXX_V02
Response to Vaccination Query Returning Multiple PID Matches