Sun HL7 Message Library User's Guide

Working With the Message Library for HL7

The topics listed on this page provide conceptual information and instructions for using the Message Library for HL7 to communicate with HL7 applications.

What You Need To Know

These links provide information you should know before using the Message Library for HL7:

What You Need To Do

These links provide instructions on how to use and customize the Message Library for HL7:

More Information

This link provides additional information related to the Message Library for HL7:

Overview of HL7 and the Message Library for HL7

The Message Library for HL7 provides HL7 files formatted in JavaTM syntax for use with Java CAPS applications. A Message Library, also know as an Object Type Definition (OTD) Library, is a compilation of pre-built message structures for industry-standard formats. The HL7 Message Library is designed to work in conjunction with the Sun Adapter for TCP/IP HL7 to help you establish and maintain an efficient and reliable HL7 messaging system.

The HL7 Message Library supports the following versions of HL7:

The HL7 Message Library files can be copied and modified using the Message Library Editor. The editor also allows you to test libraries and verify that all data elements are available and data formats are correct before runtime. The editor executes a trace of parsing during the unmarshal process to assist with troubleshooting.

About HL7

HL7 is a standard for electronic data exchange in healthcare environments. It standardizes the format and protocol for the exchange of certain key data sets among healthcare computer application systems. HL7 is designed to be flexible, allowing the various systems that send or receive patient information to share and apply data as needed. Because of this diversity in systems (data models, operating systems, communication environments, and so on), HL7 cannot be a plug and play interface standard.

HL7, or Health Level Seven, is also the name of an organization consisting of technical committees and special interest groups whose goal is to provide standards for the exchange, management, and integration of data that support clinical patient care and the management, transfer, and assessment of healthcare services. More specifically, the goal is to create flexible, cost effective approaches, standards, guidelines, methodologies, and related services for interoperability between healthcare information systems.

The HL7 Standard

The HL7 standard addresses the interfaces among various systems that send or receive healthcare focused information, such as patient admissions, registration, discharge or transfer (ADT) data, queries, resource and patient scheduling, orders, results, clinical observations, billing, master file update information, medical records, patient referral, and patient care. It does not try to assume a particular architecture with respect to the placement of data within applications but is designed to support a central patient care system as well as a more distributed environment where data resides in departmental systems. Instead, HL7 serves as a way for dissimilar applications and data architectures operating in a heterogeneous system environment to communicate with each other.

Components of the HL7 Message

An HL7 transaction or message is comprised of a number of components in a defined sequence. This section defines the components of the HL7 transaction. The HL7 message is a unit of data transferred between systems. It consist of a group of segments in a defined sequence. Each message has a message type that defines its purpose. For example an ADT Message type is used to transmit portions of a patient's Patient Administration (ADT) data from one system to another. A three-character code contained within each message identifies its type. A trigger event, a real-world event such as a patient being admitted, initiates the exchange of messages.

Segments

A segment is a logical grouping of data fields. Segments may occur only once or repeat in a message and may be required or optional. Each segment is given a name. For example, the ADT message may include the following segments: Message Header (MSH), Event Type (EVN), Patient ID (PID), and Patient Visit (PV1). Segments are identified by unique three-character codes known as the Segment IDs.

Fields

A field is a string of characters. HL7 is not concerned with how a system actually stores data within an application. When fields are transmitted, they are sent as character strings. Except where noted, HL7 data fields may take on the null value. Sending the null value, which is transmitted as two double quote marks (""), is different from omitting an optional data field. The difference appears when the contents of a message is used to update a record in a database rather than create a new one. If no value is sent, (that is, it is omitted) the old value should remain unchanged. If the null value is sent, the old value should be changed to null.

Data field characteristics are as follows:

Message Delimiters

Message delimiters are the specific predefined characters that are used to define the beginning and end of a message component. They are the segment terminator, the field separator, the component separator, subcomponent separator, repetition separator, and escape character.

Escape Sequences in Text

Fields Escape sequences vary depending on the type of field.

HL7 Message Sets

HL7 messages are grouped by type or purpose into transaction sets. For example, a Patient Administration (ADT) message is used to transmit patient admittance, transfer, demographic and discharge information. The Patient Administration transaction set includes messages that transmit portions, instances, or updates of this data necessary to the participating healthcare system.

Control

Control defines the general rules that apply to all messages, including the form used to describe messages, encoding rules for converting abstract messages to string characters, programming procedures for exchanging messages, relationship with lower level protocols, common message segments, and the acknowledgment message that can be used as-is in multiple applications.

Patient Administration

The Patient Administration transaction set (HL7 Standard, chapter 3), one of the most commonly used, provides demographic and visit information about patients. The event is transmitted as an unsolicited update or as a response to a record-oriented query.

Order Entry

The Order Entry transaction set provides for the transmission of orders for materials or services, and information regarding orders, for specific patients or departments. Order Entry messages include components that specify quantity, timing, billing, start and end date, priority, and so on.

Query

The Query transaction set provides requests for specific information with either an immediate or deferred response, depending on the type of query. Newer versions of HL7 include many of the most common queries that are likely to occur in a hospital.

Financial Management

The Financial Management transaction set provides for the entry and manipulation of information pertaining to billing accounts, adjustments, payments, charges, insurance, and other related patient billing and A/R information.

Observation Reporting

The Observation Reporting message set provides for the transmission of structured patient-oriented clinical information. This includes clinical observations such as clinical laboratory results, the results of imaging studies (excluding images), EKG pulmonary function studies, vital signs, intake and output, measures of patient status and condition, severity and/or frequency of symptoms, drug allergies, diagnostic lists, physician and nursing history, physicals, progress notes, operative notes and so on. Message information is reported in text, numeric or categorical values.

Master File

A master file is a common reference file containing more or less permanent descriptive information about a principal subject. In the healthcare environment, some common master files are doctor, location, system user, patient status, patient type, lab test definition, exam code definition, and charge master files. The Master Files Notification messages support the distribution of changes to various master files between systems, by either providing changes to the files or making data available for review and possible inclusion.

Medical Records/Information Management

The Medical Document Management (MDM) transaction set provides for the transmission of new or updated documents. MDM messages may contain a description of the status of a document (for example, the document has been dictated and is awaiting transcription) or both the status description and the document itself. A medical document or record is a legal document that serves as an accurate and comprehensive account of healthcare services provided to a patient.

Scheduling

The Scheduling transaction set supports the communication of various events in relation to schedules, appointments, services and resources. A schedule controls the dates and times available for the performance of a service or the use of a resource. The scheduling set contains three basic types of messages:

Scheduling messages may also contain other supporting information, including the reason for the appointment, patient information, person initiating the appointment, and location.

Patient Referral

The Patient Referral transaction set provides for patient referral communications between separate healthcare related entities. This includes primary healthcare providers, hospitals, labs, specialists, government agencies, and other healthcare entities. The receiving entity may require billing information, test results, provider information, patient demographics and so forth, calling for multiple inquires and responses. For this reason, the referral set includes the referral, requests for information, and returned patient information.

Patient Care

The Patient Care transaction set supports the communication of problem-oriented records which include clinical problems, goals, and clinical pathway information. The problem in this case may be a diagnosis or other professional description of healthcare issues affecting a specific patient. Goals are objectives to be attained as the result of healthcare intervention applied to an individual. A pathway refers to a standardized plan of care by which progress toward an expected outcome is measured.

Laboratory Automation

The Laboratory Automation transaction set supports the communication of equipment information, including status, inventory, logs and service, test code settings, response, notification, and comment, as well as specimen status.

Application Management

The Application Management transaction set supports the transmission of application management information and application control-level requests.

Personnel Management

The Personnel Management transaction set supports the transmission of details regarding education, language, practitioner, and professional affiliations, as well as information on practitioner organization unit, and staff identification.

Working With HL7 Message Libraries

The Message Library Editor displays the structure of a selected Message Library and allows you to verify its operation with a built-in tester. You can also use the editor to create and modify Message Libraries.

The following topics provide information specific to using Message Libraries with the Message Library Editor. These Message Libraries are templates that correspond to message types used by industry-specific data exchange systems and open-source standards. The templates are predefined and can be used as-is.


Note –

Only the base and generic 2.6 libraries are installed by default. You need to install the Message Libraries for the versions of HL7 you are using separately. For more information, see Installing Additional Repository-Based Java CAPS Components in Installing Additional Components for Java CAPS 6.


Viewing a Message Library Using the Message Library Editor

The Message Library Editor displays the structure of a selected Message Library and allows you to verify its operation with a built-in tester. You can also use the editor to create and modify User-Defined Message Libraries.

ProcedureTo View a Message Library

  1. In the NetBeans IDE, make sure you are connected to the CAPS Repository.

  2. In the Projects window, expand CAPS Components Library > Message Library > HL7.

  3. Under HL7, expand the appropriate HL7 Library version.


    Note –

    The Message Libraries available under Message Library in the Projects window are protected (read-only).


  4. Double-click the Message Library in the Projects window to view the Message Library in read-only mode.

Copying a Message Library to a Project

You can copy and paste a Message Library to your Project to view the Message Library in an editable mode.

ProcedureTo Copy a Message Library to the Project

  1. In the NetBeans IDE, make sure you are connected to the CAPS Repository.

  2. In the Projects window, expand CAPS Components Library > Message Library > HL7.

  3. Under HL7, expand the appropriate HL7 Library version.

  4. Select the Message Library you want to copy, and then select Edit > Copy from the NetBeans toolbar.

  5. Right-click the Project to which you want to paste the Message Library, and then select Paste.

    The Message Library is added to your Project on the Projects window.

  6. Double-click the copied Message Library to view it in the Message Library Editor.

    The editable Message Library appears in the Message Library Editor. Notice that for the Message Libraries, the Message Library segments are still write protected. The Message Libraries properties can only be modified from the Root node at this point.

    The Message Library Editor - HL7_25_ADT_A01
  7. Select any of the Message Library's nodes or sub-nodes in the Object Type Definition pane to see the nodes properties displayed in the editor’s Properties pane.

Modifying a Message Library Using the Message Library Editor

Message Library Check Out and Check In

The Message Libraries installed for the Message Library for HL7 are located in the Project window in the CAPS Components Library > Message Library > HL7 tree. These Message Libraries are protected and cannot be checked out or modified. This assures that the original Message Libraries are always available in their original form.

If you copy and paste an HL7 Message Library to a Project, version control is available for that Message Library. To check in or check out a Message Library, right-click the Message Library from the Project Explorer tree, and select Version Control > Check Out or Check In from the shortcut menu. When a Message Library has been checked in, the Message Library file icon appears in the Projects window as locked (the icon includes a red padlock).

Adding and Replacing Message Library Segments

HL7 Message Libraries are made up of various segment Message Libraries that correspond to the HL7 message segments. The main HL7 Message Libraries contain references to the segment Message Libraries, which are located in the same HL7 directory.

ProcedureTo Replace a Message Library Segment

The following example uses the HL7_25_ADT_A02 Message Library segment to illustrate removing a segment Message Library and replacing it with a different segment. For example, if you are working with a V2.6 library and want to use the V2.5 version for one or more segments, you can replace those segments in your Message Library. It is important to retain the original Message Library structure. If you will be doing any cutting, pasting, or deleting of segments, make a note of the Message Library segment order in the Editor’s Object Type Definition pane.

The following steps illustrate deleting a Message Library segment from this list, so it is important to make a note of the original segment location so that you can relocate the edited segment to it’s original position in the Message Library structure as illustrated in the figure.

  1. On the Projects window, copy the Message Library you want to use for your Project from CAPS Components Library > Message Library > HL7 and paste it into the Project.


    Tip –

    To copy the Message Library segment, use the copy command from the Tools menu.


  2. Repeat the above step for any Message Libraries that contain segments you want to use in the above Message Library.

  3. Double-click the pasted Message Library from step 1 above to display it in the Message Library Editor.

  4. Make note of the Message Library segment order so you can maintain the structure.

    The figure below shows the structure of the HL7_26_ADT_A02 segment.

    Message Library Segment Location
  5. Click the Internal tab in the Reference pane, right-click the segment you want to replace, and then click Delete.

  6. In the Internal tab, select the top-level node to display all segments in the Object Type Definition pane.

  7. In the Object Type Definition pane, right-click the same segment you deleted above, and click Delete again.

  8. In the Reference pane, click External, right-click any of the references to the segment you just removed, and then click Delete.

    This removes all other references to the segment Message Library.

  9. On the Message Library Editor toolbar, click Import OTD From External Template.

    The Import dialog box appears.

  10. In the Look In field, navigate to the location of the Message Library that contains the segment that will replace the one you just deleted.

    This is one of the Message Libraries you pasted into a Project in step 2 above.

  11. Locate and select the Message Library you want to import to your Project file.

  12. Click Add to add the Message Library to the Select OTD(s) to Import section. Click Import.

    The Message Library is added to the External tab of the Reference pane.

    Import Message Library Segment
  13. Drag the imported segment reference from the External tab and drop it onto the root node of the Object Type Definition pane.

    The segment is added to the Object Type Definition tree.

  14. Right-click the segment and click Level Up to move the segment up the tree from the Object Type Definition tree.

    Repeat this step until the new segment is in the same position as that of the segment being replaced.

  15. Repeat this procedure for any additional segments you want to replace.

  16. Save the changes to the Repository.

    You can now open the segment Message Library and edit the properties.

ProcedureTo Add a Segment Message Library to a Message Library

You can also modify a Message Library by adding additional segment Message Libraries to your Message Library’s external template.

  1. On the Projects window, copy the Message Library you want to use for your Project from CAPS Components Library > Message Library > HL7 and paste it into the Project.


    Tip –

    To copy the Message Library segment, use the copy command from the Tools menu.


  2. Repeat the above step to copy any segment Message Libraries you want to import to your Project.

    This opens the Message Library in the Message Library Editor.

  3. Double-click the Message Library to which you want to add the segment.

    The Message Library Editor appears.

  4. On the Message Library Editor toolbar, click Import OTD From External Template.

    The Import dialog box appears.

  5. In the Look In field, navigate to the location of the Message Library that contains the segment that will replace the one you just deleted.

    This is one of the Message Libraries you pasted into a Project in step 2 above.

  6. Locate and select the Message Library you want to import to your Project file.

  7. Click Add button to add the Message Library to the Select OTD(s) to Import section.

  8. Click Import.

    The Message Library is added to the External tab of the Reference pane.

  9. Drag the imported segment reference from the External tab and drop it onto the root node of the Object Type Definition pane.

    The segment is added to the Object Type Definition tree.

  10. Right-click the segment and click Level Up to move the segment up the tree from the Object Type Definition tree.

    Repeat this step until the new segment is in the location you want it.

  11. Save the changes to the Repository.

Managing Message Library Nodes, Elements, and Fields

The HL7 Message Library copied to your Project can only be edited from the root node. Each of the Message Library’s segments are write protected. The Message Library segments are visible from the Reference pane of the Message Library Editor. This Reference pane contains internal and external templates for the Message Library file. To edit specific segments of a Message Library, see Editing the Message Library Delimiters. For more information regarding Message Library properties, see Message Library Properties.

The Message Library Editor allows you to add and delete nodes, elements, and fields in a Message Library. You can also prune nodes, which deletes only the children associated with the node while the node itself is preserved. Pruning can only be performed on nodes. When you delete a node, all associated children are deleted. When you delete an element, all associated fields are deleted.

ProcedureTo Manage Message Library Nodes, Elements, and Fields

  1. To add a node, element, or field to the Message Library structure, right-click the

    1. Right-click the node to which you want to add the node, element, or field.

    2. Click Add, and then select the type of object to add.

    3. In the Properties pane, customize the properties for your data requirements.

      See Message Library Propertiesfor more information about properties.

  2. To remove a node, element, or field, right-click the object to remove and then click Delete.

  3. To prune a node, right-click the node and then click Prune.

Message Library Properties

The Object Type Definition pane of the Message Library Editor displays the nodes, elements, and fields of the Message Library. When any of these are selected, the item’s properties are displayed in the Properties pane.

The following topics list and describe each property:

Node Properties

When an HL7 Message Library is opened in the Message Library Editor, the properties of the root node are displayed in the Properties pane. The configurable node properties are shown in the following figure and described in the table below.

Figure shows the Message Library node properties.

Property 

Description 

name 

The node display name. This can be any string. 

javaName 

The property accessor basename. This is normally derived from the display name, modified to suit the restrictions on Java identifiers, and supplied automatically by the Sun Enterprise Service Bus. Do not modify this property. 

javaType 

The Java type. This is automatically assigned, and not is editable. 

comment 

Free-form text (no runtime effect). 

delim 

The specified delimiter. See Specifying Delimiters.

nodeType 

Governs the marshal/unmarshal format. See Specifying the Node Type.

antecoding 

The input data coding. See Changing HL7 Standard Encoding Characters.

If this property is not specified, the value specified for the decoding property will be used for the input data. This property is displayed only when the top property is set to true.

decoding 

The unmarshal coding. See Changing HL7 Standard Encoding Characters.

It is recommended to use UTF-8 for DBCS data, since the hex value of some ASCII delimiter may coincide with a hex value contained within a double-byte character. This property is displayed only when the top property is set to true.

encoding 

The marshal coding. This property is displayed only when the top property is set to true.

order 

Specifies the ordering of the root node’s children: 

  • seq: Specifies that the child nodes must appear in sequence.

  • any: Specifies that the child nodes can appear in any order.

  • mix:

postcoding 

Specifies the output data coding (see Specifying Data Encoding on page 219). If this property is not specified, the value specified for the encoding property will be used for the output data. This property is displayed only when the top property is set to true.

public 

Reserved for future development 

rootClassName 

The Java class name corresponding to the root node. 

top 

An indicator of whether the root node supports marshal/unmarshal (T/F). 

Element Properties

The set of properties associated with the element level is shown in the following figure and is described in the table below.

Figure 1 Message Library Editor - Message Library Element Properties

Message Library Editor - Message Library Element
Properties

Property 

Descriptions 

name 

The element display name. 

javaName 

Property accessor basename. Do not modify this property; it is assigned by the Sun Enterprise Service Bus. 

javaType 

The Java type. This is automatically assigned, and is not editable. 

comment 

Free-form text (no runtime effect). 

access 

The access specification. 

optional 

An indicator of whether the element is required or optional. Specify true if the element is optional; otherwise specify false. This is not applicable to the root or to a child of a choice node.

repeat 

An indicator of whether the element can have multiple instances. Specify true if the element can appear multiple times; otherwise specify false. This is not applicable to the root or to a child of a choice node.

maxOccurs 

The maximum number of occurrences of the node if the node is repeating. This property has no effect if node is non-repeating, but might show an error during validation if set to a value greater than 1. 

delim 

The delimiter specification (see Specifying Delimiters).

nodeType 

Governs the marshal/unmarshal format. See Specifying the Node Type.

showDelim 

If the nodeType property is delimited, the delimiter appears here. This field is not editable.

public 

For future use, not currently active. 

top 

An indicator or whether marshal/unmarshal is supported. Specify true if it is supported; otherwise specify false.

Field Properties

The set of properties associated with the field level is shown in the following figure and is described in the table below.

Figure 2 Message Library Editor - Message Library Field Properties

Message Library Editor - Message Library Field
Properties

Property 

Descriptions 

name 

The field display name. 

javaName 

The property accessor basename. Do not modify this property; it is assigned by the Sun Enterprise Service Bus. 

javaType 

The Java type. This can be either java.lang.String or byte array (byte[]). 

comment 

Free-form text (no runtime effect). 

access 

The access specification. 

optional 

An indicator of whether the field can be absent from an instance. Clicking the Value field toggles between true and false. Not applicable if the field is the child of a choice element node. 

repeat 

Specifies whether or not the node can appear multiple times. Specify true is the node is options; specify false if it is required. Click in the field to toggle between true and false. This is not applicable if the field is the child of a choice element node.

maxOccurs 

The maximum number of occurrences of the node if the node is repeating. This property has no effect if the node is non-repeating, but it might show an error during validation if set to a value greater than 1. 

delim 

The delimiter specification (see Specifying Delimiters).

initial 

The initial field value, which is set when the parent node is created or reset. When provided, it is assigned to the node before the node is populated with any data. 

match 

If nodeType is delimited, performs an exact match to the data.

nodeType 

Governs the marshal/unmarshal format. See Specifying the Node Type.

align 

Specifies the byte alignment criteria for the match property. 

decoding 

The unmarshal coding. This is displayed only if the nodeType property is set to fixed. It is recommended to use UTF-8 for DBCS data, since the hex value of some ASCII delimiter may coincide with a hex value contained within a doublebyte character.

encoding 

The marshal coding. This property is displayed only if the nodeType property is set to fixed.

length 

The length of the field. This property is displayed only if the nodeType property is set to fixed.

Specifying the Node Type


Note –

If you move a Message Library node, you must reset the nodeType for that node.


ProcedureTo Specify a Node Type

  1. In the Message Library Editor, expand the Message Library until the field you want to edit appears in the Object Type Definition pane.

  2. Select the field to edit.

  3. Click in the nodeType field, and then click the arrow to display the options.

  4. Select the option you want, and then save the Message Library.

    The following table describes the nodeType options.

    Option 

    Description 

    Element 

    Field 

    Internal 

    array 

    Array is a delimited structure. If repeated, occurrences are separated by the repeat delimiter. The last occurrence may be terminated by a normal delimiter. 

    Yes 

    Yes 

    simple or group 

    delim 

    Delim (delimited) structure. If repeated, occurrences are separated by a normal delimiter. 

    Yes 

    Yes 

    simple or group 

    fixed 

    Fixed indicates a fixed length, which is specified by non-negative integer (or zero to indicate end of parent node data). 

    Yes 

    Yes 

    simple or group 

    group 

    Group provides organizational grouping for purposes such as repetition. Applies only to elements. 

    Yes 

    No 

    group 

    trans 

    Trans (transient) appears only in an internal tree as a scratch pad field. It does not appear in external data representation, and can only have trans nodeTypes as children. 

    Yes 

    Yes 

    choice, simple, or group 

Editing the Message Library Delimiters

Delimiters for all node levels are set and modified from the root node. Be aware that the default level 1 delimiter character is a non-ASCII character. Once it has been changed it cannot be typed back in as a character, but it can be pasted. For information about editing a specific segment of the Message Library, see Managing Message Library Nodes, Elements, and Fields.

ProcedureTo Edit the Delimiters From the Root Node

  1. Select the root node in the Object Type Definition pane of the Message Library Editor.

  2. Double-click the delim properties field in the Properties pane.

    An ellipsis (...) button appears in the field.

  3. Click the ellipsis button.

    The Delimiter List Editor appears.

    HL7 Message Library Editor - Delimiter List Editor
  4. Double-click any field in the Delimiter List Editor on any level to make the field editable or to display a list of options.

  5. For Level 3, do the following:

    1. Double-click the Delimiter Bytes field for level 3.

    2. Change the current delimiter character to a pound sign (#), Tab to the next field, and then click OK.

      The delimiter for all level 3 nodes in the Message Library is now a pound sign (#), unless it is specified differently for a specific segment. The figure displays an example of various levels in the Object Type Definition tree, from the Root node.

      Node Levels From the Root Node

Changing HL7 Standard Encoding Characters

All HL7 Message Libraries have a predefined list of delimiters, per the definition in the HL7 Standard. If you elect to change the delimiter encoding characters in your HL7 messages, you must change the delimiter in the Message Library from the root node using the Message Library Editor to match the delimiters used in the HL7 message.

The delimiter encoding character field is a fixed-length field of four encoding characters plus the field separator. The fifth (extra) character is necessary for the segment field separator.

If you wish to validate against the encoding characters, modify the prebuilt Collaboration rules as follows:


// first unmarshal the HL7 OTD payload

// then get the encoding character field:

String encodingChars = otdHL7_GENERIC_EVT_1.getMSH().getMsh2EncodingCharacters();

if (!encodingChars.equals(“<customer_encoding_characters>”)) {

validated = false;

ErrorMessage = "Validation Failure: Receiving Facility";

log( LOG_LEVEL_ERROR, "Validate HL7 Message failed: Encoding character field" );

}

Specifying Delimiters

A node defines a set of delimiters to be used in the external data representation for itself and its descendents in the hierarchical data structure. If a node defines a delimiter list, this negates any effect of any ancestor’s delimiter list on itself and its descendents. The delimiter list is typically specified on the Root node.

For example, if you want to parse the following data:


a^b|c^d|e

you might define a Message Library as follows:

The delimiter list for this Message Library will be specified on the demo-otd element, so that it applies to the entire Message Library, and will have two levels:

Level 1

Level 2

The Level 1 delimiter applies to the two elements and field 5, and the Level 2 delimiter applies to fields 1 through 4.

Delimiter lists can be much more complex than this very simple example. For instance, you can create multiple delimiters of different types at any given level, and you can specify a delimiter list on any node within the Message Library—not only the Root node as shown in the example. See Modifying a Message Library Using the Message Library Editor for a description of the procedure for creating a Delimiter List.

Delimiter Properties

Delimiters are defined using the Delimiter List Editor. The Delimiter properties and values are displayed in the following.

Table 1 Delimiter Properties

Delimiter Properties and Value Options 

Property 

Option 

Description 

Level 

 

Child level beneath defining node. 

Type 

escape 

Escape sequence. 

 

repeat 

Array delimiter/separator. 

 

normal 

Terminator. 

Delimiter Bytes 

 

Delimiter (single or multiple characters). 

Precedence 

 

See Precedence. 

Optional Mode 

never 

Do not allow on input, do not emit on output (empty field between delimiters implies zero length data field). 

 

allow 

Skip empty field if present; if absent, do not delimit on output. 

 

cheer 

Skip empty field if present; if absent, do delimit on output. 

 

force 

Require empty, delimited field on input; always delimit on output. 

Terminator Mode 

never 

Do not allow on input, do not emit on output (pure separator). 

 

allow 

Allow on input, do not emit on output. 

 

cheer 

Allow on input, always emit on output. 

 

force 

Require on input, always emit on output (pure terminator). 

Type Property - Escape Option

An escape delimiter is simply a sequence that will be recognized and ignored during parsing. Its purpose is to allow the use of escape sequences to embed byte sequences in data that would otherwise be seen as delimiter occurrences.

For example, if there is a normal delimiter “+” at a given level, and we define an escape delimiter “\+”, then aaa+b\+c+ddd will parse as three fields: aaa, b\+c, and ddd. If the escape delimiter were not defined, the sequence would then parse as four fields: aaa, b\, c, and ddd.

If there is only an escape delimiter on a given level, however, it presents a no delimiter defined situation for delim and array nodes.

Delimiter Bytes

There is essentially no limitation on what characters you can use as delimiters; however, you obviously want to avoid characters that can be confused with data or interfere with escape sequences. The backslash (\) is normally used as an escape character. The HL7 protocol uses a double backslash as part of an escape sequence that provides special text formatting instructions.


Note –

You should avoid using a colon (:) as a delimiter character, since it is used as a literal in system-generated time strings. This can interfere with recovery procedures, for example following a Domain shutdown.


Terminator Mode Property

Consider the tree structure shown in the previous example, where the node a has a pipe (|) as its delimiter, the sub-node b has a tilde (~) as its delimiter, and sub-node c has an asterisk (*) as its delimiter.

Option 

Input 

Output 

never 

c| 

c| 

allow 

c| or c*| 

c| 

cheer 

c| or c*| 

c*| 

force 

c*| 

c*| 

Optional Mode Property

Consider the tree structures shown in the figures, where the node a has a pipe (|) as its delimiter, and the sub-nodes b, c, and d all have asterisks (*) as their delimiters.

Option 

Input 

Output 

never 

b*d| 

b*d| 

allow 

b**d| 

b*d| 

cheer 

b**d| 

b**d| 

force 

b**d| 

b**d| 

Option 

Input 

Output 

never 

b| 

b| 

allow 

b|, b*|, or b**| 

b| 

cheer 

b|, b*|, or b**| 

b**| 

force 

b**| 

b**| 

Precedence

Precedence indicates the priority of a certain delimiter, relative to the other delimiters. By default, all delimiters are at precedence 10, which means they are all considered the same; fixed fields are hard-coded at precedence 10. Delimiters on parent nodes are not considered when parsing the child fields; only the child’s delimiter (or if it is a fixed field, its length).

Changing the precedence of a delimiter will cause them to be applied to the input data-stream in different ways. For example:

Using the Message Library Tester

The Message Library Tester allows you to simulate the operation of a Collaboration containing a specific Message Library, thereby checking the correctness of the library during the design phase. You can enter input data values, perform the unmarshal and marshal operations, and also manipulate the tree structure as a Collaboration might do by using the Add Instance and Delete Instance functions. By using these latter features, you can prepare an output data file that can then be used as an input data file for testing purposes.


Note –

For selected Message Libraries, the Verbose option provides a trace of parsing actions during the unmarshal process to aid in debugging the library structure. Selecting the Verbose check box causes parsing information to appear on the Verbose panel. The format and content of the data display are library-specific.


ProcedureTo use the Message Library Tester

  1. Open a Message Library in the editor.

  2. From the Message Library Editor toolbar, click Run Test.

    This saves the currently displayed Message Library to the Repository and displays the Message Library Tester at the bottom of the Message Library Editor. The data display panel offers four different data display modes. The Input mode is selected by default.

  3. You can provide the input test data either by clicking the Open File icon and selecting a data file, or by copying and pasting the data to the Message Library Tester data panel.

  4. Perform any of the following test:

ProcedureTo Test Unmarshal Functionality

  1. Click the desired unmarshal command to unmarshal the data from the Input panel to the OTD tree.

    The unmarshal options are:

    • Unmarshal

    • Unmarshal from Bytes

    • Unmarshal from String

  2. To verify the unmarshal process, check the values of each element for correctness.

  3. Save your input test data to a file for reuse by selecting the Input panel and clicking the Save icon.

  4. If there are errors in your input data, the Status panel appears, displaying the appropriate error messages. Confirmation of correct operation is also reported.

ProcedureTo Test Data Marshal Functionality

  1. From the Message Library Tester, enter or change data values for each node in the Value column of the node table.

    Use the Add/Delete Instance (+/-) buttons to add or remove instances where needed.

  2. In the Input View Encoding field, select the output character encoding.

  3. Click the desired marshal button to marshal (serialize) the data.

    The output is displayed in the Output panel

    The marshal options are:

    • Marshal

    • Marshal to Bytes

    • Marshal to String

HL7 Message Library Methods

The HL7 Message Library provides an API that is available for you to use with your HL7 applications. The HL7UtilityFunctions class contains a number of Java methods that have been exposed to extend the functionality of the libraries. The utility functions are documented in the complete Javadocs for the HL7 Message Library. You can access the Javadocs in both HTML format and a downloadable ZIP file from http://developers.sun.com/docs/javacaps/api/javadocs/index.jsp.

HL7 Version 2.6 Message Library Structure

The following table describes the HL7 Version 2.6 Message Library.

HL7 2.6 Segment 

HL7 Description 

HL7_26_ADT_A03 

ADT/ACK - Discharge/end visit 

HL7_26_SIU_S13 

SIU/ACK - Notification of appointment rescheduling 

HL7_26_QBP_Z81 

Dispense History 

HL7_26_OMN_O07 

OMN - Non-stock requisition order 

HL7_26_RRE_O26 

RRE - Pharmacy/Treatment Refill Authorization Acknowledgement 

HL7_26_ADT_A01 

ADT/ACK - Admit/visit notification 

HL7_26_QSX_J02 

QSX/ACK - Cancel subscription/acknowledge message 

HL7_26_SRM_S05 

SRM/SRR - Request appointment discontinuation 

HL7_26_EHC_E21 

Cancel Authorization Request 

HL7_26_RSP_K25 

RSP - Personnel Information by Segment Response 

HL7_26_DFT_P03 

DFT/ACK - Post detail financial transaction 

HL7_26_PEX_P07 

PEX - Unsolicited initial individual product experience report 

HL7_26_MDM_T03 

MDM/ACK - Document status change notification 

HL7_26_RQA_I09 

RQA/RPA - Request for modification to an authorization 

HL7_26_SRR_S08 

SRM/SRR - Request modification of service/resource on appointment 

HL7_26_ADT_A37 

ADT/ACK - Unlink patient information 

HL7_26_ADT_A52 

ADT/ACK - Cancel leave of absence for a patient 

HL7_26_ADT_A22 

ADT/ACK - Patient returns from a "leave of absence" 

HL7_26_SIU_S24 

SIU/ACK - Notification of opened ("unblocked") schedule time slot(s) 

HL7_26_MFK_M14 

MFN/MFK - Master file notification - site defined 

HL7_26_ADT_A12 

ADT/ACK - Cancel transfer 

HL7_26_RRD_O14 

RRD - Pharmacy/treatment dispense acknowledgment 

HL7_26_PMU_B02 

PMU/ACK - Update personnel record 

HL7_26_RSP_E03 

HealthCare Services Invoice Status 

HL7_26_QBP_E03 

HealthCare Services Invoice Status 

HL7_26_MFK_M05 

MFN/MFK - Patient location master file 

HL7_26_ADT_A42 

ADT/ACK - Merge visit - visit number 

HL7_26_RSP_Z82 

Dispense History (Response) 

HL7_26_RCL_I06 

RQC/RCL - Request/receipt of clinical data listing 

HL7_26_PEX_P08 

PEX - Unsolicited update individual product experience report 

HL7_26_ADT_A39 

ADT/ACK - Merge person - patient ID (for backward compatibility only) 

HL7_26_ADT_A55 

ADT/ACK - Cancel change attending doctor 

HL7_26_ADT_A38 

ADT/ACK - Cancel pre-admit 

HL7_26_OPU_R25 

OPU - Unsolicited Population/Location-Based Laboratory Observation Message 

HL7_26_SRM_S06 

SRM/SRR - Request appointment deletion 

HL7_26_ADT_A54 

ADT/ACK - Change attending doctor 

HL7_26_EAN_U09 

EAN/ACK - Automated equipment notification 

HL7_26_ADT_A06 

ADT/ACK - Change an outpatient to an inpatient 

HL7_26_SIU_S17 

SIU/ACK - Notification of appointment deletion 

HL7_26_ADT_A35 

ADT/ACK - Merge patient information - account number only (for backward compatibility 

HL7_26_ACK 

Version 2.6 HL7 Acknowledgment 

HL7_26_PMU_B08 

PMU/ACK - Revoke Certificate/Permission 

HL7_26_MFN_M11 

MFN/MFK - Test/calculated observations master file 

HL7_26_RDY_Z80 

Dispense Information (Response) 

HL7_26_QBP_Q15 

QBP - Query by parameter requesting an RDY display response 

HL7_26_SRR_S03 

SRM/SRR - Request appointment modification 

HL7_26_QRY_Q26 

ROR - Pharmacy/treatment order response 

HL7_26_QBP_Q24 

QBP - Allocate identifiers 

HL7_26_MFK_M10 

MFN/MFK - Test /observation batteries master file 

HL7_26_ADT_A46 

ADT/ACK - Change patient ID (for backward compatibility only) 

HL7_26_ADT_A45 

ADT/ACK - Move visit information - visit number 

HL7_26_OUL_R23 

OUL - Unsolicited Specimen Container Oriented Observation Message 

HL7_26_SRR_S10 

SRM/SRR - Request discontinuation of service/resource on appointment 

HL7_26_MFN_M01 

MFN/MFK - Master file not otherwise specified (for backward compatibility only) 

HL7_26_RQA_I10 

RQA/RPA - Request for re-submission of an authorization 

HL7_26_SCN_S37 

SCN/ACK - Notification of anti-microbial device cycle data 

HL7_26_QBP_E22 

Authorization Request Status 

HL7_26_MFK_M07 

MFN/MFK - Clinical study without phases but with schedules master file 

HL7_26_RTB_Z94 

Tabular Dispense History (Response) 

HL7_26_ADT_A48 

ADT/ACK - Change alternate patient ID (for backward compatibility only) 

HL7_26_MDM_T06 

MDM/ACK - Document addendum notification and content 

HL7_26_MDM_T10 

MDM/ACK - Document replacement notification and content 

HL7_26_NMQ_N01 

NMQ/NMR - Application management query message 

HL7_26_INR_U06 

INR/ACK - Automated equipment inventory request 

HL7_26_RSP_K22 

RSP - Find candidates response 

HL7_26_MDM_T09 

MDM/ACK - Document replacement notification 

HL7_26_RSP_K24 

RSP - Allocate identifiers response 

HL7_26_SRM_S04 

SRM/SRR - Request appointment cancellation 

HL7_26_PMU_B03 

PMU/ACK - Delete personnel re cord 

HL7_26_ADT_A23 

ADT/ACK - Delete a patient record 

HL7_26_MFN_M05 

MFN/MFK - Patient location master file 

HL7_26_RTB_Z92 

Who Am I (Response) 

HL7_26_ADT_A30 

ADT/ACK - Merge person information (for backward compatibility only) 

HL7_26_CSU_C11 

CSU - Patient completes a phase of the clinical trial 

HL7_26_TCR_U11 

TCR/ACK - Automated equipment test code settings request 

HL7_26_ADT_A04 

ADT/ACK - Register a patient 

HL7_26_ADT_A26 

ADT/ACK - Cancel pending transfer 

HL7_26_ACK_var 

null 

HL7_26_ORU_R01 

ORU/ACK - Unsolicited transmission of an observation message 

HL7_26_OMI_O23 

OMI - Imaging order 

HL7_26_MFK_M17 

DRG Master File Message 

HL7_26_OML_O33 

OML - Laboratory order for multiple orders related to a single specimen 

HL7_26_PMU_B04 

PMU/ACK - Active practicing person 

HL7_26_CRM_C02 

CRM - Cancel a patient registration on clinical trial (for clerical mistakes only) 

HL7_26_RGR_RGR 

Pharmacy/Treatment Dose Information 

HL7_26_OMB_O27 

OMB - Blood product order 

HL7_26_RQP_I04 

RQD/RPI - Request for patient demographic data 

HL7_26_ADT_A15 

ADT/ACK - Pending transfer 

HL7_26_BAR_P01 

BAR/ACK - Add patient accounts 

HL7_26_CRM_C03 

CRM - Correct/update registration information 

HL7_26_ORL_O34 

ORL - Laboratory order response message to a multiple order related to single specification 

HL7_26_DFT_P11 

DFT/ACK - Post Detail Financial Transactions - New 

HL7_26_INU_U05 

INU/ACK - Automated equipment inventory update 

HL7_26_QBP_Z93 

Tabular Dispense History 

HL7_26_PPT_PCL 

PPT - PC/ pathway (goal-oriented) query response 

HL7_26_RSP_K31 

RSP - Dispense History Response 

HL7_26_RPL_I02 

RQI/RPL - Request/receipt of patient selection display list 

HL7_26_RSP_E22 

Authorization Request Status 

HL7_26_MFN_M02 

MFN/MFK - Master file - staff practitioner 

HL7_26_VXR_V03 

VXR - Vaccination record response 

HL7_26_RSP_Z86 

Pharmacy Information Comprehensive (Response) 

HL7_26_RTB_Z76 

Tabular Patient List (Response) 

HL7_26_RPA_I09 

RQA/RPA - Request for modification to an authorization 

HL7_26_ADT_A05 

ADT/ACK - Pre-admit a patient 

HL7_26_ADT_A53 

ADT/ACK - Cancel patient returns from a leave of absence 

HL7_26_SIU_S22 

SIU/ACK - Notification of deletion of service/resource on appointment 

HL7_26_RSP_Z88 

Dispense Information (Response) 

HL7_26_RTB_K13 

RTB - Tabular response in response to QBP^Q13 

HL7_26_MDM_T08 

MDM/ACK - Document edit notification and content 

HL7_26_BPS_O29 

BPS - Blood product dispense status 

HL7_26_MFK_M12 

MFN/MFK - Master file notification message 

HL7_26_ROR_ROR 

ROR - Pharmacy prescription order query response 

HL7_26_RDS_O13 

RDS - Pharmacy/treatment dispense 

HL7_26_EHC_E20 

Submit Authorization Request 

HL7_26_PIN_I07 

PIN/ACK - Unsolicited insurance information 

HL7_26_SIU_S18 

SIU/ACK - Notification of addition of service/resource on appointment 

HL7_26_ADT_A43 

ADT/ACK - Move patient information - patient identifier list 

HL7_26_ADT_A41 

ADT/ACK - Merge account - patient account number 

HL7_26_QBP_Q21 

QBP - Get person demographics 

HL7_26_ADT_A60 

ADT/ACK - Update allergy information 

HL7_26_MFK_M15 

MFN/MFK - Inventory item master file notification 

HL7_26_RAR_RAR 

Pharmacy/Treatment Administration Information 

HL7_26_OUL_R24 

OUL - Unsolicited Order Oriented Observation Message 

HL7_26_RPI_I04 

RQD/RPI - Request for patient demographic data 

HL7_26_ADT_A08 

ADT/ACK - Update patient information 

HL7_26_RSP_K21 

RSP - Get person demographics response 

HL7_26_MDM_T04 

MDM/ACK - Document status change notification and content 

HL7_26_EHC_E15 

Payment/Remittance Advice 

HL7_26_CRM_C05 

CRM - Patient enters phase of clinical trial 

HL7_26_EHC_E13 

Additional Information Response 

HL7_26_SRR_S07 

SRM/SRR - Request addition of service/resource on appointment 

HL7_26_RDE_O11 

RDE - Pharmacy/treatment encoded order 

HL7_26_MFK_M13 

MFN/MFK - Master file notification - general 

HL7_26_ORN_O08 

ORN - Non-stock requisition acknowledgment 

HL7_26_SSR_U04 

SSR/ACK - specimen status request 

HL7_26_ADT_A16 

ADT/ACK - Pending discharge 

HL7_26_OML_O21 

OML - Laboratory order 

HL7_26_MFN_M14 

MFN/MFK - Master file notification - site defined 

HL7_26_QBP_Q13 

QBP - Query by parameter requesting an RTB - tabular response 

HL7_26_OPR_O38 

OPR - Population/Location-Based Laboratory Order Acknowledgment Message 

HL7_26_MFN_M06 

MFN/MFK - Clinical study with phases and schedules master file 

HL7_26_ORI_O24 

ORI - Imaging order response message to any OMI 

HL7_26_ORU_R32 

ORU - Unsolicited Pre-Ordered Point-Of-Care Observation 

HL7_26_ADT_A34 

ADT/ACK - Merge patient information - patient ID only (for backward compatibility) 

HL7_26_VXU_V04 

VXU - Unsolicited vaccination record update 

HL7_26_RRA_O18 

RRA - Pharmacy/treatment administration acknowledgment 

HL7_26_BAR_P10 

BAR/ACK - Transmit Ambulatory Payment Classification (APC) 

HL7_26_EAC_U07 

EAC/ACK - Automated equipment command 

HL7_26_RRE_O12 

RRE - Pharmacy/treatment encoded order acknowledgment 

HL7_26_BRT_O32 

BRT - Blood product transfusion/disposition acknowledgment 

HL7_26_PMU_B07 

PMU/ACK - Grant Certificate/Permission 

HL7_26_SRR_S05 

SRM/SRR - Request appointment discontinuation 

HL7_26_RQA_I11 

RQA/RPA - Request for cancellation of an authorization 

HL7_26_QRY_Q29 

RER - Pharmacy/treatment encoded order information 

HL7_26_PRR_PC5 

PRR - PC/ problem response 

HL7_26_ADT_A50 

ADT/ACK - Change visit number 

HL7_26_RPR_I03 

RQI/RPR - Request/receipt of patient selection list 

HL7_26_EAR_U08 

EAR/ACK - Automated equipment response 

HL7_26_PPR_PC2 

PPR - PC/ problem update 

HL7_26_PMU_B05 

PMU/ACK - Deactivate practicing person 

HL7_26_RGV_O15 

RGV - Pharmacy/treatment given 

HL7_26_CSU_C12 

CSU - Update/correction of patient order/result information 

HL7_26_ORL_O36 

ORL - Laboratory order response message to a single container of a specimen OML 

HL7_26_CRM_C08 

CRM - Patient has gone off phase of clinical trial 

HL7_26_MFN_M13 

MFN/MFK - Master file notification - general 

HL7_26_ADT_A24 

ADT/ACK - Link patient information 

HL7_26_SLN_S35 

SLN/ACK - Notification of sterilization lot deletion 

HL7_26_ESR_U02 

ESR/ACK - Automated equipment status request 

HL7_26_MFK_M04 

MFN/MFK - Master files charge description 

HL7_26_RDE_O25 

RDE - Pharmacy/treatment refill authorization request 

HL7_26_RPA_I11 

RQA/RPA - Request for cancellation of an authorization 

HL7_26_RTB_Z78 

Tabular Patient List (Response) 

HL7_26_MFK_M08 

MFN/MFK - Test/observation (numeric) master file 

HL7_26_ORU_R30 

ORU - Unsolicited Point-Of-Care Observation Message Without Existing Order - Placed 

HL7_26_SRR_S04 

SRM/SRR - Request appointment cancellation 

HL7_26_SSU_U03 

SSU/ACK - Specimen status update 

HL7_26_SIU_S14 

SIU/ACK - Notification of appointment modification 

HL7_26_PGL_PC8 

PGL - PC/ goal delete 

HL7_26_VXX_V02 

VXX - Response to vaccination query returning multiple PID matches 

HL7_26_MFN_M04 

MFN/MFK - Master files charge description 

HL7_26_RSP_Znn 

null 

HL7_26_SIU_S15 

SIU/ACK - Notification of appointment cancellation 

HL7_26_PPP_PCB 

PPP - PC/ pathway (problem-oriented) add 

HL7_26_QBP_Z91 

Who Am I 

HL7_26_MDM_T11 

MDM/ACK - Document cancel notification 

HL7_26_OMS_O05 

OMS - Stock requisition order 

HL7_26_MFN_M10 

MFN/MFK - Test /observation batteries master file 

HL7_26_PPG_PCH 

PPG - PC/ pathway (goal-oriented) update 

HL7_26_QBP_Z97 

Dispense History 

HL7_26_NMD_N02 

NMD/ACK - Application management data message (unsolicited) 

HL7_26_SIU_S16 

SIU/ACK - Notification of appointment discontinuation 

HL7_26_QBP_Q25 

QBP - Personnel Information by Segment Query 

HL7_26_QBP_Z95 

Tabular Dispense History 

HL7_26_SRR_S11 

SRM/SRR - Request deletion of service/resource on appointment 

HL7_26_MFN_M08 

MFN/MFK - Test/observation (numeric) master file 

HL7_26_QRY_Q27 

RAR - Pharmacy/treatment administration information 

HL7_26_QBP_Znn 

null 

HL7_26_ADT_A14 

ADT/ACK - Pending admit 

HL7_26_MFK_M02 

MFN/MFK - Master file - staff practitioner 

HL7_26_MFN_M17 

DRG Master File Message 

HL7_26_MFK_M09 

MFN/MFK - Test/observation (categorical) master file 

HL7_26_LSU_U12 

LSU/ACK - Automated equipment log/service update 

HL7_26_QRY_Q28 

RDR - Pharmacy/treatment dispense information 

HL7_26_RSP_Z90 

Lab Results History (Response) 

HL7_26_CSU_C09 

CSU - Automated time intervals for reporting, like monthly 

HL7_26_BTS_O31 

BTS - Blood product transfusion/disposition 

HL7_26_RQI_I01 

RQI/RPI - Request for insurance information 

HL7_26_VXQ_V01 

VXQ - Query for vaccination record 

HL7_26_ADT_A40 

ADT/ACK - Merge patient - patient identifier list 

HL7_26_DOC_T12 

QRY/DOC - Document query 

HL7_26_BAR_P06 

BAR/ACK - End account 

HL7_26_EHC_E02 

Cancel HealthCare Services Invoice 

HL7_26_RQI_I03 

RQI/RPR - Request/receipt of patient selection list 

HL7_26_ADT_A13 

ADT/ACK - Cancel discharge/end visit 

HL7_26_STI_S30 

STI/STS - Request item 

HL7_26_OML_O35 

OML - Laboratory order for multiple orders related to a single container 

HL7_26_PGL_PC7 

PGL - PC/ goal update 

HL7_26_ESU_U01 

ESU/ACK - Automated equipment status update 

HL7_26_PPR_PC3 

PPR - PC/ problem delete 

HL7_26_RPA_I08 

RQA/RPA - Request for treatment authorization information 

HL7_26_QCN_J01 

QCN/ACK - Cancel query/acknowledge message 

HL7_26_SQR_S25 

SQM/SQR - Schedule query message and response 

HL7_26_SIU_S21 

SIU/ACK - Notification of discontinuation of service/resource on appointment 

HL7_26_ADT_A62 

ADT/ACK - Cancel change consulting doctor 

HL7_26_OUL_R22 

OUL - Unsolicited Specimen Oriented Observation Message 

HL7_26_SLR_S28 

SLR/SLS - Request new sterilization lot 

HL7_26_ADT_A18 

ADT/ACK - Merge patient information (for backward compatibility only) 

HL7_26_QBP_Z87 

Dispense Information 

HL7_26_ORU_R31 

ORU - Unsolicited New Point-Of-Care Observation Message - Search For An Order 

HL7_26_QBP_Z85 

Pharmacy Information Comprehensive 

HL7_26_SRM_S01 

SRM/SRR - Request new appointment booking 

HL7_26_SRM_S08 

SRM/SRR - Request modification of service/resource on appointment 

HL7_26_RTB_Z96 

Tabular Dispense History (Response) 

HL7_26_QRY_PCK 

QRY - PC/ pathway (goal-oriented) query 

HL7_26_SLR_S29 

SLR/SLS - Request Sterilization lot deletion 

HL7_26_RQA_I08 

RQA/RPA - Request for treatment authorization information 

HL7_26_OMP_O09 

OMP - Pharmacy/treatment order 

HL7_26_ORL_O22 

ORL - General laboratory order response message to any OML 

HL7_26_MFN_M15 

MFN/MFK - Inventory item master file notification 

HL7_26_SRM_S10 

SRM/SRR - Request discontinuation of service/resource on appointment 

HL7_26_PPP_PCC 

PPP - PC/ pathway (problem-oriented) update 

HL7_26_EHC_E01 

Submit HealthCare Services Invoice 

HL7_26_RQI_I02 

RQI/RPL - Request/receipt of patient selection display list 

HL7_26_CSU_C10 

CSU - Patient completes the clinical trial 

HL7_26_QBP_Z99 

Who Am I 

HL7_26_TCU_U10 

TCU/ACK - Automated equipment test code settings update 

HL7_26_RPA_I10 

RQA/RPA - Request for re-submission of an authorization 

HL7_26_PMU_B01 

PMU/ACK - Add personnel record 

HL7_26_RQC_I06 

RQC/RCL - Request/receipt of clinical data listing 

HL7_26_SRR_S09 

SRM/SRR - Request cancellation of service/resource on appointment 

HL7_26_QRY_T12 

QRY/DOC - Document query 

HL7_26_SDR_S31 

SDR/SDS - Request anti-microbial device data 

HL7_26_MFK_M06 

MFN/MFK - Clinical study with phases and schedules master file 

HL7_26_SRM_S02 

SRM/SRR - Request appointment rescheduling 

HL7_26_SQM_S25 

SQM/SQR - Schedule query message and response 

HL7_26_PPV_PCA 

PPV - PC/ goal response 

HL7_26_ADT_A27 

ADT/ACK - Cancel pending admit 

HL7_26_RRI_I12 

REF/RRI - Patient referral 

HL7_26_RDY_K15 

RDY - Display response in response to QBP^Q15 

HL7_26_ADT_A33 

ADT/ACK - Cancel patient departing - tracking 

HL7_26_RQC_I05 

RQC/RCI - Request for patient clinical information 

HL7_26_ADT_A51 

ADT/ACK - Change alternate visit ID 

HL7_26_STC_S33 

STC/ACK - Notification of sterilization configuration 

HL7_26_MDM_T01 

MDM/ACK - Original document notification 

HL7_26_QSB_Q16 

QSB - Create subscription 

HL7_26_BRP_O30 

BRP - Blood product dispense status acknowledgment 

HL7_26_LSR_U13 

LSR/ACK - Automated equipment log/service request 

HL7_26_CRM_C04 

CRM - Patient has gone off a clinical trial 

HL7_26_RDY_Z98 

Dispense History (Response) 

HL7_26_OMG_O19 

OMG - General clinical order 

HL7_26_ADT_A29 

ADT/ACK - Delete person information 

HL7_26_ADT_A32 

ADT/ACK - Cancel patient arriving - tracking 

HL7_26_QBP_Z73 

Information about Phone Calls 

HL7_26_PMU_B06 

PMU/ACK - Terminate practicing person 

HL7_26_MFN_M03 

MFN/MFK - Master file - test/observation (for backward compatibility only) 

HL7_26_ORM_O01 

ORM - Order message (also RDE, RDS, RGV, RAS) 

HL7_26_RTB_Z74 

Information about Phone Calls (Response) 

HL7_26_QRY_Q30 

RGR - Pharmacy/treatment dose information 

HL7_26_PGL_PC6 

PGL - PC/ goal add 

HL7_26_OMD_O03 

OMD - Diet order 

HL7_26_ADT_A17 

ADT/ACK - Swap patients 

HL7_26_BAR_P02 

BAR/ACK - Purge patient accounts 

HL7_26_MFK_M16 

MFN/MFK - Master File Notification Inventory Item Enhanced 

HL7_26_ADT_A28 

ADT/ACK - Add person information 

HL7_26_ADT_A02 

ADT/ACK - Transfer a patient 

HL7_26_MDM_T07 

MDM/ACK - Document edit notification 

HL7_26_ADT_A47 

ADT/ACK - Change patient identifier list 

HL7_26_QBP_Z75 

Tabular Patient List 

HL7_26_NMR_N01 

NMQ/NMR - Application management query message 

HL7_26_SRM_S11 

SRM/SRR - Request deletion of service/resource on appointment 

HL7_26_QBP_Z77 

Tabular Patient List 

HL7_26_SIU_S26 

SIU/ACK Notification that patient did not show up for schedule appointment 

HL7_26_MFK_M01 

MFN/MFK - Master file not otherwise specified (for backward compatibility only) 

HL7_26_ADT_A10 

ADT/ACK - Patient arriving - tracking 

HL7_26_PPG_PCG 

PPG - PC/ pathway (goal-oriented) add 

HL7_26_ADT_A44 

ADT/ACK - Move account information - patient account number 

HL7_26_QRY_PC4 

QRY - PC/ problem query 

HL7_26_SMD_S32 

SMD/SMS - Request anti-microbial device cycle data 

HL7_26_ADT_A11 

ADT/ACK - Cancel admit/visit notification 

HL7_26_ADT_A20 

ADT/ACK - Bed status update 

HL7_26_CRM_C06 

CRM - Cancel patient entering a phase (clerical mistake) 

HL7_26_SRR_S01 

SRM/SRR - Request new appointment booking 

HL7_26_ORP_O10 

ORP - Pharmacy/treatment order acknowledgment 

HL7_26_ORF_R04 

ORF - Response to query; transmission of requested observation 

HL7_26_QSB_Z83 

ORU Subscription 

HL7_26_RPI_I01 

RQI/RPI - Request for insurance information 

HL7_26_SIU_S19 

SIU/ACK - Notification of modification of service/resource on appointment 

HL7_26_ORS_O06 

ORS - Stock requisition acknowledgment 

HL7_26_QBP_Z79 

Dispense Information 

HL7_26_ADT_A25 

ADT/ACK - Cancel pending discharge 

HL7_26_MDM_T02 

MDM/ACK - Original document notification and content 

HL7_26_QVR_Q17 

QVR - Query for previous events 

HL7_26_RSP_K11 

RSP - Segment pattern response in response to QBP^Q11 

HL7_26_OPL_O37 

OPL - Population/Location-Based Laboratory Order Message 

HL7_26_QBP_Q31 

QBP Query Dispense history 

HL7_26_SIU_S20 

SIU/ACK - Notification of cancellation of service/resource on appointment 

HL7_26_MFK_M03 

MFN/MFK - Master file - test/observation (for backward compatibility only) 

HL7_26_QRY_PC9 

QRY - PC/ goal query 

HL7_26_SIU_S23 

SIU/ACK - Notification of blocked schedule time slot(s) 

HL7_26_PPP_PCD 

PPP - PC/ pathway (problem-oriented) delete 

HL7_26_PPR_PC1 

PPR - PC/ problem add 

HL7_26_QBP_Q23 

QBP - Get corresponding identifiers 

HL7_26_RRG_O16 

RRG - Pharmacy/treatment give acknowledgment 

HL7_26_RCI_I05 

RQC/RCI - Request for patient clinical information 

HL7_26_EHC_E04 

Re-Assess HealthCare Services Invoice Request 

HL7_26_ADR_A19 

QRY/ADR - Patient query 

HL7_26_SUR_P09 

SUR - Summary product experience report 

HL7_26_QBP_Q22 

QBP - Find candidates 

HL7_26_SRM_S03 

SRM/SRR - Request appointment modification 

HL7_26_CRM_C01 

CRM - Register a patient on a clinical trial 

HL7_26_MFK_M11 

MFN/MFK - Test/calculated observations master file 

HL7_26_SRR_S06 

SRM/SRR - Request appointment deletion 

HL7_26_ADT_A31 

ADT/ACK - Update person information 

HL7_26_QBP_Q11 

QBP - Query by parameter requesting an RSP segment pattern response 

HL7_26_CRM_C07 

CRM - Correct/update phase information 

HL7_26_ORB_O28 

ORB - Blood product order acknowledgment 

HL7_26_SRR_S02 

SRM/SRR - Request appointment rescheduling 

HL7_26_PPG_PCJ 

PPG - PC/ pathway (goal-oriented) delete 

HL7_26_ADT_A61 

ADT/ACK - Change consulting doctor 

HL7_26_SLN_S34 

SLN/ACK - Notification of sterilization lot 

HL7_26_OSR_Q06 

OSQ/OSR - Query for order status 

HL7_26_MFN_M09 

MFN/MFK - Test/observation (categorical) master file 

HL7_26_MDM_T05 

MDM/ACK - Document addendum notification 

HL7_26_OSQ_Q06 

OSQ/OSR - Query for order status 

HL7_26_ADT_A36 

ADT/ACK - Merge patient information - patient ID and account number (for backwards) 

HL7_26_MFN_M12 

MFN/MFK - Master file notification message 

HL7_26_RER_RER 

Pharmacy/Treatment Encoded Order Information 

HL7_26_SDN_S36 

SDN/ACK - Notification of anti-microbial device data 

HL7_26_PTR_PCF 

PTR - PC/ pathway (problem-oriented) query response 

HL7_26_QRY_R02 

QRY - Query for results of observation 

HL7_26_ORD_O04 

ORD - Diet order acknowledgment 

HL7_26_ORG_O20 

ORG/ORL - General clinical order response 

HL7_26_MFN_M07 

MFN/MFK - Clinical study without phases but with schedules master file 

HL7_26_RSP_K23 

RSP - Get corresponding identifiers response 

HL7_26_ADT_A09 

ADT/ACK - Patient departing - tracking 

HL7_26_EHC_E10 

Edit/Adjudication Results 

HL7_26_RAS_O17 

RAS - Pharmacy/treatment administration 

HL7_26_ADT_A49 

ADT/ACK - Change patient account number 

HL7_26_EHC_E24 

Authorization Response 

HL7_26_RSP_Z84 

Who Am I (Response) 

HL7_26_ADT_A07 

ADT/ACK - Change an inpatient to an outpatient 

HL7_26_OUL_R21 

OUL - Unsolicited laboratory observation 

HL7_26_QRY_PCE 

QRY - PC/ pathway (problem-oriented) query 

HL7_26_REF_I12 

REF/RRI - Patient referral 

HL7_26_SRM_S09 

SRM/SRR - Request cancellation of service/resource on appointment 

HL7_26_EHC_E12 

Request Additional Information 

HL7_26_SRM_S07 

SRM/SRR - Request addition of service/resource on appointment 

HL7_26_BAR_P05 

BAR/ACK - Update account 

HL7_26_SIU_S12 

SIU/ACK - Notification of new appointment booking 

HL7_26_BAR_P12 

BAR/ACK - Update Diagnosis/Procedure 

HL7_26_MFN_M16 

MFN/MFK - Master File Notification Inventory Item Enhanced 

HL7_26_QBP_Z89 

Lab Results History 

HL7_26_QRY_A19 

QRY/ADR - Patient query 

HL7_26_ORR_O02 

ORR - Order response (also RRE, RRD, RRG, RRA) 

HL7_26_ADT_A21 

ADT/ACK - Patient goes on a "leave of absence" 

HL7 Version 2.5.1 Message Library Structure

The following table describes the HL7 Version 2.5.1 Message Library.

HL7 2.5.1. Segment 

HL7 Description 

HL7_251_ABS 

Abstract 

HL7_251_ACC 

Accident 

HL7_251_ACK 

General Acknowledgment Message 

HL7_251_ADR_A19 

QRY/ADR - Patient query 

HL7_251_ADT_A01 

ADT/ACK - Admit/visit notification 

HL7_251_ADT_A02 

ADT/ACK - Transfer a patient 

HL7_251_ADT_A03 

ADT/ACK - Discharge/end visit 

HL7_251_ADT_A04 

ADT/ACK - Register a patient 

HL7_251_ADT_A05 

ADT/ACK - Pre-admit a patient 

HL7_251_ADT_A06 

ADT/ACK - Change an outpatient to an inpatient 

HL7_251_ADT_A07 

ADT/ACK - Change an inpatient to an outpatient 

HL7_251_ADT_A08 

ADT/ACK - Update patient information 

HL7_251_ADT_A09 

ADT/ACK - Patient departing - tracking 

HL7_251_ADT_A10 

ADT/ACK - Patient arriving - tracking 

HL7_251_ADT_A11 

ADT/ACK - Cancel admit/visit notification 

HL7_251_ADT_A12 

ADT/ACK - Cancel transfer 

HL7_251_ADT_A13 

ADT/ACK - Cancel discharge/end visit 

HL7_251_ADT_A14 

ADT/ACK - Pending admit 

HL7_251_ADT_A15 

ADT/ACK - Pending transfer 

HL7_251_ADT_A16 

ADT/ACK - Pending discharge 

HL7_251_ADT_A17 

ADT/ACK - Swap patients 

HL7_251_ADT_A18 

ADT/ACK - Merge patient information (for backward compatibility only) 

HL7_251_ADT_A20 

ADT/ACK - Bed status update 

HL7_251_ADT_A21 

ADT/ACK - Patient goes on a leave of absence 

HL7_251_ADT_A22 

ADT/ACK - Patient returns from a leave of absence 

HL7_251_ADT_A23 

ADT/ACK - Delete a patient record 

HL7_251_ADT_A24 

ADT/ACK - Link patient information 

HL7_251_ADT_A25 

ADT/ACK - Cancel pending discharge 

HL7_251_ADT_A26 

ADT/ACK - Cancel pending transfer 

HL7_251_ADT_A27 

ADT/ACK - Cancel pending admit 

HL7_251_ADT_A28 

ADT/ACK - Add person information 

HL7_251_ADT_A29 

ADT/ACK - Delete person information 

HL7_251_ADT_A30 

ADT/ACK - Merge person information (for backward compatibility only) 

HL7_251_ADT_A31 

ADT/ACK - Update person information 

HL7_251_ADT_A32 

ADT/ACK - Cancel patient arriving - tracking 

HL7_251_ADT_A33 

ADT/ACK - Cancel patient departing - tracking 

HL7_251_ADT_A34 

ADT/ACK - Merge patient information - patient ID only (for backward compatibility 

HL7_251_ADT_A35 

ADT/ACK - Merge patient information - account number only (for backward compatibility 

HL7_251_ADT_A36 

ADT/ACK - Merge patient information - patient ID and account number (for backwards) 

HL7_251_ADT_A37 

ADT/ACK - Unlink patient information 

HL7_251_ADT_A38 

ADT/ACK - Cancel pre-admit 

HL7_251_ADT_A39 

ADT/ACK - Merge person - patient ID (for backward compatibility only) 

HL7_251_ADT_A40 

ADT/ACK - Merge patient - patient identifier list 

HL7_251_ADT_A41 

ADT/ACK - Merge account - patient account number 

HL7_251_ADT_A42 

ADT/ACK - Merge visit - visit number 

HL7_251_ADT_A43 

ADT/ACK - Move patient information - patient identifier list 

HL7_251_ADT_A44 

ADT/ACK - Move account information - patient account number 

HL7_251_ADT_A45 

ADT/ACK - Move visit information - visit number 

HL7_251_ADT_A46 

ADT/ACK - Change patient ID (for backward compatibility only) 

HL7_251_ADT_A47 

ADT/ACK - Change patient identifier list 

HL7_251_ADT_A48 

ADT/ACK - Change alternate patient ID (for backward compatibility only) 

HL7_251_ADT_A49 

ADT/ACK - Change patient account number 

HL7_251_ADT_A50 

ADT/ACK - Change visit number 

HL7_251_ADT_A51 

ADT/ACK - Change alternate visit ID 

HL7_251_ADT_A52 

ADT/ACK - Cancel leave of absence for a patient 

HL7_251_ADT_A53 

ADT/ACK - Cancel patient returns from a leave of absence 

HL7_251_ADT_A54 

ADT/ACK - Change attending doctor 

HL7_251_ADT_A55 

ADT/ACK - Cancel change attending doctor 

HL7_251_ADT_A60 

ADT/ACK - Update allergy information 

HL7_251_ADT_A61 

ADT/ACK - Change consulting doctor 

HL7_251_ADT_A62 

ADT/ACK - Cancel change consulting doctor 

HL7_251_AFF 

Professional Affiliation 

HL7_251_AIG 

Appointment Information_General Resource 

HL7_251_AIL 

Appointment Information_Location Resource 

HL7_251_AIP 

Appointment Information_Personnel Resource 

HL7_251_AIS 

Appointment Information 

HL7_251_AL1 

Patient Allergy Information 

HL7_251_APR 

Appointment Preferences 

HL7_251_ARQ 

Appointment Request 

HL7_251_AUT 

Authorization Information 

HL7_251_BAR_P01 

BAR/ACK - Add patient accounts 

HL7_251_BAR_P02 

BAR/ACK - Purge patient accounts 

HL7_251_BAR_P05 

BAR/ACK - Update account 

HL7_251_BAR_P06 

BAR/ACK - End account 

HL7_251_BAR_P10 

BAR/ACK - Transmit Ambulatory Payment Classification (APC) 

HL7_251_BAR_P12 

BAR/ACK - Update Diagnosis/Procedure 

HL7_251_BLC 

Blood Code 

HL7_251_BLG 

Billing 

HL7_251_BPO 

Blood product order 

HL7_251_BPS_O29 

BPS - Blood product dispense status 

HL7_251_BPX 

Blood Product Dispense Status 

HL7_251_BRP_O30 

BRP - Blood product dispense status acknowledgment 

HL7_251_BRT_O32 

BRT - Blood product transfusion/disposition acknowledgment 

HL7_251_BTS_O31 

BTS - Blood product transfusion/disposition 

HL7_251_BTX 

Batch Trailer 

HL7_251_CDM 

Charge Description Master 

HL7_251_CER 

Certificate Detail 

HL7_251_CM0 

Clinical Study Master 

HL7_251_CM1 

Clinical Study Phase Master 

HL7_251_CM2 

Clinical Study Schedule Master 

HL7_251_CNS 

Clear Notification 

HL7_251_CRM_C01 

CRM - Register a patient on a clinical trial 

HL7_251_CRM_C02 

CRM - Cancel a patient registration on clinical trial (for clerical mistakes online) 

HL7_251_CRM_C03 

CRM - Correct/update registration information 

HL7_251_CRM_C04 

CRM - Patient has gone off a clinical trial 

HL7_251_CRM_C05 

CRM - Patient enters phase of clinical trial 

HL7_251_CRM_C06 

CRM - Cancel patient entering a phase (clerical mistake) 

HL7_251_CRM_C07 

CRM - Correct/update phase information 

HL7_251_CRM_C08 

CRM - Patient has gone off phase of clinical trial 

HL7_251_CSP 

Clinical Study Phase 

HL7_251_CSR 

Clinical Study Registration 

HL7_251_CSS 

Clinical Study Data Schedule Segment 

HL7_251_CSU_C09 

CSU - Automated time intervals for reporting, like monthly 

HL7_251_CSU_C10 

CSU - Patient completes the clinical trial 

HL7_251_CSU_C11 

CSU - Patient completes a phase of the clinical trial 

HL7_251_CSU_C12 

CSU - Update/correction of patient order/result information 

HL7_251_CTD 

Contact Data 

HL7_251_CTI 

Clinical Trial Identification 

HL7_251_DB1 

Disability 

HL7_251_DFT_P03 

DFT/ACK - Post detail financial transaction 

HL7_251_DFT_P11 

DFT/ACK - Post Detail Financial Transactions - New 

HL7_251_DG1 

Diagnosis 

HL7_251_DOC_T12 

QRY/DOC - Document query 

HL7_251_DRG 

Diagnosis Related Group 

HL7_251_DSC 

Continuation Pointer 

HL7_251_DSP 

Display Data 

HL7_251_EAC_U07 

EAC/ACK - Automated equipment command 

HL7_251_EAN_U09 

EAN/ACK - Automated equipment notification 

HL7_251_EAR_U08 

EAR/ACK - Automated equipment response 

HL7_251_ECD 

Equipment Command 

HL7_251_ECR 

Equipment Command Response 

HL7_251_EDU 

Educational Detail 

HL7_251_EQP 

Equipment/log Service 

HL7_251_EQU 

Equipment Detail 

HL7_251_ERR 

Error 

HL7_251_ESR_U02 

ESR/ACK - Automated equipment status request 

HL7_251_ESU_U01 

ESU/ACK - Automated equipment status update 

HL7_251_EVN 

Event Type 

HL7_251_FAC 

HL7_251_FT1 

Financial Transaction 

HL7_251_GOL 

Goal Detail 

HL7_251_GP1 

Grouping/Reimbursement - Visit 

HL7_251_GP2 

Grouping/Reimbursement - Procedure Line Item 

HL7_251_GT1 

Guarantor 

HL7_251_IAM 

Patient Adverse Reaction Information 

HL7_251_IIM 

Inventory Item Master 

HL7_251_IN1 

Insurance 

HL7_251_IN2 

Insurance Additional Information 

HL7_251_IN3 

Insurance Additional Information, Certification 

HL7_251_INR_U06 

INR/ACK - Automated equipment inventory request 

HL7_251_INU_U05 

INU/ACK - Automated equipment inventory update 

HL7_251_INV 

Inventory Detail 

HL7_251_IPC 

Imaging Procedure Control Segment 

HL7_251_ISD 

Interaction Status Detail 

HL7_251_LAN 

Language Detail 

HL7_251_LCC 

Location Charge Code 

HL7_251_LCH 

Location Characteristic 

HL7_251_LDP 

Location Department 

HL7_251_LOC 

Location Identification 

HL7_251_LRL 

Location Relationship 

HL7_251_LSR_U13 

LSR/ACK - Automated equipment log/service request 

HL7_251_LSU_U12 

LSU/ACK - Automated equipment log/service update 

HL7_251_MDM_T01 

MDM/ACK - Original document notification 

HL7_251_MDM_T02 

MDM/ACK - Original document notification and content 

HL7_251_MDM_T03 

MDM/ACK - Document status change notification 

HL7_251_MDM_T04 

MDM/ACK - Document status change notification and content 

HL7_251_MDM_T05 

MDM/ACK - Document addendum notification 

HL7_251_MDM_T06 

MDM/ACK - Document addendum notification and content 

HL7_251_MDM_T07 

MDM/ACK - Document edit notification 

HL7_251_MDM_T08 

MDM/ACK - Document edit notification and content 

HL7_251_MDM_T09 

MDM/ACK - Document replacement notification 

HL7_251_MDM_T10 

MDM/ACK - Document replacement notification and content 

HL7_251_MDM_T11 

MDM/ACK - Document cancel notification 

HL7_251_MFA 

Master File Acknowledgment 

HL7_251_MFE 

Master File Entry 

HL7_251_MFI 

Master File Identification 

HL7_251_MFK_M01 

MFN/MFK - Master file not otherwise specified (for backward compatibility only) 

HL7_251_MFK_M02 

MFN/MFK - Master file - staff practitioner 

HL7_251_MFK_M03 

MFN/MFK - Master file - test/observation (for backward compatibility only) 

HL7_251_MFK_M04 

MFN/MFK - Master files charge description 

HL7_251_MFK_M05 

MFN/MFK - Patient location master file 

HL7_251_MFK_M06 

MFN/MFK - Clinical study with phases and schedules master file 

HL7_251_MFK_M07 

MFN/MFK - Clinical study without phases but with schedules master file 

HL7_251_MFK_M08 

MFN/MFK - Test/observation (numeric) master file 

HL7_251_MFK_M09 

MFN/MFK - Test/observation (categorical) master file 

HL7_251_MFK_M10 

MFN/MFK - Test /observation batteries master file 

HL7_251_MFK_M11 

MFN/MFK - Test/calculated observations master file 

HL7_251_MFK_M12 

MFN/MFK - Master file notification message 

HL7_251_MFK_M13 

MFN/MFK - Master file notification - general 

HL7_251_MFK_M14 

MFN/MFK - Master file notification - site defined 

HL7_251_MFK_M15 

MFN/MFK - Inventory item master file notification 

HL7_251_MFN_M01 

MFN/MFK - Master file not otherwise specified (for backward compatibility only) 

HL7_251_MFN_M02 

MFN/MFK - Master file - staff practitioner 

HL7_251_MFN_M03 

MFN/MFK - Master file - test/observation (for backward compatibility only) 

HL7_251_MFN_M04 

MFN/MFK - Master files charge description 

HL7_251_MFN_M05 

MFN/MFK - Patient location master file 

HL7_251_MFN_M06 

MFN/MFK - Clinical study with phases and schedules master file 

HL7_251_MFN_M07 

MFN/MFK - Clinical study without phases but with schedules master file 

HL7_251_MFN_M08 

MFN/MFK - Test/observation (numeric) master file 

HL7_251_MFN_M09 

MFN/MFK - Test/observation (categorical) master file 

HL7_251_MFN_M10 

MFN/MFK - Test /observation batteries master file 

HL7_251_MFN_M11 

MFN/MFK - Test/calculated observations master file 

HL7_251_MFN_M12 

MFN/MFK - Master file notification message 

HL7_251_MFN_M13 

MFN/MFK - Master file notification - general 

HL7_251_MFN_M14 

MFN/MFK - Master file notification - site defined 

HL7_251_MFN_M15 

MFN/MFK - Inventory item master file notification 

HL7_251_MFQ_M01 

MFN/MFK - Master file not otherwise specified (for backward compatibility only) 

HL7_251_MFQ_M02 

MFN/MFK - Master file - staff practitioner 

HL7_251_MFQ_M03 

MFN/MFK - Master file - test/observation (for backward compatibility only) 

HL7_251_MFQ_M04 

MFN/MFK - Master files charge description 

HL7_251_MFQ_M05 

MFN/MFK - Patient location master file 

HL7_251_MFQ_M06 

MFN/MFK - Clinical study with phases and schedules master file 

HL7_251_MFQ_M07 

MFN/MFK - Clinical study without phases but with schedules master file 

HL7_251_MFQ_M08 

MFN/MFK - Test/observation (numeric) master file 

HL7_251_MFQ_M09 

MFN/MFK - Test/observation (categorical) master file 

HL7_251_MFQ_M10 

MFN/MFK - Test /observation batteries master file 

HL7_251_MFQ_M11 

MFN/MFK - Test/calculated observations master file 

HL7_251_MFQ_M12 

MFN/MFK - Master file notification message 

HL7_251_MFQ_M13 

MFN/MFK - Master file notification - general 

HL7_251_MFQ_M14 

MFN/MFK - Master file notification - site defined 

HL7_251_MFR_M01 

MFN/MFK - Master file not otherwise specified (for backward compatibility only) 

HL7_251_MFR_M02 

MFN/MFK - Master file - staff practitioner 

HL7_251_MFR_M03 

MFN/MFK - Master file - test/observation (for backward compatibility only) 

HL7_251_MFR_M04 

MFN/MFK - Master files charge description 

HL7_251_MFR_M05 

MFN/MFK - Patient location master file 

HL7_251_MFR_M06 

MFN/MFK - Clinical study with phases and schedules master file 

HL7_251_MFR_M07 

MFN/MFK - Clinical study without phases but with schedules master file 

HL7_251_MFR_M08 

MFN/MFK - Test/observation (numeric) master file 

HL7_251_MFR_M09 

MFN/MFK - Test/observation (categorical) master file 

HL7_251_MFR_M10 

MFN/MFK - Test /observation batteries master file 

HL7_251_MFR_M11 

MFN/MFK - Test/calculated observations master file 

HL7_251_MFR_M12 

MFN/MFK - Master file notification message 

HL7_251_MFR_M13 

MFN/MFK - Master file notification - general 

HL7_251_MFR_M14 

MFN/MFK - Master file notification - site defined 

HL7_251_MRG 

Merge Patient Information 

HL7_251_MSA 

Message Acknowledgment 

HL7_251_MSH 

Message Header 

HL7_251_NCK 

System Clock 

HL7_251_NDS 

Notification Detail 

HL7_251_NK1 

Next of Kin/Associated Parties 

HL7_251_NMD_N02 

NMD/ACK - Application management data message (unsolicited) 

HL7_251_NMQ_N01 

NMQ/NMR - Application management query message 

HL7_251_NMR_N01 

NMQ/NMR - Application management query message 

HL7_251_NPU 

Bed Status Update 

HL7_251_NSC 

Application Status Update 

HL7_251_NST 

Application Control Level Statistics 

HL7_251_NTE 

Notes and Comments 

HL7_251_OBR 

Observation Request 

HL7_251_OBX 

Observation Result 

HL7_251_ODS 

Dietary Orders, Supplements, and Preferences 

HL7_251_ODT 

Diet Tray Instructions 

HL7_251_OM1 

General Segment 

HL7_251_OM2 

Numeric Observation 

HL7_251_OM3 

Categorical Service/Test/Observation 

HL7_251_OM4 

Observations that Require Specimens 

HL7_251_OM5 

Observation Batteries (Sets) 

HL7_251_OM6 

Observations that are Calculated from Other Observations 

HL7_251_OM7 

Additional Basic Attributes 

HL7_251_OMB_O27 

OMB - Blood product order 

HL7_251_OMD_O03 

OMD - Diet order 

HL7_251_OMG_O19 

OMG - General clinical order 

HL7_251_OMI_O23 

OMI - Imaging order 

HL7_251_OML_O21 

OML - Laboratory order 

HL7_251_OML_O33 

OML - Laboratory order for multiple orders related to a single specimen 

HL7_251_OML_O35 

OML - Laboratory order for multiple orders related to a single container of a species 

HL7_251_OMN_O07 

OMN - Non-stock requisition order 

HL7_251_OMP_O09 

OMP - Pharmacy/treatment order 

HL7_251_OMS_O05 

OMS - Stock requisition order 

HL7_251_ORB_O28 

ORB - Blood product order acknowledgment 

HL7_251_ORC 

Common Order 

HL7_251_ORD_O04 

ORD - Diet order acknowledgment 

HL7_251_ORF_R04 

ORF - Response to query; transmission of requested observation 

HL7_251_ORG 

General Clinical Order Acknowledgment Message 

HL7_251_ORG_O20 

ORG/ORL - General clinical order response 

HL7_251_ORI_O24 

ORI - Imaging order response message to any OMI 

HL7_251_ORL_O22 

ORL - General laboratory order response message to any OML 

HL7_251_ORL_O34 

ORL - Laboratory order response message to a multiple order related to single species 

HL7_251_ORL_O36 

ORL - Laboratory order response message to a single container of a specimen OML 

HL7_251_ORM_O01 

ORM - Order message (also RDE, RDS, RGV, RAS) 

HL7_251_ORN_O08 

ORN - Non-stock requisition acknowledgment 

HL7_251_ORP_O10 

ORP - Pharmacy/treatment order acknowledgment 

HL7_251_ORR_O02 

ORR - Order response (also RRE, RRD, RRG, RRA) 

HL7_251_ORS_O06 

ORS - Stock requisition acknowledgment 

HL7_251_ORU_R01 

ORU/ACK - Unsolicited transmission of an observation message 

HL7_251_ORU_R30 

ORU - Unsolicited Point-Of-Care Observation Message Without Existing Order 

HL7_251_ORU_R31 

ORU - Unsolicited New Point-Of-Care Observation Message - Search For An Order 

HL7_251_ORU_R32 

ORU - Unsolicited Pre-Ordered Point-Of-Care Observation 

HL7_251_OSQ_Q06 

OSQ/OSR - Query for order status 

HL7_251_OSR_Q06 

OSQ/OSR - Query for order status 

HL7_251_OUL_R21 

OUL - Unsolicited laboratory observation 

HL7_251_OUL_R22 

OUL - Unsolicited Specimen Oriented Observation Message 

HL7_251_OUL_R23 

OUL - Unsolicited Specimen Container Oriented Observation Message 

HL7_251_OUL_R24 

OUL - Unsolicited Order Oriented Observation Message 

HL7_251_PCR 

Possible Causal Relationship 

HL7_251_PD1 

Patient Additional Demographic 

HL7_251_PDA 

Patient Death and Autopsy 

HL7_251_PDC 

HL7_251_PEO 

Product Experience Observation 

HL7_251_PES 

Product Experience Sender 

HL7_251_PEX_P07 

PEX - Unsolicited initial individual product experience report 

HL7_251_PEX_P08 

PEX - Unsolicited update individual product experience report 

HL7_251_PGL_PC6 

PGL - PC/ goal address 

HL7_251_PGL_PC7 

PGL - PC/ goal update 

HL7_251_PGL_PC8 

PGL - PC/ goal delete 

HL7_251_PID 

Patient Identification 

HL7_251_PIN_I07 

PIN/ACK - Unsolicited insurance information 

HL7_251_PMU_B01 

PMU/ACK - Add personnel record 

HL7_251_PMU_B02 

PMU/ACK - Update personnel record 

HL7_251_PMU_B03 

PMU/ACK - Delete personnel record 

HL7_251_PMU_B04 

PMU/ACK - Active practicing person 

HL7_251_PMU_B05 

PMU/ACK - Deactivate practicing person 

HL7_251_PMU_B06 

PMU/ACK - Terminate practicing person 

HL7_251_PMU_B07 

PMU/ACK - Grant Certificate/Permission 

HL7_251_PMU_B08 

PMU/ACK - Revoke Certificate/Permission 

HL7_251_PPG_PCG 

PPG - PC/ pathway (goal-oriented) address 

HL7_251_PPG_PCH 

PPG - PC/ pathway (goal-oriented) update 

HL7_251_PPG_PCJ 

PPG - PC/ pathway (goal-oriented) delete 

HL7_251_PPP_PCB 

PPP - PC/ pathway (problem-oriented) address 

HL7_251_PPP_PCC 

PPP - PC/ pathway (problem-oriented) update 

HL7_251_PPP_PCD 

PPP - PC/ pathway (problem-oriented) delete 

HL7_251_PPR_PC1 

PPR - PC/ problem address 

HL7_251_PPR_PC2 

PPR - PC/ problem update 

HL7_251_PPR_PC3 

PPR - PC/ problem delete 

HL7_251_PPT_PCL 

PPT - PC/ pathway (goal-oriented) query response 

HL7_251_PPV_PCA 

PPV - PC/ goal response 

HL7_251_PR1 

Procedures 

HL7_251_PRA 

Practitioner Detail 

HL7_251_PRB 

Problem Details 

HL7_251_PRC 

Pricing 

HL7_251_PRD 

Provider Data 

HL7_251_PRR_PC5 

PRR - PC/ problem response 

HL7_251_PTH 

Pathway 

HL7_251_PTR_PCF 

PTR - PC/ pathway (problem-oriented) query response 

HL7_251_PV1 

Patient Visit 

HL7_251_PV2 

Patient Visit - Additional Information 

HL7_251_QAK 

Query Acknowledgment 

HL7_251_QBP_Q11 

QBP - Query by parameter requesting an RSP segment pattern response 

HL7_251_QBP_Q13 

QBP - Query by parameter requesting an RTB - tabular response 

HL7_251_QBP_Q15 

QBP - Query by parameter requesting an RDY display response 

HL7_251_QBP_Q21 

QBP - Get person demographics 

HL7_251_QBP_Q22 

QBP - Find candidates 

HL7_251_QBP_Q23 

QBP - Get corresponding identifiers 

HL7_251_QBP_Q24 

QBP - Allocate identifiers 

HL7_251_QBP_Q25 

QBP - Personnel Information by Segment Query 

HL7_251_QBP_Q31 

DBP - Dispense History 

HL7_251_QBP_Z73 

Information about Phone Calls 

HL7_251_QBP_Z75 

Tabular Patient List 

HL7_251_QBP_Z77 

Tabular Patient List 

HL7_251_QBP_Z79 

Dispense Information 

HL7_251_QBP_Z81 

Dispense History 

HL7_251_QBP_Z85 

Pharmacy Information Comprehensive 

HL7_251_QBP_Z87 

Dispense Information 

HL7_251_QBP_Z89 

Lab Results History 

HL7_251_QBP_Z91 

Who Am I 

HL7_251_QBP_Z93 

Tabular Dispense History 

HL7_251_QBP_Z95 

Tabular Dispense History 

HL7_251_QBP_Z97 

Dispense History 

HL7_251_QBP_Z99 

Who Am I 

HL7_251_QCN_J01 

QCN/ACK - Cancel query/acknowledge message 

HL7_251_QID 

Query Identification 

HL7_251_QPD 

Query Parameter Definition 

HL7_251_QRD 

Original-Style Query Definition 

HL7_251_QRF 

Original style query filter 

HL7_251_QRI 

Query Response Instance 

HL7_251_QRY_A19 

QRY/ADR - Patient query 

HL7_251_QRY_PC4 

QRY - PC/ problem query 

HL7_251_QRY_PC9 

QRY - PC/ goal query 

HL7_251_QRY_PCE 

QRY - PC/ pathway (problem-oriented) query 

HL7_251_QRY_PCK 

QRY - PC/ pathway (goal-oriented) query 

HL7_251_QRY_Q26 

ROR - Pharmacy/treatment order response 

HL7_251_QRY_Q27 

RAR - Pharmacy/treatment administration information 

HL7_251_QRY_Q28 

RDR - Pharmacy/treatment dispense information 

HL7_251_QRY_Q29 

RER - Pharmacy/treatment encoded order information 

HL7_251_QRY_Q30 

RGR - Pharmacy/treatment dose information 

HL7_251_QRY_R02 

QRY - Query for results of observation 

HL7_251_QRY_T12 

QRY/DOC - Document query 

HL7_251_QSB_Q16 

QSB - Create subscription 

HL7_251_QSB_Z83 

ORU Subscription 

HL7_251_QSX_J02 

QSX/ACK - Cancel subscription/acknowledge message 

HL7_251_QVR_Q17 

QVR - Query for previous events 

HL7_251_RAR_RAR 

Pharmacy/Treatment Administration Information 

HL7_251_RAS_O17 

RAS - Pharmacy/treatment administration 

HL7_251_RCI_I05 

RQC/RCI - Request for patient clinical information 

HL7_251_RCL_I06 

RQC/RCL - Request/receipt of clinical data listing 

HL7_251_RCP 

Response Control Parameter 

HL7_251_RDE_O11 

RDE - Pharmacy/treatment encoded order 

HL7_251_RDE_O25 

RDE - Pharmacy/treatment refill authorization request 

HL7_251_RDF 

Table Row Definition 

HL7_251_RDR_RDR 

Pharmacy/treatment Dispense Information 

HL7_251_RDS_O13 

RDS - Pharmacy/treatment dispense 

HL7_251_RDT 

Table Row Data 

HL7_251_RDY_K15 

RDY - Display response in response to QBP^Q15 

HL7_251_RDY_Z80 

Dispense Information (Response) 

HL7_251_RDY_Z98 

Dispense History (Response) 

HL7_251_REF_I12 

REF/RRI - Patient referral 

HL7_251_REF_I13 

REF/RRI - Modify patient referral 

HL7_251_REF_I14 

REF/RRI - Cancel patient referral 

HL7_251_REF_I15 

REF/RRI - Request patient referral status 

HL7_251_RER_RER 

Pharmacy/Treatment Encoded Order Information 

HL7_251_RF1 

Referral Information 

HL7_251_RGR_RGR 

Pharmacy/Treatment Dose Information 

HL7_251_RGS 

Resource Group 

HL7_251_RGV_O15 

RGV - Pharmacy/treatment given 

HL7_251_RMI 

Risk Management Incident 

HL7_251_ROL 

Role 

HL7_251_ROR_ROR 

ROR - Pharmacy prescription order query response 

HL7_251_RPA_I08 

RQA/RPA - Request for treatment authorization information 

HL7_251_RPA_I09 

RQA/RPA - Request for modification to an authorization 

HL7_251_RPA_I10 

RQA/RPA - Request for re-submission of an authorization 

HL7_251_RPA_I11 

RQA/RPA - Request for cancellation of an authorization 

HL7_251_RPI_I01 

RQI/RPI - Request for insurance information 

HL7_251_RPI_I04 

RQD/RPI - Request for patient demographic data 

HL7_251_RPL_I02 

RQI/RPL - Request/receipt of patient selection display list 

HL7_251_RPR_I03 

RQI/RPR - Request/receipt of patient selection list 

HL7_251_RQ1 

Requisition Detail-1 

HL7_251_RQA_I08 

RQA/RPA - Request for treatment authorization information 

HL7_251_RQA_I09 

RQA/RPA - Request for modification to an authorization 

HL7_251_RQA_I10 

RQA/RPA - Request for re-submission of an authorization 

HL7_251_RQA_I11 

RQA/RPA - Request for cancellation of an authorization 

HL7_251_RQC_I05 

RQC/RCI - Request for patient clinical information 

HL7_251_RQC_I06 

RQC/RCL - Request/receipt of clinical data listing 

HL7_251_RQD 

Requisition Detail 

HL7_251_RQI_I01 

RQI/RPI - Request for insurance information 

HL7_251_RQI_I02 

RQI/RPL - Request/receipt of patient selection display list 

HL7_251_RQI_I03 

RQI/RPR - Request/receipt of patient selection list 

HL7_251_RQP_I04 

RQD/RPI - Request for patient demographic data 

HL7_251_RRA_O18 

RRA - Pharmacy/treatment administration acknowledgment 

HL7_251_RRD_O14 

RRD - Pharmacy/treatment dispense acknowledgment 

HL7_251_RRE_O12 

RRE - Pharmacy/treatment encoded order acknowledgment 

HL7_251_RRE_O26 

RRE - Pharmacy/Treatment Refill Authorization Acknowledgement 

HL7_251_RRG_O16 

RRG - Pharmacy/treatment give acknowledgment 

HL7_251_RRI_I12 

REF/RRI - Patient referral 

HL7_251_RRI_I13 

REF/RRI - Modify patient referral 

HL7_251_RRI_I14 

REF/RRI - Cancel patient referral 

HL7_251_RRI_I15 

REF/RRI - Request patient referral status 

HL7_251_RSP_K11 

RSP - Segment pattern response in response to QBP^Q11 

HL7_251_RSP_K21 

RSP - Get person demographics response 

HL7_251_RSP_K22 

RSP - Find candidates response 

HL7_251_RSP_K23 

RSP - Get corresponding identifiers response 

HL7_251_RSP_K24 

RSP - Allocate identifiers response 

HL7_251_RSP_K25 

RSP - Personnel Information by Segment Response 

HL7_251_RSP_K31 

RSP - Dispense History 

HL7_251_RSP_Z82 

Dispense History (Response) 

HL7_251_RSP_Z84 

Who Am I (Response) 

HL7_251_RSP_Z86 

Pharmacy Information Comprehensive (Response) 

HL7_251_RSP_Z88 

Dispense Information (Response) 

HL7_251_RSP_Z90 

Lab Results History (Response) 

HL7_251_RTB_K13 

RTB - Tabular response in response to QBP^Q13 

HL7_251_RTB_Z74 

Information about Phone Calls (Response) 

HL7_251_RTB_Z76 

Tabular Patient List (Response) 

HL7_251_RTB_Z78 

Tabular Patient List (Response) 

HL7_251_RTB_Z92 

Who Am I (Response) 

HL7_251_RTB_Z94 

Tabular Dispense History (Response) 

HL7_251_RTB_Z96 

Tabular Dispense History (Response) 

HL7_251_RXA 

Pharmacy/Treatment Administration 

HL7_251_RXC 

Pharmacy/Treatment Component Order 

HL7_251_RXD 

Pharmacy/Treatment Dispense 

HL7_251_RXE 

Pharmacy/Treatment Encoded Order 

HL7_251_RXG 

Pharmacy/Treatment Give 

HL7_251_RXO 

Pharmacy/Treatment Order 

HL7_251_RXR 

Pharmacy/Treatment Route 

HL7_251_SAC 

Specimen Container detail 

HL7_251_SCH 

Scheduling Activity Information 

HL7_251_SFT 

Software Segment 

HL7_251_SID 

Substance Identifier 

HL7_251_SIU_S12 

SIU/ACK - Notification of new appointment booking 

HL7_251_SIU_S13 

SIU/ACK - Notification of appointment rescheduling 

HL7_251_SIU_S14 

SIU/ACK - Notification of appointment modification 

HL7_251_SIU_S15 

SIU/ACK - Notification of appointment cancellation 

HL7_251_SIU_S16 

SIU/ACK - Notification of appointment discontinuation 

HL7_251_SIU_S17 

SIU/ACK - Notification of appointment deletion 

HL7_251_SIU_S18 

SIU/ACK - Notification of addition of service/resource on appointment 

HL7_251_SIU_S19 

SIU/ACK - Notification of modification of service/resource on appointment 

HL7_251_SIU_S20 

SIU/ACK - Notification of cancellation of service/resource on appointment 

HL7_251_SIU_S21 

SIU/ACK - Notification of discontinuation of service/resource on appointment 

HL7_251_SIU_S22 

SIU/ACK - Notification of deletion of service/resource on appointment 

HL7_251_SIU_S23 

SIU/ACK - Notification of blocked schedule time slot(s) 

HL7_251_SIU_S24 

SIU/ACK - Notification of opened (“unblocked”) schedule time slot(s) 

HL7_251_SIU_S26 

SIU/ACK Notification that patient did not show up for schedule appointment 

HL7_251_SPM 

Specimen 

HL7_251_SQM_S25 

SQM/SQR - Schedule query message and response 

HL7_251_SQR_S25 

SQM/SQR - Schedule query message and response 

HL7_251_SRM_S01 

SRM/SRR - Request new appointment booking 

HL7_251_SRM_S02 

SRM/SRR - Request appointment rescheduling 

HL7_251_SRM_S03 

SRM/SRR - Request appointment modification 

HL7_251_SRM_S04 

SRM/SRR - Request appointment cancellation 

HL7_251_SRM_S05 

SRM/SRR - Request appointment discontinuation 

HL7_251_SRM_S06 

SRM/SRR - Request appointment deletion 

HL7_251_SRM_S07 

SRM/SRR - Request addition of service/resource on appointment 

HL7_251_SRM_S08 

SRM/SRR - Request modification of service/resource on appointment 

HL7_251_SRM_S09 

SRM/SRR - Request cancellation of service/resource on appointment 

HL7_251_SRM_S10 

SRM/SRR - Request discontinuation of service/resource on appointment 

HL7_251_SRM_S11 

SRM/SRR - Request deletion of service/resource on appointment 

HL7_251_SRR_S01 

SRM/SRR - Request new appointment booking 

HL7_251_SRR_S02 

SRM/SRR - Request appointment rescheduling 

HL7_251_SRR_S03 

SRM/SRR - Request appointment modification 

HL7_251_SRR_S04 

SRM/SRR - Request appointment cancellation 

HL7_251_SRR_S05 

SRM/SRR - Request appointment discontinuation 

HL7_251_SRR_S06 

SRM/SRR - Request appointment deletion 

HL7_251_SRR_S07 

SRM/SRR - Request addition of service/resource on appointment 

HL7_251_SRR_S08 

SRM/SRR - Request modification of service/resource on appointment 

HL7_251_SRR_S09 

SRM/SRR - Request cancellation of service/resource on appointment 

HL7_251_SRR_S10 

SRM/SRR - Request discontinuation of service/resource on appointment 

HL7_251_SRR_S11 

SRM/SRR - Request deletion of service/resource on appointment 

HL7_251_SSR_U04 

SSR/ACK - specimen status request 

HL7_251_SSU_U03 

SSU/ACK - Specimen status update 

HL7_251_STF 

Staff Identification - Segment 

HL7_251_SUR_P09 

SUR - Summary product experience report 

HL7_251_TCC 

Test Code Configuration - Segment 

HL7_251_TCD 

Test Code Detail 

HL7_251_TCR_U11 

TCR/ACK - Automated equipment test code settings request 

HL7_251_TCU_U10 

TCU/ACK - Automated equipment test code settings update 

HL7_251_TQ1 

HL7_251_TQ2 

Timing/Quantity Relationship 

HL7_251_TXA 

Transcription Document Header 

HL7_251_UB1 

UB82 

HL7_251_UB2 

UB92 Data 

HL7_251_VAR 

Unknown/Variance 

HL7_251_VXQ_V01 

VXQ - Query for vaccination record 

HL7_251_VXR_V03 

VXR - Vaccination record response 

HL7_251_VXU_V04 

VXU - Unsolicited vaccination record update 

HL7_251_VXX_V02 

VXX - Response to vaccination query returning multiple PID matches 

HL7 Version 2.5 Message Library Structure

The following table describes the HL7 Version 2.5 Message Library.

HL7 2.5 Segment 

HL7 Description 

HL7_25_ABS 

Abstract 

HL7_25_ACC 

Accident 

HL7_25_ACK 

General Acknowledgment Message 

HL7_25_ADR_A19 

ADT Response 

HL7_25_ADT_A01 

Admit/Visit Notification 

HL7_25_ADT_A02 

Transfer a Patient 

HL7_25_ADT_A03 

Discharge/End Visit 

HL7_25_ADT_A04 

Register a Patient 

HL7_25_ADT_A05 

Pre-Admit a Patient 

HL7_25_ADT_A06 

Change an Outpatient to an Inpatient 

HL7_25_ADT_A07 

Change an Inpatient to an Outpatient 

HL7_25_ADT_A08 

Update Patient Information 

HL7_25_ADT_A09 

Patient Departing - Tracking 

HL7_25_ADT_A10 

Patient Arriving - Tracking 

HL7_25_ADT_A11 

Cancel Admit/Visit Notification 

HL7_25_ADT_A12 

Cancel Transfer 

HL7_25_ADT_A13 

Cancel Discharge/end visit 

HL7_25_ADT_A14 

Pending Admit 

HL7_25_ADT_A15 

Pending Transfer 

HL7_25_ADT_A16 

Pending Discharge 

HL7_25_ADT_A17 

Swap Patients 

HL7_25_ADT_A18 

Merge Patient Information 

HL7_25_ADT_A20 

Bed Status Update 

HL7_25_ADT_A21 

Patient Goes on a Leave of Absence 

HL7_25_ADT_A22 

Patient Returns from a Leave of Absence 

HL7_25_ADT_A23 

Delete a Patient Record 

HL7_25_ADT_A24 

Link Patient Information 

HL7_25_ADT_A25 

Cancel Pending Discharge 

HL7_25_ADT_A26 

Cancel Pending Transfer 

HL7_25_ADT_A27 

Cancel Pending Admit 

HL7_25_ADT_A28 

Add Person or Patient Information 

HL7_25_ADT_A29 

Delete Person Information 

HL7_25_ADT_A30 

Merge Person Information 

HL7_25_ADT_A31 

Update Person Information 

HL7_25_ADT_A32 

Cancel Patient Arriving - Tracking 

HL7_25_ADT_A33 

Cancel Patient Departing - Tracking 

HL7_25_ADT_A34 

Merge Patient Information - Patient ID Only 

HL7_25_ADT_A35  

Merge Patient Information - Account Number Only 

HL7_25_ADT_A36 

Merge Patient Information - Patient ID & Account Number 

HL7_25_ADT_A37 

Unlink Patient Information 

HL7_25_ADT_A38 

Cancel Pre-Admit 

HL7_25_ADT_A39 

Merge Patient - Patient ID 

HL7_25_ADT_A40 

Merge Patient - Patient Identifier List 

HL7_25_ADT_A41 

Merge Account - Patient Account Number 

HL7_25_ADT_A42 

Merge Visit - Visit Number 

HL7_25_ADT_A43 

Move Patient Information - Patient Identifier List 

HL7_25_ADT_A44 

Move Account Information - Patient Account Number 

HL7_25_ADT_A45  

Move Visit Information - Visit Number 

HL7_25_ADT_A46 

Change Patient ID 

HL7_25_ADT_A47 

Change Patient Identifier List 

HL7_25_ADT_A48 

Change Alternate 

HL7_25_ADT_A49 

Change Patient Account Number 

HL7_25_ADT_A50 

Change Visit Number 

HL7_25_ADT_A51 

Change Alternate Visit ID 

HL7_25_ADT_A52 

Cancel Leave of Absence for a Patient 

HL7_25_ADT_A53 

Cancel Patient Returns from a Leave of Absence 

HL7_25_ADT_A54 

Change Attending Doctor 

HL7_25_ADT_A55 

Cancel Change Attending Doctor 

HL7_25_ADT_A60 

Update Adverse Reaction Information 

HL7_25_ADT_A61 

Change Consulting Doctor 

HL7_25_ADT_A62 

Cancel Change Consulting Doctor 

HL7_25_AFF 

Professional Affiliation 

HL7_25_AIG 

Appointment Information_General Resource 

HL7_25_AIL 

Appointment Information_Location Resource 

HL7_25_AIP 

Appointment Information_Personnel Resource 

HL7_25_AIS 

Appointment Information 

HL7_25_AL1 

Patient Allergy Information 

HL7_25_APR 

Appointment Preferences 

HL7_25_ARQ 

Appointment Request 

HL7_25_AUT 

Authorization Information 

HL7_25_BAR_P01 

Add Patient Account 

HL7_25_BAR_P02 

Purge Patient Accounts 

HL7_25_BAR_P05 

Update Account 

HL7_25_BAR_P06 

End Account 

HL7_25_BAR_P10  

Transmit Ambulatory Payment Classification (APC) Groups 

HL7_25_BAR_P12 

Update Diagnosis Procedure 

HL7_25_BLC 

Blood Code 

HL7_25_BLG 

Billing 

HL7_25_BPO 

Blood product order 

HL7_25_BPS_O29 

Blood Product Dispense Status Message 

HL7_25_BPX 

Blood Product Dispense Status 

HL7_25_BRP_O30 

Blood Product Dispense Status Acknowledgment 

HL7_25_BRT_O32 

Blood Product Transfusion/Disposition Acknowledgement 

HL7_25_BTS_O31 

Blood Product Transfusion/Disposition Message 

HL7_25_BTX 

Batch Trailer 

HL7_25_CDM 

Charge Description Master 

HL7_25_CER 

Certificate Detail 

HL7_25_CMO 

Clinical Study Master 

HL7_25_CM1 

Clinical Study Phase Master 

HL7_25_CM2 

Clinical Study Schedule Master 

HL7_25_CNS 

Clear Notification 

HL7_25_CRM_C01 

Register a Patient on a Clinical Trial 

HL7_25_CRM_C02 

Cancel a Patient Registration on Clinical Trial 

HL7_25_CRM_C03 

Correct/Update Registration Information 

HL7_25_CRM_C04 

Patient has Gone Off a Clinical Trial 

HL7_25_CRM_C05 

Patient Enters Phase of Clinical Trial 

HL7_25_CRM_C06 

Cancel Patient Entering a Phase 

HL7_25_CRM_C07 

Correct/Update Phase Information 

HL7_25_CRM_C08 

Patient has Gone Off Phase of Clinical Trial 

HL7_25_CSP 

Clinical Study Phase 

HL7_25_CSR 

Clinical Study Registration 

HL7_25_CSS 

Clinical Study Data Schedule Segment 

HL7_25_CSU_C09 

Automated Time Intervals for Reporting, Like Monthly 

HL7_25_CSU_C10 

Patient Completes the Clinical Trial 

HL7_25_CSU_C11 

Patient Completes a Phase of the Clinical Trial 

HL7_25_CSU_C12  

Update/Correction of Patient Order/Result Information 

HL7_25_CTD 

Contact Data 

HL7_25_CTI 

Clinical Trial Identification 

HL7_25_DB1 

Disability 

HL7_25_DFT_P03 

Post Detail Financial Transactions 

HL7_25_DFT_P11 

Post Detail Financial Transactions - Expanded 

HL7_25_DG1 

Diagnosis 

HL7_25_DOC_T12 

Document Query 

HL7_25_DRG 

Diagnosis Related Group 

HL7_25_DSC 

Continuation Pointer  

HL7_25_DSP 

Display Data 

HL7_25_EAC_U07 

Automated Equipment Command 

HL7_25_EAN_U09 

Automated Equipment Notification 

HL7_25_EAR_U08 

Automated Equipment Response 

HL7_25_ECD 

Equipment Command 

HL7_25_ECR 

Equipment Command Response 

HL7_25_EDU 

Educational Detail 

HL7_25_EQP 

Equipment/log Service  

HL7_25_EQU 

Equipment Detail 

HL7_25_ERR 

Error 

HL7_25_ESR_U02 

Automated Equipment Status Request  

HL7_25_ESU_U01 

Automated Equipment Status Update 

HL7_25_EVN 

Event Type 

HL7_25_FT1 

Financial Transaction 

HL7_25_GOL 

Goal Detail 

HL7_25_GP1 

Grouping/Reimbursement - Visit 

HL7_25_GP2 

Grouping/Reimbursement - Procedure Line Item 

HL7_25_GT1 

Guarantor 

HL7_25_IAM 

Patient Adverse Reaction Information 

HL7_25_IIM 

Inventory Item Master 

HL7_25_IN1 

Insurance 

HL7_25_IN2 

Insurance Additional Information 

HL7_25_IN3 

Insurance Additional Information, Certification 

HL7_25_INR_U06 

Automated Equipment Inventory Request 

HL7_25_INU_U05 

Automated Equipment Inventory Update 

HL7_25_INV 

Inventory Detail  

HL7_25_IPC 

Imaging Procedure Control Segment 

HL7_25_ISD 

Interaction Status Detail 

HL7_25_LAN 

Language Detail 

HL7_25_LCC 

Location Charge Code  

HL7_25_LCH 

Location Characteristic 

HL7_25_LDP 

Location Department 

HL7_25_LOC 

Location Identification 

HL7_25_LRL 

Location Relationship 

HL7_25_LSR_U13 

Automated Equipment Log/Service Request 

HL7_25_LSU_U12 

Automated Equipment Log Service Update 

HL7_25_MDM_T01 

Original Document Notification 

HL7_25_MDM_T02 

Original Document Notification and Content 

HL7_25_MDM_T03 

Document Status Change Notification 

HL7_25_MDM_T04 

Document Status Change Notification and Content 

HL7_25_MDM_T05 

Document Addendum Notification 

HL7_25_MDM_T06 

Document Addendum Notification and Content 

HL7_25_MDM_T07 

Document Edit Notification 

HL7_25_MDM_T08 

Document Edit Notification and Content 

HL7_25_MDM_T09 

Document Replacement Notification 

HL7_25_MDM_T10 

Document Replacement Notification and Content 

HL7_25_MDM_T11 

Document Cancel Notification 

HL7_25_MFA 

Master File Acknowledgment 

HL7_25_MFE 

Master File Entry 

HL7_25_MFI 

Master File Identification  

HL7_25_MFK_M01 

Master FFile Not Otherwise Specified 

HL7_25_MFK_M02 

Master File - Staff Practitioner 

HL7_25_MFK_M03 

Master File - Test/Observation (Backward Compatibility) 

HL7_25_MFK_M04 

Master Files Charge Description 

HL7_25_MFK_M05 

Patient Location Master File 

HL7_25_MFK_M06 

Clinical Study with Phases and Schedules Master File 

HL7_25_MFK_M07 

Clinical Study without Phases but with Schedules Master File 

HL7_25_MFK_M08 

Test/Observation (Numeric) Master File 

HL7_25_MFK_M09 

Test/Observation (Categorical) Master File 

HL7_25_MFK_M10 

Test /Observation Batteries Master File 

HL7_25_MFK_M11 

Test/Calculated Observations Master File 

HL7_25_MFK_M12 

Master File Notification Message 

HL7_25_MFK_M13 

Master File Notification - General 

HL7_25_MFK_M14 

Master File Notification_Site Defined 

HL7_25_MFK_M15 

Inventory Item Master File Notification 

HL7_25_MFN_M01 

Master File Notification - Not Otherwise Specified (for backward compatibility only) 

HL7_25_MFN_M02 

Master File Notification - Staff/Practitioner 

HL7_25_MFN_M03 

Master File Notification - Test/Observation (for backward compatibility only) 

HL7_25_MFN_M04 

Master File Notification - Charge Description 

HL7_25_MFN_M05 

Master File Notification - Patient Location 

HL7_25_MFN_M06 

Master File Notification - Clinical Study with Phases and Schedules 

HL7_25_MFN_M07 

Master File Notification - Clinical Study Without Phases but with Schedules 

HL7_25_MFN_M08 

Master File Notification - Test/Observation (Numeric) 

HL7_25_MFN_M09 

Master File Notification - Test/Observation (Categorical) 

HL7_25_MFN_M10 

Master File Notification - Test/Observation Batteries 

HL7_25_MFN_M11 

Master File Notification - Test/Calculated Observations 

HL7_25_MFN_M12 

Master File Notification - Additional Basic Observation/Service Attributes 

HL7_25_MFN_M13 

Master File Notification - General 

HL7_25_MFN_M14 

Master File Notification - Site Defined 

HL7_25_MFN_M15 

Master File Notification- Inventory Item 

HL7_25_MFQ_M01 

Master Files Query - Not Otherwise Specified (for backward compatibility only) 

HL7_25_MFQ_M02 

Master Files Query - Staff/Practitioner 

HL7_25_MFQ_M03 

Master Files Query - Test/Observation (backward compatibility) 

HL7_25_MFQ_M04 

Master Files Query - Charge Description 

HL7_25_MFQ_M05 

Master Files Query - Patient Location 

HL7_25_MFQ_M06 

Master Files Query - Clinical Study with Phases and Schedules 

HL7_25_MFQ_M07 

Master Files Query - Clinical study without phases but with schedules 

HL7_25_MFQ_M08 

Master Files Query - Test/Observation (Numeric) 

HL7_25_MFQ_M09 

Master Files Query - Test/Observation (Categorical) 

HL7_25_MFQ_M10 

Master Files Query - Test/Observation Batteries 

HL7_25_MFQ_M11 

Master Files Query - Test/Calculated Observations 

HL7_25_MFQ_M12 

Master Files Query - Additional Basic Observation/Service Attributes 

HL7_25_MFQ_M13 

Master Files Query - General 

HL7_25_MFQ_M14 

Master Files Query - Site Defined 

HL7_25_MFR_M01 

Master Files Response - Not Otherwise Specified (Backward Compatibility) 

HL7_25_MFR_M02 

Master Files Response - Staff Practitioner 

HL7_25_MFR_M03 

Master Files Response - Test/Observation (Backward Compatibility) 

HL7_25_MFR_M04 

Master Files Response - Charge Description 

HL7_25_MFR_M05 

Master Files Response - Patient Location 

HL7_25_MFR_M06 

Master Files Response - Clinical Study with Phases and Schedules 

HL7_25_MFR_M07 

Master Files Response - Clinical Study without Phases but with Schedules 

HL7_25_MFR_M08 

Master Files Response - Test/Observation (Numeric) 

HL7_25_MFR_M09 

Master Files Response - Test/Observation (Categorical) Master File 

HL7_25_MFR_M10 

Master Files Response - Test /Observation Batteries Master File 

HL7_25_MFR_M11 

Master Files Response - Test/Calculated Observations Master File 

HL7_25_MFR_M12 

Master Files Response - Master File Notification Message 

HL7_25_MFR_M13 

Master Files Response - Master File Notification - General 

HL7_25_MFR_M14 

Master Files Response - Master File Notification - Site Defined 

HL7_25_MRG 

Merge Patient Information 

HL7_25_MSA 

Message Acknowledgment 

HL7_25_MSH 

Message Header 

HL7_25_NCK 

System Clock 

HL7_25_NDS 

Notification Detail 

HL7_25_NK1 

Next of Kin/Associated Parties 

HL7_25_NMD_N02 

Application Management Data Message 

HL7_25_NMQ_N01 

Application Management Query Message 

HL7_25_NMR_N01 

Application management response message 

HL7_25_NPU 

Bed Status Update 

HL7_25_NSC 

Application Status Update 

HL7_25_NST 

Application Control Level Statistics 

HL7_25_NTE 

Notes and Comments 

HL7_25_OBR 

Observation Request 

HL7_25_OBX 

Observation Result 

HL7_25_ODS 

Dietary Orders, Supplements, and Preferences 

HL7_25_ODT 

Diet Tray Instructions 

HL7_25_OM1 

General Segment 

HL7_25_OM2 

Numeric Observation 

HL7_25_OM3 

Categorical Service/Test/Observation 

HL7_25_OM4 

Observations that Require Specimens 

HL7_25_OM5 

Observation Batteries (Sets) 

HL7_25_OM6 

Observations that are Calculated from Other Observations 

HL7_25_OM7 

Additional Basic Attributes 

HL7_25_OMB_O27 

Blood Product Order Message 

HL7_25_OMD_O03 

Dietary Order 

HL7_25_OMG_O19 

General Clinical Order Message 

HL7_25_OMI_O23 

Imaging Order Message 

HL7_25_OML_O21 

Laboratory Order 

HL7_25_OML_O33 

Laboratory Order for Multiple Orders Related to a Single Specimen 

HL7_25_OML_O35 

Laboratory Order for Multiple Orders Related to a Single Container of a Specimen 

HL7_25_OMN_O07 

Non-Stock Requisition Order 

HL7_25_OMP_O09 

Pharmacy/Treatment Order 

HL7_25_OMS_O05 

Stock Requisition Order 

HL7_25_ORB_O28 

Blood Product Order Acknowledgment 

HL7_25_ORC 

Common Order 

HL7_25_ORD_O04 

Diet Order Acknowledgment 

HL7_25_ORF_R04 

Response to Query; Transmission of Requested Observation 

HL7_25_ORG 

General Clinical Order Acknowledgment Message 

HL7_25_ORG_O20 

General Clinical Order Response 

HL7_25_ORI_O24 

Imaging Order Response Message To Any OMI 

HL7_25_ORL_O22 

General Laboratory Order Response Message to any OML 

HL7_25_ORL_O34 

Laboratory Order Response Message to a Multiple Order Related to Single Specimen OML 

HL7_25_ORL_O36 

Laboratory Order Response Message to a Single Container of a Specimen OML 

HL7_25_ORM_O01 

Pharmacy/Treatment Order Message 

HL7_25_ORN_O08 

Non-Stock Requisition Acknowledgment 

HL7_25_ORP_O10 

Pharmacy/Treatment Order Acknowledgment 

HL7_25_ORR_O02 

General Order Response Message Response to any ORM 

HL7_25_ORS_O06 

Stock Requisition Acknowledgment 

HL7_25_ORU_R01 

Unsolicited Transmission of an Observation Message 

HL7_25_ORU_R30 

Unsolicited Point-Of-Care Observation Message Without Existing Order _ Place An Order 

HL7_25_ORU_R31 

Unsolicited New Point-Of-Care Observation Message _ Search For An Order 

HL7_25_ORU_R32 

Unsolicited Pre-Ordered Point-Of-Care Observation 

HL7_25_OSQ_Q06 

Query for Order Status  

HL7_25_OSR_Q06 

Query Response for Order Status 

HL7_25_OUL_R21 

Unsolicited Laboratory Observation 

HL7_25_OUL_R22 

Unsolicited Specimen Oriented Observation Message 

HL7_25_OUL_R23 

Unsolicited Specimen Container Oriented Observation Message 

HL7_25_OUL_R24 

Unsolicited Order Oriented Observation Message 

HL7_25_PCR 

Possible Causal Relationship 

HL7_25_PD1 

Patient Additional Demographic 

HL7_25_PDA 

Patient Death and Autopsy 

HL7_25_PEO 

Product Experience Observation 

HL7_25_PES 

Product Experience Sender 

HL7_25_PEX_P07 

Unsolicited Initial Individual Product Experience Report 

HL7_25_PEX_P08 

Unsolicited Update Individual Product Experience Report 

HL7_25_PGL_PC6 

Patient Goal Message - Goal Add 

HL7_25_PGL_PC7 

Patient Goal Message - Goal Update 

HL7_25_PGL_PC8 

Patient Goal Message - Goal Delete 

HL7_25_PID 

Patient Identification 

HL7_25_PIN_I07 

Patient Insurance Information - Unsolicited 

HL7_25_PMU_B01 

Add Personnel Record 

HL7_25_PMU_B02 

Update Personnel Record 

HL7_25_PMU_B03 

Delete Personnel Record 

HL7_25_PMU_B04 

Active Practicing Person 

HL7_25_PMU_B05 

Deactivate Practicing Person 

HL7_25_PMU_B06 

Terminate Practicing Person 

HL7_25_PMU_B07 

Grant Certificate/Permission 

HL7_25_PMU_B08 

Add Personnel Record - Revoke Certificate/Permission 

HL7_25_PPG_PCG 

Patient Pathway Message - Pathway (Goal-Oriented) Add 

HL7_25_PPG_PCH 

Patient Pathway Message - Pathway (Goal-Oriented) Update 

HL7_25_PPG_PCJ 

Patient Pathway Message - Pathway (Goal-Oriented) Delete 

HL7_25_PPP_PCB 

Patient Problem Message - Pathway (Problem-Oriented) Add 

HL7_25_PPP_PCC 

Patient Problem Message - Pathway (Problem-Oriented) Update 

HL7_25_PPP_PCD 

Patient Problem Message - Pathway (Problem-Oriented) Delete 

HL7_25_PPR_PC1 

Patient Problem Message - Problem Add 

HL7_25_PPR_PC2 

Patient Problem Message - Problem Update 

HL7_25_PPR_PC3 

Patient Problem Message - Problem Delete 

HL7_25_PPT_PCL 

Patient Pathway Goal - Oriented Query Response 

HL7_25_PPV_PCA 

Patient Goal Response 

HL7_25_PR1 

Procedures 

HL7_25_PRA 

Practitioner Detail 

HL7_25_PRB 

Problem Details 

HL7_25_PRC 

Pricing 

HL7_25_PRD 

Provider Data 

HL7_25_PRR_PC5 

Patient Problem Response 

HL7_25_PTH 

Pathway 

HL7_25_PTR_PCF 

Patient Pathway Problem - Oriented Response 

HL7_25_PV1 

Patient Visit 

HL7_25_PV2 

Patient Visit - Additional Information 

HL7_25_QAK 

Query Acknowledgment 

HL7_25_QBP_Q11 

Query by Parameter - Requesting an RSP segment pattern response 

HL7_25_QBP_Q13 

Query by Parameter - Requesting an RTB - Tabular Response 

HL7_25_QBP_Q15 

Query by Parameter - Requesting an RDY Display Response 

HL7_25_QBP_Q21 

Query by Parameter - Get Person Demographics 

HL7_25_QBP_Q22 

Query by Parameter - Find Candidates 

HL7_25_QBP_Q23 

Query by Parameter - Get Corresponding Identifiers 

HL7_25_QBP_Q24 

Query by Parameter - Allocate Identifiers 

HL7_25_QBP_Q25 

Query by Parameter - Personnel Information by Segment Query 

HL7_25_QBP_Q31 

Query by Parameter - Dispense History 

HL7_25_QBP_Z73 

Query by Parameter - Information about Phone Calls 

HL7_25_QBP_Z75 

Query by Parameter - Tabular Patient List 

HL7_25_QBP_Z77 

Query by Parameter - Tabular Patient List 

HL7_25_QBP_Z79 

Query by Parameter - Dispense Information 

HL7_25_QBP_Z81 

Query by Parameter - Dispense History 

HL7_25_QBP_Z85 

Query by Parameter - Pharmacy Information Comprehensive 

HL7_25_QBP_Z87 

Query by Parameter - Dispense Information 

HL7_25_QBP_Z89 

Query by Parameter - Lab Results History 

HL7_25_QBP_Z91 

Query by Parameter - Who am I 

HL7_25_QBP_Z93 

Query by Parameter - Tabular Dispense History 

HL7_25_QBP_Z95 

Query by Parameter - Tabular Dispense History 

HL7_25_QBP_Z97 

Query by Parameter - Dispense History 

HL7_25_QBP_Z99 

Query by Parameter - Who Am I 

HL7_25_QCN_J01 

Cancel Query/Acknowledge Message 

HL7_25_QID 

Query Identification 

HL7_25_QPD 

Query Parameter Definition 

HL7_25_QRD 

Original-Style Query Definition 

HL7_25_QRF 

Original style query filter 

HL7_25_QRI 

Query Response Instance 

HL7_25_QRY_A19 

Patient Query 

HL7_25_QRY_PC4 

Problem Query 

HL7_25_QRY_PC9 

Goal Query 

HL7_25_QRY_PCE 

Pathway (Problem-Oriented) Query 

HL7_25_QRY_PCK 

Pathway (Goal-Oriented) Query 

HL7_25_QRY_Q26 

Pharmacy/Treatment Order Response 

HL7_25_QRY_Q27 

Pharmacy/Treatment Administration Information 

HL7_25_QRY_Q28 

Pharmacy/Treatment Dispense Information 

HL7_25_QRY_Q29 

Pharmacy/Treatment Encoded Order Information 

HL7_25_QRY_Q30 

Pharmacy/Treatment Dose Information 

HL7_25_QRY_R02 

Query for Results of Observation 

HL7_25_QRY_T12 

Document Query 

HL7_25_QSB_Q16 

Create Subscription 

HL7_25_QSB_Z83 

ORU Subscription 

HL7_25_QSX_J02 

Cancel Subscription/Acknowledge Message 

HL7_25_QVR_Q17 

Query for Previous Events 

HL7_25_RAR_RAR 

Pharmacy/treatment administration information 

HL7_25_RAS_O17 

Pharmacy/Treatment Administration 

HL7_25_RCI_I05 

Return Clinical Information 

HL7_25_RCL_I06 

Return Clinical List 

HL7_25_RCP 

Response Control Parameter 

HL7_25_RDE_O11 

Pharmacy/Treatment Encoded Order 

HL7_25_RDE_O25 

Pharmacy/Treatment Refill Authorization Request 

HL7_25_RDF 

Table Row Definition 

HL7_25_RDR_RDR 

Pharmacy/treatment dispense information 

HL7_25_RDS_O13 

Pharmacy/Treatment Dispense 

HL7_25_RDT 

Table Row Data 

HL7_25_RDY_K15 

Display Response in Response to QBP^Q15 

HL7_25_RDY_Z80 

Retrieve Patient Pharmacy Dispense History Information (Patient, Order Control Code, Medication, Date Range, Quantity Dispensed, and Ordering Provider) 

HL7_25_RDY_Z98 

Retrieve Patient Pharmacy Dispense History Information (Patient, Medication, Date Range, and How to Sort Response) 

HL7_25_REF_I12 

Patient Referral 

HL7_25_REF_I13 

Modify Patient Referral 

HL7_25_REF_I14 

Cancel Patient Referral 

HL7_25_REF_I15 

Request Patient Referral Status 

HL7_25_RER_RER 

Pharmacy/treatment encoded order information 

HL7_25_RF1 

Referral Information 

HL7_25_RGR_RGR 

Pharmacy/treatment dose information 

HL7_25_RGS 

Resource Group 

HL7_25_RGV_O15 

Pharmacy/Treatment Give 

HL7_25_RMI 

Risk Management Incident 

HL7_25_ROL 

Role 

HL7_25_ROR_ROR 

Pharmacy prescription order query response 

HL7_25_RPA_I08 

Request for treatment authorization 

HL7_25_RPA_I10 

Request for resubmission of an authorization 

HL7_25_RPA_I11 

Request for cancellation of an authorization 

HL7_25_RPI_I01 

Request for insurance information 

HL7_25_RPI_I04 

Request for patient demographic data 

HL7_25_RPL_I02 

Request/receipt of patient selection display list 

HL7_25_RPR_I03 

Request/receipt of patient selection list 

HL7_25_RQ1 

Requisition Detail-1 

HL7_25_RQA_I08 

Request for Treatment Authorization Information 

HL7_25_RPA_I09 

Request for Modification to an Authorization 

HL7_25_RQA_I10 

Request for Re-submission of an Authorization 

HL7_25_RQA_I11 

Request for Cancellation of an Authorization 

HL7_25_RQC_I05 

Request for Patient Clinical Information 

HL7_25_RQC_I06 

Request/Receipt of Clinical Data Listing 

HL7_25_RQD 

Requisition Detail 

HL7_25_RQI_I01 

Request for Insurance Information 

HL7_25_RQI_I02 

Request/Receipt of Patient Selection Display List 

HL7_25_RQI_I03 

Request/Receipt of Patient Selection List 

HL7_25_RQP_I04 

Request for Patient Demographic Data 

HL7_25_RRA_O18 

Pharmacy/Treatment Administration Acknowledgment 

HL7_25_RRD_O14 

Pharmacy/Treatment Dispense Acknowledgment 

HL7_25_RRE_O12 

Pharmacy/Treatment Encoded Order Acknowledgment 

HL7_25_RRE_O26 

Pharmacy/Treatment Refill Authorization Acknowledgement 

HL7_25_RRG_O16 

Pharmacy/Treatment Give Acknowledgment 

HL7_25_RRI_I12 

Patient referral 

HL7_25_RRI_I13 

Modify patient referral 

HL7_25_RRI_I14 

Cancel patient referral 

HL7_25_RRI_I15 

Request patient referral status 

HL7_25_RSP_K11 

Segment Pattern Response in Response to QBP^Q11 

HL7_25_RSP_K21 

Get Person Demographics Response 

HL7_25_RSP_K22 

Find Candidates Response 

HL7_25_RSP_K23 

Get Corresponding Identifiers Response 

HL7_25_RSP_K24 

Allocate Identifiers Response 

HL7_25_RSP_K25 

Personnel Information by Segment 

HL7_25_RSP_K31 

Segment Pattern Response - Pharmacy Dispense Message 

HL7_25_RSP_Z82 

Segment Pattern Response - Dispense History 

HL7_25_RSP_Z84 

Segment Pattern Response - Who Am I 

HL7_25_RSP_Z86 

Segment Pattern Response - Pharmacy Information Comprehensive 

HL7_25_RSP_Z88 

Segment Pattern Response - Dispense Information 

HL7_25_RSP_Z90 

Segment Pattern Response - Lab Results History 

HL7_25_RTB_K13 

Tabular Response - RTB - Tabular response in response to QBP^Q13 

HL7_25_RTB_Z74 

Tabular Response - Information about Phone Calls 

HL7_25_RTB_Z76 

Tabular Response - Patient List 

HL7_25_RTB_Z78 

Tabular Response - Patient List 

HL7_25_RTB_Z92 

Tabular response 

HL7_25_RTB_Z94 

Tabular Response - Dispense History 

HL7_25_RTB_Z96 

Tabular Response - Dispense History 

HL7_25_RXA 

Pharmacy/Treatment Administration 

HL7_25_RXC 

Pharmacy/Treatment Component Order 

HL7_25_RXD 

Pharmacy/Treatment Dispense 

HL7_25_RXE 

Pharmacy/Treatment Encoded Order 

HL7_25_RXG 

Pharmacy/Treatment Give 

HL7_25_RXO 

Pharmacy/Treatment Order 

HL7_25_RXR 

Pharmacy/Treatment Route 

HL7_25_SAC 

Specimen Container detail 

HL7_25_SCH 

Scheduling Activity Information 

HL7_25_SFT 

Software Segment 

HL7_25_SID 

Substance Identifier 

HL7_25_SIU_S12 

Schedule Information Unsolicited - Notification of new appointment booking 

HL7_25_SIU_S13 

Schedule Information Unsolicited - Notification of Appointment Rescheduling 

HL7_25_SIU_S14 

Schedule Information Unsolicited - Notification of Appointment Modification 

HL7_25_SIU_S15 

Schedule Information Unsolicited - Notification of Appointment Cancellation 

HL7_25_SIU_S16 

Schedule Information Unsolicited - Notification of Appointment Discontinuation 

HL7_25_SIU_S17 

Schedule Information Unsolicited - Notification of Appointment Deletion 

HL7_25_SIU_S18 

Schedule Information Unsolicited - Notification of Addition of Service/Resource on Appointment 

HL7_25_SIU_S19 

Schedule Information Unsolicited - Notification of Modification of Service/Resource on Appointment 

HL7_25_SIU_S20 

Schedule Information Unsolicited - Notification of Cancellation of Service/Resource on Appointment 

HL7_25_SIU_S21 

Schedule Information Unsolicited - Notification of Discontinuation of Service/Resource on Appointment 

HL7_25_SIU_S22 

Schedule Information Unsolicited - Notification of Deletion of Service/Resource on Appointment 

HL7_25_SIU_S23 

Schedule Information Unsolicited - Notification of Blocked Schedule Time Slot(s) 

HL7_25_SIU_S24 

Schedule Information Unsolicited - Notification of Opened (_unblocked_) Schedule Time Slot(s) 

HL7_25_SIU_S26 

Schedule Information Unsolicited - Notification that Patient did Not Show Up for Schedule Appointment 

HL7_25_SPM 

Specimen 

HL7_25_SQM_S25 

Schedule Query Message - Schedule Query Message and Response 

HL7_25_SQR_S25 

Schedule Query Message and Response 

HL7_25_SRM_S01 

Schedule Request Message - Request New Appointment Booking 

HL7_25_SRM_S02 

Schedule Request Message - Request Appointment Rescheduling 

HL7_25_SRM_S03 

Schedule Request Message - Request Appointment Modification 

HL7_25_SRM_S04 

Schedule Request Message - Request Appointment Cancellation 

HL7_25_SRM_S05 

Schedule Request Message - Request Appointment Discontinuation 

HL7_25_SRM_S06 

Schedule Request Message - Request Appointment Deletion 

HL7_25_SRM_S07 

Schedule Request Message - Request Addition of Service/Resource on Appointment 

HL7_25_SRM_S08 

Schedule Request Message - Request Modification of Service/ Resource on Appointment 

HL7_25_SRM_S09 

Schedule Request Message - Request Cancellation of Service/ Resource on Appointment 

HL7_25_SRM_S10 

Schedule Request Message - Request Discontinuation of Service/ Resource on Appointment 

HL7_25_SRM_S11 

Schedule Request Message - Request Deletion of Service/Resource on Appointment 

HL7_25_SRR_S01 

Request New Appointment Response 

HL7_25_SRR_S02 

Request Appointment Rescheduling Response 

HL7_25_SRR_S03 

Request Appointment Modification Response 

HL7_25_SRR_S04 

Request Appointment Cancellation Response 

HL7_25_SRR_S05 

Request Appointment Discontinuation Response 

HL7_25_SRR_S06 

Request Appointment Deletion Response 

HL7_25_SRR_S07 

Request Addition of Service/resource on Appointment Response 

HL7_25_SRR_S08 

Request Modification of Service/resource on Appointment Response 

HL7_25_SRR_S09 

Request Cancellation of Service/resource on Appointment Response 

HL7_25_SRR_S10 

Request Discontinuation of Service/Resource on Appointment Response 

HL7_25_SRR_S11 

Request Deletion of Service/Resource on Appointment Response 

HL7_25_SSR_U04 

Specimen Status Request Message 

HL7_25_SSU_U03 

Specimen Status Update Message 

HL7_25_STF 

Staff Identification - Segment 

HL7_25_TCC 

Test Code Configuration - Segment 

HL7_25_TCD 

Test Code Detail 

HL7_25_TCR_U11 

Automated Equipment Test Code Settings Request 

HL7_25_TCU_U10 

Automated Equipment Test Code Settings Update 

HL7_25_TQ2 

Timing/Quantity Relationship 

HL7_25_TXA 

Transcription Document Header 

HL7_25_UB1 

UB82 

HL7_25_UB2 

UB92 Data 

HL7_25_VAR 

Unknown/Variance 

HL7_25_VXQ_V01 

Query for Vaccination Record 

HL7_25_VXR_V03 

Vaccination Record Response 

HL7_25_VXU_V04 

Unsolicited Vaccination Record Update 

HL7_25_VXX_V02 

Response to Vaccination Query Returning Multiple PID Matches 

HL7 Version 2.4 Message Library Structure

The following table describes the HL7 Version 2.4 Message Library.

HL7 2.4 Segment 

HL7 Description 

HL7_24_ABS 

Segment Message Library 

HL7_24_ACC 

Segment Message Library 

HL7_24_ACK 

Segment Message Library 

HL7_24_ADR_A19 

Segment Message Library 

HL7_24_ADT_A01 

Admit/Visit Notification 

HL7_24_ADT_A02 

Transfer a Patient 

HL7_24_ADT_A03 

Discharge/End Visit 

HL7_24_ADT_A04 

Register a Patient 

HL7_24_ADT_A05 

Pre-Admit a Patient 

HL7_24_ADT_A06 

Change an Outpatient to an Inpatient 

HL7_24_ADT_A07 

Change an Inpatient to an Outpatient 

HL7_24_ADT_A08 

Update Patient Information 

HL7_24_ADT_A09 

Patient Departing - Tracking 

HL7_24_ADT_A10 

Patient Arriving - Tracking 

HL7_24_ADT_A11 

Cancel Admit/Visit Notification 

HL7_24_ADT_A12 

Cancel Transfer  

HL7_24_ADT_A13 

Cancel Discharge/End Visit 

HL7_24_ADT_A14 

Pending Admit 

HL7_24_ADT_A15 

Pending Transfer 

HL7_24_ADT_A16 

Pending Discharge 

HL7_24_ADT_A17 

Swap Patients 

HL7_24_ADT_A18 

Merge Patient Information 

HL7_24_ADT_A20 

Bed Status Update 

HL7_24_ADT_A21 

Patient Goes on a Leave of Absence 

HL7_24_ADT_A22 

Patient Returns from a Leave of Absence 

HL7_24_ADT_A23 

Delete a Patient Record 

HL7_24_ADT_A24 

Link Patient Information 

HL7_24_ADT_A25 

Cancel Pending Discharge 

HL7_24_ADT_A26 

Cancel Pending Transfer 

HL7_24_ADT_A27 

Cancel Pending Admit 

HL7_24_ADT_A28 

Add Person or Patient Information 

HL7_24_ADT_A29 

Delete Person Information 

HL7_24_ADT_A30 

Merge Person Information 

HL7_24_ADT_A31 

Update Person Information 

HL7_24_ADT_A32 

Cancel Patient Arriving - Tracking 

HL7_24_ADT_A33 

Cancel Patient Departing - Tracking 

HL7_24_ADT_A34 

Merge Patient Information - Patient ID Only 

HL7_24_ADT_A35 

Merge Patient Information - Account Number Only 

HL7_24_ADT_A36 

Merge Patient Information - Patient ID & Account Number 

HL7_24_ADT_A37 

Unlink Patient Information 

HL7_24_ADT_A38 

Cancel Pre-Admit 

HL7_24_ADT_A39 

Merge Patient - Patient ID 

HL7_24_ADT_A40 

Merge Patient - Patient Identifier List 

HL7_24_ADT_A41 

Merge Account - Patient Account Number 

HL7_24_ADT_A42 

Merge Visit - Visit Number 

HL7_24_ADT_A43 

Move Patient Information - Patient Identifier List 

HL7_24_ADT_A44 

Move Account Information - Patient Account Number 

HL7_24_ADT_A45 

Move Visit Information - Visit Number 

HL7_24_ADT_A46 

Change Patient ID 

HL7_24_ADT_A47 

Change Patient Identifier List 

HL7_24_ADT_A48 

Change Alternate 

HL7_24_ADT_A49 

Change Patient Account Number 

HL7_24_ADT_A50 

Change Visit Number 

HL7_24_ADT_A51 

Change Alternate Visit ID 

HL7_24_ADT_A52 

Cancel Leave of Absence for a Patient 

HL7_24_ADT_A53 

Cancel Patient Returns from a Leave of Absence 

HL7_24_ADT_A54 

Change Attending Doctor 

HL7_24_ADT_A55 

Cancel Change Attending Doctor 

HL7_24_ADT_A60 

Update Adverse Reaction Information 

HL7_24_ADT_A61 

Change Consulting Doctor 

HL7_24_ADT_A62 

Cancel Change Consulting Doctor 

HL7_24_AFF 

Professional Affiliation Additional Information 

HL7_24_AIG 

Appointment Information _General Resource 

HL7_24_AIL 

Appointment Information_Location Resource 

HL7_24_AIP 

Appointment Information_Personnel Resource 

HL7_24_AIS 

Appointment Information 

HL7_24_AL1 

Patient Allergy Information 

HL7_24_APR 

Appointment Preferences 

HL7_24_ARQ 

Appointment Request 

HL7_24_AUT 

Authorization Information 

HL7_24_BAR_P01 

Add Patient Account 

HL7_24_BAR_P02 

Purge Patient Accounts 

HL7_24_BAR_P05 

Update Account 

HL7_24_BAR_P06 

End Account 

HL7_24_BAR_P10 

Transmit Ambulatory Payment Classification (APC) Groups 

HL7_24_BLC 

Blood Code HL7_24_BLG Billing 

HL7_24_CDM 

Charge Description Master 

HL7_24_CM0 

Clinical Study Master 

HL7_24_CM1 

Clinical Study Phase Master 

HL7_24_CM2 

Clinical Study Schedule Master 

HL7_24_CNS 

Clear Notification 

HL7_24_CRM_C01 

Register a Patient on a Clinical Trial 

HL7_24_CRM_C02 

Cancel a Patient Registration on Clinical Trial 

HL7_24_CRM_C03  

Correct/Update Registration Information 

HL7_24_CRM_C04 

Patient has Gone Off a Clinical Trial 

HL7_24_CRM_C05 

Patient Enters Phase of Clinical Trial 

HL7_24_CRM_C06 

Cancel Patient Entering a Phase 

HL7_24_CRM_C07 

Correct/Update Phase Information 

HL7_24_CRM_C08 

Patient has Gone Off Phase of Clinical Trial 

HL7_24_CSP 

Clinical Study Phase 

HL7_24_CSR 

Clinical Study Registration 

HL7_24_CSS 

Clinical Study Data Schedule Segment 

HL7_24_CSU_C09 

Automated Time Intervals for Reporting, Like Monthly 

HL7_24_CSU_C10 

Patient Completes the Clinical Trial 

HL7_24_CSU_C11 

Patient Completes a Phase of the Clinical Trial 

HL7_24_CSU_C12 

Update/Correction of Patient Order/Result Information 

HL7_24_CTD 

Contact Data 

HL7_24_CTI 

Clinical Trial Identification 

HL7_24_DB1 

Disability 

HL7_24_DFT_P03 

Post Detail Financial Transactions 

HL7_24_DFT_P11 

Post Detail Financial Transactions - Expanded 

HL7_24_DG1 

Diagnosis 

HL7_24_DOC 

Document response 

HL7_24_DRG 

Diagnosis Related Group 

HL7_24_DSC 

Continuation Pointer 

HL7_24_DSP 

Display Data 

HL7_24_DSR_Q01 

Segment 

HL7_24_DSR_Q03 

Deferred Response to a Query 

HL7_24_EAC_U07 

Automated Equipment Command 

HL7_24_EAN_U09 

Automated Equipment Notification 

HL7_24_EAR_U08 

Automated Equipment Response 

HL7_24_ECD 

Equipment Command 

HL7_24_ECR 

Equipment Command Response 

HL7_24_EDR 

Enhanced display response 

HL7_24_EDU 

Educational Detail 

HL7_24_EQL 

Embedded Query Language 

HL7_24_EQP 

Equipment/log Service 

HL7_24_EQQ_Q04 

Embedded query language query 

HL7_24_EQU 

Equipment Detail 

HL7_24_ERP 

Event Replay Response 

HL7_24_ERQ 

Event replay query 

HL7_24_ERR 

Error 

HL7_24_ESR_U02 

Automated Equipment Status Request 

HL7_24_ESU_U01 

Automated Equipment Status Update 

HL7_24_EVN 

Event Type 

HL7_24_FAC 

Facility 

HL7_24_FTI 

Financial Transaction 

HL7_24_GOL 

Goal Detail 

HL7_24_GP1 

Grouping/Reimbursement - Visit 

HL7_24_GP2 

Grouping/Reimbursement - Procedure Line ItemSegment 

HL7_24_GT1 

Guarantor 

HL7_24_IAM 

Patient Adverse Reaction Information 

HL7_24_IN1 

Insurance 

HL7_24_IN2 

Insurance Additional Information 

HL7_24_IN3 

Insurance Additional Information, Certification 

HL7_24_INR_U06 

Automated Equipment Inventory Request 

HL7_24_INU_U05 

Automated Equipment Inventory Update 

HL7_24_INV 

Inventory Detail 

HL7_24_ISD 

Interaction Status Detail 

HL7_24_LAN 

Language Detail 

HL7_24_LCC 

Location Charge Code 

HL7_24_LCH 

Location Characteristic 

HL7_24_LDP 

Location Department 

HL7_24_LOC 

Location Identification 

HL7_24_LRL 

Location Relationship 

HL7_24_LSR_U13 

Automated Equipment Log Service Request 

HL7_24_LSU_U12 

Automated Equipment Log Service Update 

HL7_24_MDM_T01 

Original Document Notification 

HL7_24_MDM_T02 

Original Document Notification and Content 

HL7_24_MDM_T03 

Document Status Change Notification 

HL7_24_MDM_T04 

Document Status Change Notification and Content 

HL7_24_MDM_T05 

Document Addendum Notification 

HL7_24_MDM_T06 

Document Addendum Notification and Content 

HL7_24_MDM_T07 

Document Edit Notification 

HL7_24_MDM_T08 

Document Edit Notification and Content 

HL7_24_MDM_T09 

Document Replacement Notification 

HL7_24_MDM_T10 

Document Replacement Notification and Content 

HL7_24_MDM_T11 

Document Cancel Notification 

HL7_24_MFA 

Master File Acknowledgment 

HL7_24_MFE 

Master File Entry 

HL7_24_MFI 

Master File Identification 

HL7_24_MFK_M01 

Master files application acknowledgment - Not Otherwise Specified (Backward Compatibility) 

HL7_24_MFK_M02 

Master files Application Acknowledgment - Staff Practitioner 

HL7_24_MFK_M03 

Master files Application Acknowledgment - Test/Observation (Backward Compatibility) 

HL7_24_MFK_M04 

Master files Application Acknowledgment - Charge Description 

HL7_24_MFK_M05 

Master files Application Acknowledgment - Patient Location Master File 

HL7_24_MFK_M06 

Master files Application Acknowledgment - Clinical Study with Phases and Schedules 

HL7_24_MFK_M07 

Master files Application Acknowledgment - Clinical Study without Phases but with Schedules 

HL7_24_MFN_M01 

Master File Notification - Not Otherwise Specified (Backward Compatibility) 

HL7_24_MFN_M02 

Master File Notification - Staff/Practitioner  

HL7_24_MFN_M03 

Master File Notification - Test/Observation  

HL7_24_MFN_M04 

Master File Notification - Charge Description 

HL7_24_MFN_M05 

Master File Notification - Patient Location 

HL7_24_MFN_M06 

Master File Notification - Clinical Study with Phases and Schedules 

HL7_24_MFN_M07 

Master File Notification - Clinical Study without Phases but with Schedules 

HL7_24_MFN_M08 

Master File Notification - Test/Observation (Numeric) 

HL7_24_MFN_M09 

Master File Notification - Test/Observation (Categorical) 

HL7_24_MFN_M10 

Master File Notification - Test/Observation Batteries 

HL7_24_MFN_M11 

Master File Notification - Test/Calculated Observations 

HL7_24_MFN_M12 

Master File Notification - Additional Basic Observation/Service Attributes 

HL7_24_MFQ_M01 

Master Files Query - Not Otherwise Specified (Backward Compatibility) 

HL7_24_MFQ_M02 

Master Files Query - Staff/Practitioner 

HL7_24_MFQ_M03 

Master Files Query - Test/Observation (for backward compatibility only) 

HL7_24_MFQ_M04 

Master Files Query - Charge Description 

HL7_24_MFQ_M05 

Master Files Query - Patient Location 

HL7_24_MFQ_M06 

Master Files Query - Clinical Study with Phases and Schedules 

HL7_24_MFR_M01 

Master File Response - Not Otherwise Specified (Backward Compatibility) 

HL7_24_MFR_M02 

Master File Response - Staff/Practitioner 

HL7_24_MFR_M03 

Master File Response - Test/Observation 

HL7_24_MFR_M04 

Master File Response - Charge Description 

HL7_24_MFR_M05 

Master File Response - Patient Location 

HL7_24_MFR_M06 

Master File Response - Clinical Study with Phases and Schedules 

HL7_24_MRG 

Merge Patient Information 

HL7_24_MSA 

Message Acknowledgment 

HL7_24_MSH 

Message Header 

HL7_24_NCK 

System Clock 

HL7_24_NDS  

Notification Detail 

HL7_24_NK1 

Next of Kin / Associated Parties 

HL7_24_NMD_N02 

Application Management Data Message (unsolicited) 

HL7_24_NMQ_N01 

Application Management Query Message  

HL7_24_NMR_N01 

Application management response message 

HL7_24_NPU 

Bed Status Update 

HL7_24_NSC 

Application Status Change 

HL7_24_NST 

Application control level statistics 

HL7_24_NTE 

Notes and Comments 

HL7_24_OBR 

Observation Request 

HL7_24_OBX 

Observation/Result 

HL7_24_ODS 

Dietary Orders, Supplements, and Preferences 

HL7_24_ODT 

Diet Tray Instructions 

HL7_24_OM1 

General Segment 

HL7_24_OM2 

Numeric Observation 

HL7_24_OM3 

Categorical Service/Test/Observation 

HL7_24_OM4 

Observations that Require Specimens 

HL7_24_OM5 

Observation Batteries (Sets) 

HL7_24_OM6 

Observations that are Calculated from Other Observations 

HL7_24_OM7 

Additional Basic Attributes 

HL7_24_OMD_O03 

Diet Order 

HL7_24_OMG_O19 

General Clinical Order 

HL7_24_OML_O21 

Laboratory Order 

HL7_24_OMN_O07 

Non-Stock Requisition Order 

HL7_24_OMP_O09 

Pharmacy/Treatment Order 

HL7_24_OMS_O05 

Stock Requisition Order 

HL7_24_ORC 

Common Order 

HL7_24_ORD_O05 

Dietary order acknowledgment message 

HL7_24_ORF_R04 

Response to query; transmission of requested observation 

HL7_24_ORG 

General clinical order acknowledgment message 

HL7_24_ORG_O20 

General clinical order response 

HL7_24_ORL_O02 

General laboratory order response 

HL7_24_ORM_O01 

Pharmacy/Treatment Order Message 

HL7_24_ORN-O08 

Non-Stock Requisition Acknowledgment 

HL7_24_ORP_O10 

Pharmacy/treatment order acknowledgment 

HL7_24_ORR_O02 

Pharmacy/Treatment Order Message - Order Response 

HL7_24_ORS_O06 

Stock requisition acknowledgment 

HL7_24_ORU_R01 

Unsolicited Transmission of an Observation Message 

HL7_24_OSQ_Q06 

Query for Order Status 

HL7_24_OSR_Q06 

Query for Order Status Response 

HL7_24_OUL_R21 

Unsolicited Laboratory Observation 

HL7_24_PCR 

Possible Causal Relationship 

HL7_24_PD1 

Patient Additional Demographic 

HL7_24_PDA 

Patient Death and Autopsy 

HL7_24_PDC 

Product Detail Country 

HL7_24_PEO 

Product Experience Observation 

HL7_24_PES 

Product Experience Sender 

HL7_24_PEX_P07 

Unsolicited Initial Individual Product Experience Report 

HL7_24_PEX_P08 

Unsolicited Update Individual Product Experience Report 

HL7_24_PGL_PC6 

Goal Add 

HL7_24_PGL_PC7 

Goal Update 

HL7_24_PGL_PC8 

Goal Delete 

HL7_24_PID 

Patient Identification 

HL7_24_PIN_I07 

Unsolicited Insurance Information 

HL7_24_PMU_B01 

Add Personnel Record 

HL7_24_PMU_B02 

Update Personnel Record 

HL7_24_PMU_B03 

Delete Personnel Record 

HL7_24_PMU_B04 

Active Practicing Person 

HL7_24_PMU_B05 

Deactivate Practicing Person 

HL7_24_PMU_B06  

Terminate Practicing Person 

HL7_24_PPG_PCG 

Pathway (Goal-Oriented) Add 

HL7_24_PPG_PCH 

Pathway (Goal-Oriented) Update 

HL7_24_PPG_PCJ 

Pathway (Goal-Oriented) Delete 

HL7_24_PPP_PCB  

Pathway (Problem-Oriented) Add 

HL7_24_PPP_PCC 

Pathway (Problem-Oriented) Update 

HL7_24_PPP_PCD 

Pathway (Problem-Oriented) Delete 

HL7_24_PPR_PC1 

Problem Add 

HL7_24_PPR_PC2 

Problem Update 

HL7_24_PPR_PC3 

Problem Delete 

HL7_24_PPT_PC3 

Segment Message Library 

HL7_24_PPT_PCL 

Segment Message Library 

HL7_24_PPV_PCA 

Segment Message Library 

HL7_24_PR1 

Segment Message Library 

HL7_24_PRA 

Segment Message Library 

HL7_24_PRB 

Segment Message Library 

HL7_24_PRC 

Segment Message Library 

HL7_24_PRD 

Segment Message Library 

HL7_24_PRR_PC5 

Segment Message Library 

HL7_24_PSH 

Segment Message Library 

HL7_24_PTH 

Segment Message Library 

HL7_24_PTR_PCF 

Segment Message Library 

HL7_24_PV1 

Segment Message Library 

HL7_24_PV2 

Segment Message Library 

HL7_24_QAK 

Segment Message Library 

HL7_24_QBP_Q11 

Query by Parameter Requesting an RSP Segment Pattern Response 

HL7_24_QBP_Q13 

Query by Parameter Requesting an RTB - Tabular Response 

HL7_24_QBP_Q15 

Query by Parameter Requesting an RDY Display Response 

HL7_24_QBP_Q21 

Get Person Demographics 

HL7_24_QBP_Q22 

Find Candidates 

HL7_24_QBP_Q23 

Get Corresponding Identifiers 

HL7_24_QBP_Q24 

Allocate Identifiers 

HL7_24_QBP_Q25 

Personnel Information by Segment Query 

HL7_24_QBP_Z73 

Query by Parameter - Information about Phone Calls 

HL7_24_QBP_Z75 

Query by Parameter - Tabular Patient List 

HL7_24_QBP_Z77 

Query by Parameter - Tabular Patient List 

HL7_24_QBP_Z79 

Query by Parameter - Dispense Information 

HL7_24_QBP_Z81 

Query by Parameter - Dispense History 

HL7_24_QBP_Z85 

Query by Parameter - Pharmacy Information Comprehensive 

HL7_24_QBP_Z87 

Query by Parameter - Dispense Information 

HL7_24_QBP_Z89 

Query by Parameter - Lab Results History 

HL7_24_QBP_Z91 

Query by Parameter - Who am I 

HL7_24_QBP_Z93 

Query by Parameter - Tabular Dispense History 

HL7_24_QBP_Z95 

Query by Parameter - Tabular Dispense History 

HL7_24_QBP_Z97 

Query by Parameter - Dispense History 

HL7_24_QBP_Z99 

Query by Parameter - Who Am I 

HL7_24_QCK_Q02 

Segment 

HL7_24_QCN_J01 

Cancel Query/Acknowledge Message 

HL7_24_QID 

Segment Message Library 

HL7_24_QPD 

Segment Message Library 

HL7_24_QRD 

Segment Message Library 

HL7_24_QRF 

Segment Message Library 

HL7_24_QRI 

Segment Message Library 

HL7_24_QRY_A19 

Patient Query 

HL7_24_QRY_PC4 

Problem Query 

HL7_24_QRY_PC9 

Goal Query 

HL7_24_QRY_PCE 

Pathway (Problem-Oriented) Query 

HL7_24_QRY_PCK 

Pathway (Goal-Oriented) Query 

HL7_24_QRY_Q01 

Query Sent for Immediate Response 

HL7_24_QRY_Q02 

Query Sent for Deferred Response 

HL7_24_QRY_Q26 

Pharmacy/Treatment Order Response 

HL7_24_QRY_Q27 

Pharmacy/Treatment Administration Information 

HL7_24_QRY_Q28 

Pharmacy/Treatment Dispense Information 

HL7_24_QRY_Q29 

Pharmacy/Treatment Encoded Order Information 

HL7_24_QRY_Q30 

Pharmacy/Treatment Dose Information 

HL7_24_QRY_R02 

Unsolicited Transmission of an Observation Message 

HL7_24_QRY_T12 

Document Query 

HL7_24_QSB_Q16 

Create Subscription 

HL7_24_QSB_Z83 

Create subscription - ORU 

HL7_24_QSX_J02 

Cancel Subscription/Acknowledge Message 

HL7_24_QVR_Q17 

Query for Previous Events 

HL7_24_RAR_RAR 

Segment Message Library 

HL7_24_RAS_O17 

Pharmacy/Treatment Administration 

HL7_24_RCI_I05 

Segment Message Library 

HL7_24_RCI_I06 

Segment Message Library 

HL7_24_RCP 

Segment Message Library 

HL7_24_RDE_O11 

Pharmacy/Treatment Encoded Order 

HL7_24_RDF 

Segment Message Library 

HL7_24_RDR_RDR 

Segment Message Library 

HL7_24_RDS_O13 

Pharmacy/Treatment Dispense 

HL7_24_RDT 

Segment Message Library 

HL7_24_RDY_K15 

Segment Message Library 

HL7_24_RDY_Z80 

Segment Message Library 

HL7_24_RDY_Z98 

Segment Message Library 

HL7_24_REF_I12 

Patient Referral 

HL7_24_REF_I13 

Modify Patient Referral 

HL7_24_REF_I14 

Cancel Patient Referral  

HL7_24_REF_I15 

Request Patient Referral Status 

HL7_24_RER_RER 

Segment Message Library 

HL7_24_RF1 

Segment Message Library 

HL7_24_RGR_RGR 

Segment Message Library 

HL7_24_RGS 

Segment Message Library 

HL7_24_RGV_O15 

Pharmacy/Treatment Give 

HL7_24_RMI 

Segment Message Library 

HL7_24_ROL 

Segment Message Library 

HL7_24_ROR_ROR 

Segment Message Library 

HL7_24_RPA_I08 

Segment Message Library 

HL7_24_RPA_I09 

Segment Message Library 

HL7_24_RPA_I10 

Segment Message Library 

HL7_24_RPA_I11 

Segment Message Library 

HL7_24_RPI_I01 

Segment Message Library 

HL7_24_RPI_I04 

Segment Message Library 

HL7_24_RPL_I02 

Segment Message Library 

HL7_24_RPR_I03 

Segment Message Library 

HL7_24_RQ1 

Segment Message Library 

HL7_24_RQA_I08 

Request for Treatment Authorization Information 

HL7_24_RQA_I09 

Request for Modification to an Authorization 

HL7_24_RQA_I10 

Request for Re-submission of an Authorization 

HL7_24_RQA_I11 

Request for Cancellation of an Authorization 

HL7_24_RQC_I05 

Request for Patient Clinical Information 

HL7_24_RQC_I06 

Request/receipt of Clinical Data Listing 

HL7_24_RQD 

Segment 

HL7_24_RQI_I01 

Request for Insurance Information 

HL7_24_RQI_I02 

Request/Receipt of Patient Selection Display List 

HL7_24_RQI_I03 

Request/Receipt of Patient Selection List 

HL7_24_RQP_I04 

Request for Patient Demographic Data 

HL7_24_RQQ_Q09 

Event Replay Query 

HL7_24_RRA_O18 

Segment Message Library 

HL7_24_RRD_O14 

Segment Message Library 

HL7_24_RRE_O12 

Segment Message Library 

HL7_24_RRG_O16 

Segment Message Library 

HL7_24_RRI_I12 

Segment Message Library 

HL7_24_RRI_I13 

Segment Message Library 

HL7_24_RRI_I14 

Segment Message Library 

HL7_24_RRI_I15 

Segment Message Library 

HL7_24_RSP_K11 

Segment Message Library 

HL7_24_RSP_K21 

Segment Message Library 

HL7_24_RSP_K22 

Segment Message Library 

HL7_24_RSP_K23 

Segment Message Library 

HL7_24_RSP_K24 

Segment Message Library 

HL7_24_RSP_K25 

Segment Message Library 

HL7_24_RSP_Z82 

Segment Message Library 

HL7_24_RSP_Z84 

Segment Message Library 

HL7_24_RSP_Z86 

Segment Message Library 

HL7_24_RSP_Z88 

Segment Message Library 

HL7_24_RSP_Z90 

Segment Message Library 

HL7_24_RTB_K13 

Segment Message Library 

HL7_24_RTB_Z74 

Segment Message Library 

HL7_24_RTB_Z76 

Segment Message Library 

HL7_24_RTB_Z78 

Segment Message Library 

HL7_24_RTB_Z92 

Segment Message Library 

HL7_24_RTB_Z94 

Segment Message Library 

HL7_24_RTB_Z96 

Segment Message Library 

HL7_24_RXA 

Segment Message Library 

HL7_24_RXC 

Segment Message Library 

HL7_24_RXD 

Segment Message Library 

HL7_24_RXE 

Segment Message Library 

HL7_24_RXG 

Segment Message Library 

HL7_24_RXO 

Segment Message Library 

HL7_24_RXR 

Segment Message Library 

HL7_24_SAC 

Segment Message Library 

HL7_24_SCH 

Segment Message Library 

HL7_24_SID 

Segment Message Library 

HL7_24_SIU_S12 

Schedule Information Unsolicited - Notification of new appointment booking 

HL7_24_SIU_S13 

Schedule Information Unsolicited - Notification of Appointment Rescheduling 

HL7_24_SIU_S14 

Schedule Information Unsolicited - Notification of Appointment Modification 

HL7_24_SIU_S15 

Schedule Information Unsolicited - Notification of Appointment Cancellation 

HL7_24_SIU_S16 

Schedule Information Unsolicited - Notification of Appointment Discontinuation 

HL7_24_SIU_S17 

Schedule Information Unsolicited - Notification of Appointment Deletion 

HL7_24_SIU_S18 

Schedule Information Unsolicited - Notification of Addition of Service/Resource on Appointment 

HL7_24_SIU_S19 

Schedule Information Unsolicited - Notification of Modification of Service/Resource on Appointment 

HL7_24_SIU_S20 

Schedule Information Unsolicited - Notification of Cancellation of Service/Resource on Appointment 

HL7_24_SIU_S21 

Schedule Information Unsolicited - Notification of Discontinuation of Service/Resource on Appointment 

HL7_24_SIU_S22 

Schedule Information Unsolicited - Notification of Deletion of Service/Resource on Appointment 

HL7_24_SIU_S23 

Schedule Information Unsolicited - Notification of Blocked Schedule Time Slot(s) 

HL7_24_SIU_S24 

Schedule Information Unsolicited - Notification of Opened (_unblocked_) Schedule Time Slot(s) 

HL7_24_SIU_S26 

Schedule Information Unsolicited - Notification that Patient did Not Show Up for Schedule Appointment 

HL7_24_SPQ_Q08 

Stored Procedure Request 

HL7_24_SPR 

Segment Message Library 

HL7_24_SQM_S25 

Schedule Query Message and Response 

HL7_24_SQR_S25 

Segment Message Library 

HL7_24_SRM_S01 

Schedule Request Message - Request New Appointment Booking 

HL7_24_SRM_S02 

Schedule Request Message - Request Appointment Rescheduling 

HL7_24_SRM_S03 

Schedule Request Message - Request Appointment Modification 

HL7_24_SRM_S04 

Schedule Request Message - Request Appointment Cancellation 

HL7_24_SRM_S05 

Schedule Request Message - Request Appointment Discontinuation 

HL7_24_SRM_S06 

Schedule Request Message - Request Appointment Deletion 

HL7_24_SRM_S07 

Schedule Request Message - Request Addition of Service/Resource on Appointment 

HL7_24_SRM_S08 

Schedule Request Message - Request Modification of Service/ Resource on Appointment 

HL7_24_SRM_S09 

Schedule Request Message - Request Cancellation of Service/ Resource on Appointment 

HL7_24_SRM_S10 

Schedule Request Message - Request Discontinuation of Service/ Resource on Appointment 

HL7_24_SRM_S11 

Schedule Request Message - Request Deletion of Service/Resource on Appointment 

HL7_24_SRR_S01 

Request New Appointment Response 

HL7_24_SRR_S02 

Request Appointment Rescheduling Response 

HL7_24_SRR_S03 

Request Appointment Modification Response 

HL7_24_SRR_S04 

Request Appointment Cancellation Response 

HL7_24_SRR_S05 

Request Appointment Discontinuation Response 

HL7_24_SRR_S06 

Request Appointment Deletion Response 

HL7_24_SRR_S07 

Request Addition of Service/resource on Appointment Response 

HL7_24_SRR_S08 

Request Modification of Service/resource on Appointment Response 

HL7_24_SRR_S09 

Request Cancellation of Service/resource on Appointment Response 

HL7_24_SRR_S10 

Request Discontinuation of Service/Resource on Appointment Response 

HL7_24_SRR_S11 

Request Deletion of Service/Resource on Appointment Response 

HL7_24_SSR_U04 

Specimen Status Request 

HL7_24_SSU_U03 

Specimen Status Update 

HL7_24_STF 

Staff Identification 

HL7_24_SUR_P09 

Summary Product Experience Report 

HL7_24_TBR_R08 

Tabular Data Response 

HL7_24_TCC 

Test Code Configuration 

HL7_24_TCD 

Test Code Detail 

HL7_24_TCR_U11 

Automated Equipment Test Code Settings Request 

HL7_24_TCU_U10 

Automated Equipment Test Code Settings Update 

HL7_24_TXA 

Transcription Document Header 

HL7_24_UB1 

UB82 

HL7_24_UB2 

UB92 Data 

HL7_24_UDM_Q05 

Unsolicited Display Update Message 

HL7_24_URD 

Results/update Definition 

HL7_24_URS 

Unsolicited Selection 

HL7_24_VAR 

Variance 

HL7_24_VQQ_Q07 

Virtual Table Query 

HL7_24_VTQ 

Virtual Table Query Request 

HL7_24_VXQ_V01 

Query for Vaccination Record 

HL7_24_VXR_V03 

Vaccination Record Response 

HL7_24_VXU_V04 

Unsolicited Vaccination Record Update 

HL7_24_VXX_V02 

Response to Vaccination Query Returning Multiple PID Matches 

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 

HL7 Version 2.3 Message Library Structure

The following table describes the HL7 Version 2.3 Message Library.

HL7 2.3 Segment 

HL7 Description 

HL7_23_ACC  

Segment Message Library 

HL7_23_ACK 

Segment Message Library 

HL7_23_ADR_A19 

Segment Message Library 

HL7_23_ADT_A01 

Admit/Visit Notification 

HL7_23_ADT_A02 

Transfer a Patient 

HL7_23_ADT_A03 

Discharge/End Visit  

HL7_23_ADT_A04 

Register a Patient 

HL7_23_ADT_A05 

Pre-Admit a Patient 

HL7_23_ADT_A06 

Change an Outpatient to an Inpatient 

HL7_23_ADT_A07 

Change an Inpatient to an Outpatient 

HL7_23_ADT_A08 

Update Patient Information 

HL7_23_ADT_A09 

Patient Departing - Tracking 

HL7_23_ADT_A10 

Patient Arriving - Tracking 

HL7_23_ADT_A11 

Cancel Admit/Visit Notification 

HL7_23_ADT_A12 

Cancel Transfer 

HL7_23_ADT_A13 

Cancel Discharge/End Visit 

HL7_23_ADT_A14 

Pending Admit 

HL7_23_ADT_A15 

Pending Transfer 

HL7_23_ADT_A16 

Pending Discharge 

HL7_23_ADT_A17 

Swap Patients 

HL7_23_ADT_A18 

Merge Patient Information 

HL7_23_ADT_A20 

Bed Status Update 

HL7_23_ADT_A21 

Patient Goes on a Leave of Absence 

HL7_23_ADT_A22 

Patient Returns from a Leave of Absence 

HL7_23_ADT_A23 

Delete a Patient Record 

HL7_23_ADT_A24 

Link Patient Information 

HL7_23_ADT_A25 

Cancel Pending Discharge 

HL7_23_ADT_A26 

Cancel Pending Transfer 

HL7_23_ADT_A27 

Cancel Pending Admit 

HL7_23_ADT_A28 

Add Person or Patient Information 

HL7_23_ADT_A29 

Delete Person Information 

HL7_23_ADT_A30 

Merge Person Information 

HL7_23_ADT_A31 

Update Person Information 

HL7_23_ADT_A32 

Cancel Patient Arriving - Tracking 

HL7_23_ADT_A33 

Cancel Patient Departing - Tracking 

HL7_23_ADT_A34 

Merge Patient Information - Patient ID Only 

HL7_23_ADT_A35 

Merge Patient Information - Account Number Only 

HL7_23_ADT_A36 

Merge Patient Information - Patient ID & Account Number 

HL7_23_ADT_A37 

Unlink Patient Information 

HL7_23_ADT_A38 

Cancel Pre-Admit 

HL7_23_ADT_A39 

Merge Patient - Patient ID 

HL7_23_ADT_A40 

Merge Patient - Patient Identifier List 

HL7_23_ADT_A41 

Merge Account - Patient Account Number 

HL7_23_ADT_A42 

Merge Visit - Visit Number 

HL7_23_ADT_A43 

Move Patient Information - Patient Identifier List 

HL7_23_ADT_A44 

Move Account Information - Patient Account Number 

HL7_23_ADT_A45 

Move Visit Information - Visit Number 

HL7_23_ADT_A46 

Change Patient ID 

HL7_23_ADT_A47 

Change Patient Identifier List 

HL7_23_ADT_A48 

Change Alternate 

HL7_23_ADT_A49 

Change Patient Account Number 

HL7_23_ADT_A50 

Change Visit Number 

HL7_23_ADT_A51 

Change Alternate Visit ID 

HL7_23_AIG 

Segment Message Library 

HL7_23_AIL 

Segment Message Library 

HL7_23_AIP 

Segment Message Library 

HL7_23_AIS 

Segment Message Library 

HL7_23_AL1 

Segment Message Library 

HL7_23_APR 

Segment Message Library 

HL7_23_ARQ 

Segment Message Library 

HL7_23_AUT 

Segment Message Library 

HL7_23_BAR_P01 

Add Patient Account 

HL7_23_BAR_P02 

Purge Patient Accounts 

HL7_23_BAR_P05 

Update Account 

HL7_23_BAR_P06 

End Account 

HL7_23_BLG 

Segment Message Library 

HL7_23_CDM 

Segment Message Library 

HL7_23_CM0 

Segment Message Library 

HL7_23_CM1 

Segment Message Library 

HL7_23_CM2 

Segment Message Library 

HL7_23_CRM_C01 

Register a Patient on a Clinical Trial 

HL7_23_CRM_C02 

Cancel a Patient Registration on Clinical Trial 

HL7_23_CRM_C03 

Correct/Update Registration Information 

HL7_23_CRM_C04 

Patient has Gone Off a Clinical Trial 

HL7_23_CRM_C05 

Patient Enters Phase of Clinical Trial 

HL7_23_CRM_C06 

Cancel Patient Entering a Phase 

HL7_23_CRM_C07 

Correct/Update Phase Information 

HL7_23_CRM_C08 

Patient has Gone Off Phase of Clinical Trial 

HL7_23_CSP 

Segment Message Library 

HL7_23_CSR 

Segment Message Library 

HL7_23_CSS 

Segment Message Library 

HL7_23_CSU_C09 

Automated Time Intervals for Reporting, Like Monthly 

HL7_23_CSU_C10 

Patient Completes the Clinical Trial 

HL7_23_CSU_C11 

Patient Completes a Phase of the Clinical Trial 

HL7_23_CSU_C12 

Update/Correction of Patient Order/Result Information 

HL7_23_CTD 

Segment Message Library 

HL7_23_CTI 

Segment Message Library 

HL7_23_DB1 

Segment Message Library 

HL7_23_DFT_P03 

Post Detail Financial Transactions 

HL7_23_DG1 

Segment Message Library 

HL7_23_DOC_T12 

Segment Message Library 

HL7_23_DRG 

Segment Message Library 

HL7_23_DSC 

Segment Message Library 

HL7_23_DSP 

Segment Message Library 

HL7_23_DSR_Q01 

Segment Message Library 

HL7_23_DSR_Q03 

Deferred Response to a Query 

HL7_23_EDR_Q01 

Enhanced Display Response 

HL7_23_EQL 

Segment Message Library 

HL7_23_EQQ_Q01 

Embedded Query Language Query 

HL7_23_ERP_Q01 

Event Replay Response 

HL7_23_EQR 

Segment Message Library 

HL7_23_ERR 

Segment Message Library 

HL7_23_EVN 

Segment Message Library 

HL7_23_FAC 

Segment Message Library 

HL7_23_FT1 

Segment Message Library 

HL7_23_GOL 

Segment Message Library 

HL7_23_GT1 

Segment Message Library 

HL7_23_IN1 

Segment Message Library 

HL7_23_IN2 

Segment Message Library 

HL7_23_IN3 

Segment Message Library 

HL7_23_LCC 

Segment Message Library 

HL7_23_LCH 

Segment Message Library 

HL7_23_LDP 

Segment Message Library 

HL7_23_LOC 

Segment Message Library 

HL7_23_LRL 

Segment Message Library 

HL7_23_MDM_T01 

Original Document Notification 

HL7_23_MDM_T02 

Original Document Notification and Content 

HL7_23_MDM_T03 

Document Status Change Notification 

HL7_23_MDM_T04 

Document Status Change Notification and Content 

HL7_23_MDM_T05 

Document Addendum Notification 

HL7_23_MDM_T06 

Document Addendum Notification and Content 

HL7_23_MDM_T07 

Document Edit Notification 

HL7_23_MDM_T08 

Document Edit Notification and Content 

HL7_23_MDM_T09 

Document Replacement Notification 

HL7_23_MDM_T10 

Document Replacement Notification and Content 

HL7_23_MDM_T11 

Document Cancel Notification 

HL7_23_MFA 

Segment Message Library HL7_23_MFE Segment 

HL7_23_MFI 

Segment Message Library 

HL7_23_MFK_M01 

Segment Message Library 

HL7_23_MFK_M02 

Segment Message Library 

HL7_23_MFK_M03 

Segment Message Library 

HL7_23_MFK_M04 

Segment Message Library 

HL7_23_MFK_M05 

Segment Message Library 

HL7_23_MFK_M06 

Segment Message Library 

HL7_23_MFK_M07 

Segment Message Library 

HL7_23_MFK_M08 

Segment Message Library 

HL7_23_MFK_M09 

Segment Message Library 

HL7_23_MFK_M10 

Segment Message Library 

HL7_23_MFK_M11 

Segment Message Library 

HL7_23_MFN_M01 

Master File Notification 

HL7_23_MFN_M02 

Staff/Practitioner Master File Message 

HL7_23_MFN_M03 

Master File Notification - Test/Observation 

HL7_23_MFN_M04 

Charge Description Master File Message 

HL7_23_MFN_M05 

Patient Location Master File Message 

HL7_23_MFN_M06 

Clinical Trials Master File Message (Identifier Code CMA) 

HL7_23_MFN_M07 

Clinical Trials Master File Message (Identifier Code CMB) 

HL7_23_MFN_M08 

Master File Notification - Test/Observation (Numeric) 

HL7_23_MFN_M09 

Master File Notification - Test/Observation (Categorical) 

HL7_23_MFN_M10 

Master File Notification - Test/Observation Batteries 

HL7_23_MFN_M11 

Master File Notification - Test/Calculated Observations 

HL7_23_MRG 

Segment Message Library 

HL7_23_MSA 

Segment Message Library 

HL7_23_MSH 

Segment Message Library 

HL7_23_NK1 

Segment Message Library 

HL7_23_NPU 

Segment Message Library 

HL7_23_NTE 

Segment Message Library 

HL7_23_OBR 

Segment Message Library 

HL7_23_OBX 

Segment Message Library 

HL7_23_ODS 

Segment Message Library 

HL7_23_ODT 

Segment Message Library 

HL7_23_OM1 

Segment Message Library 

HL7_23_OM2 

Segment Message Library 

HL7_23_OM3 

Segment Message Library 

HL7_23_OM4 

Segment Message Library 

HL7_23_OM5 

Segment Message Library 

HL7_23_OM6 

Segment Message Library 

HL7_23_OMD_O01 

Dietary Order 

HL7_23_OMN_O01 

Non-Stock Requisition Order Message 

HL7_23_OMS_O01 

Stock Requisition Order Message 

HL7_23_ORC 

Segment Message Library 

HL7_23_ORD_O02 

Dietary Order Acknowledgment Message 

HL7_23_ORF_R04 

Segment Message Library 

HL7_23_ORM_O01 

Pharmacy/Treatment Order Message 

HL7_23_ORN_O02 

General Order Acknowledgment Message 

HL7_23_ORR_O02 

General Order Response Message Response to any ORM 

HL7_23_ORU_R01 

Unsolicited Transmission of an Observation Message 

HL7_23_OSQ_Q06 

Query Response for Order Status 

HL7_23_OSR_Q06 

Segment Message Library 

HL7_23_PCR 

Segment Message Library 

HL7_23_PD1 

Segment Message Library 

HL7_23_PDC 

Segment Message Library 

HL7_23_PEO 

Segment Message Library 

HL7_23_PES 

Segment Message Library 

HL7_23_PEX_P07 

Unsolicited Initial Individual Product Experience Report 

HL7_23_PEX_P08 

Unsolicited Update Individual Product Experience Report 

HL7_23_PGL_PC6 

Patient Goal Message - Goal Add 

HL7_23_PGL_PC7 

Patient Goal Message - Goal Update 

HL7_23_PGL_PC8 

Patient Goal Message - Goal Delete 

HL7_23_PID 

Segment Message Library 

HL7_23_PIN_I07 

Patient Insurance Information - Unsolicited 

HL7_23_PPG_PCG 

Pathway (Goal-Oriented) Add 

HL7_23_PPG_PCH 

Pathway (Goal-Oriented) Update 

HL7_23_PPG_PCJ 

Pathway (Goal-Oriented) Delete 

HL7_23_PPP_PCB 

Pathway (Problem-Oriented) Add 

HL7_23_PPP_PCC 

Pathway (Problem-Oriented) Update 

HL7_23_PPP_PCD 

Pathway (Problem-Oriented) Delete 

HL7_23_PPR_PC1 

Problem Add 

HL7_23_PPR_PC2 

Problem Update 

HL7_23_PPR_PC3 

Problem Delete 

HL7_23_PPT_PCL 

Pathway (Goal-Oriented) Query Response 

HL7_23_PPV_PCA 

Goal Response 

HL7_23_PR1 

Segment Message Library 

HL7_23_PRA 

Segment Message Library 

HL7_23_PRB 

Segment Message Library 

HL7_23_PRC 

Segment Message Library 

HL7_23_PRD 

Segment Message Library 

HL7_23_PRR_PC5 

Problem Response 

HL7_23_PSH 

Segment Message Library 

HL7_23_PTH 

Segment Message Library 

HL7_23_PTR_PCF 

Pathway (Problem-Oriented) Query Response 

HL7_23_PV1 

Segment Message Library 

HL7_23_PV2 

Segment Message Library 

HL7_23_QAK 

Segment Message Library 

HL7_23_QCK_Q02 

Segment Message Library 

HL7_23_QRD 

Segment Message Library 

HL7_23_QRF 

Segment Message Library 

HL7_23_QRY_A19 

Patient Query 

HL7_23_QRY_PC4 

Problem Query 

HL7_23_QRY_PC9 

Goal Query 

HL7_23_QRY_PCE 

Pathway (Problem-Oriented) Query 

HL7_23_QRY_PCK 

Pathway (Goal-Oriented) Query 

HL7_23_QRY_Q01 

Query Sent for Immediate Response 

HL7_23_QRY_Q02 

Query Sent for Deferred Response 

HL7_23_QRY_R02 

Query for Results of Observation 

HL7_23_QRY_T12 

Document Query 

HL7_23_RAR_RAR 

Pharmacy Administration Information 

HL7_23_RAS_O01 

Pharmacy/Treatment Administration Order Message 

HL7_23_RCI_I05 

Segment Message Library 

HL7_23_RCL_I06 

Segment Message Library 

HL7_23_RDE_O01 

Pharmacy/Treatment Encoded Order Message 

HL7_23_RDF 

Segment Message Library 

HL7_23_RDO_O01 

Pharmacy/Treatment Order Message 

HL7_23_RDR_RDR 

Pharmacy/Treatment Dispense Information 

HL7_23_RDS_O01 

Pharmacy/Treatment Dispense Order Message 

HL7_23_RDT 

Segment Message Library 

HL7_23_REF_I12 

Patient Referral  

HL7_23_REF_I13 

Modify Patient Referral 

HL7_23_REF_I14 

Cancel Patient Referral 

HL7_23_REF_I15 

Request Patient Referral Status 

HL7_23_RER_RER 

Pharmacy/Treatment Encoded Order Information 

HL7_23_RF1 

Segment Message Library 

HL7_23_RGR_RGR 

Pharmacy/Treatment Dose Information 

HL7_23_RGS 

Segment Message Library 

HL7_23_RGV_O01 

Pharmacy/Treatment Give - Order Message 

HL7_23_ROL 

Segment Message Library 

HL7_23_ROR_ROR 

Pharmacy/Treatment Order Response 

HL7_23_RPA_I08 

Segment Message Library 

HL7_23_RPA_I09 

Segment Message Library 

HL7_23_RPA_I10 

Segment Message Library 

HL7_23_RPA_I11 

Segment Message Library 

HL7_23_RPI_I01 

Segment Message Library 

HL7_23_RPI_I04 

Segment Message Library 

HL7_23_RPL_I02 

Segment Message Library 

HL7_23_RPR_I03 

Segment Message Library 

HL7_23_RQ1_I 

Segment Message Library 

HL7_23_RQA_I08 

Request for Treatment Authorization Information 

HL7_23_RQA_I09 

Request for Modification to an Authorization 

HL7_23_RQA_I10 

Request for Re-submission of an Authorization 

HL7_23_RQA_I11 

Request for Cancellation of an Authorization 

HL7_23_RQC_I05 

Request for Patient Clinical Information 

HL7_23_RQC_I06 

Request/Receipt of Clinical Data Listing 

HL7_23_RQD 

Segment Message Library 

HL7_23_RQI_I01 

Request for Insurance Information 

HL7_23_RQI_I02 

Request/Receipt of Patient Selection Display List 

HL7_23_RQI_I03 

Request/Receipt of Patient Selection List 

HL7_23_RQP_I04 

Request for Patient Demographic Data 

HL7_23_RQQ_Q01 

Event replay query - Sent for Immediate Response 

HL7_23_RRA_O02 

Pharmacy/Treatment Administration Acknowledgment Message 

HL7_23_RRD_O02 

Pharmacy/Treatment Dispense Acknowledgment Message 

HL7_23_RRG_O02 

Pharmacy/Treatment Give Acknowledgment Message 

HL7_23_RRI_I12 

Segment Message Library 

HL7_23_RRI_I13 

Segment Message Library 

HL7_23_RRI_I14 

Segment Message Library 

HL7_23_RRI_I15 

Segment Message Library 

HL7_23_RRO_O02 

ORR Message for Pharmacy/Treatment - Order Response 

HL7_23_RXA 

Segment Message Library 

HL7_23_RXC 

Segment Message Library 

HL7_23_RXD 

Segment Message Library 

HL7_23_RXE 

Segment Message Library 

HL7_23_RXG 

Segment Message Library 

HL7_23_RXO 

Segment Message Library 

HL7_23_RXR 

Segment Message Library 

HL7_23_SCH 

Segment Message Library 

HL7_23_SIU_S12 

Schedule Information Unsolicited - Notification of new appointment booking 

HL7_23_SIU_S13 

Schedule Information Unsolicited - Notification of Appointment Rescheduling 

HL7_23_SIU_S14 

Schedule Information Unsolicited - Notification of Appointment Modification 

HL7_23_SIU_S15 

Schedule Information Unsolicited - Notification of Appointment Cancellation 

HL7_23_SIU_S16 

Schedule Information Unsolicited - Notification of Appointment Discontinuation 

HL7_23_SIU_S17 

Schedule Information Unsolicited - Notification of Appointment Deletion 

HL7_23_SIU_S18 

Schedule Information Unsolicited - Notification of Addition of Service/Resource on Appointment 

HL7_23_SIU_S19 

Schedule Information Unsolicited - Notification of Modification of Service/Resource on Appointment 

HL7_23_SIU_S20 

Schedule Information Unsolicited - Notification of Cancellation of Service/Resource on Appointment 

HL7_23_SIU_S21 

Schedule Information Unsolicited - Notification of Discontinuation of Service/Resource on Appointment 

HL7_23_SIU_S22 

Schedule Information Unsolicited - Notification of Deletion of Service/Resource on Appointment 

HL7_23_SIU_S23 

Schedule Information Unsolicited - Notification of Blocked Schedule Time Slot(s) 

HL7_23_SIU_S24 

Schedule Information Unsolicited - Notification of Opened (_unblocked_) Schedule Time Slot(s) 

HL7_23_SIU_S26 

Schedule Information Unsolicited - Notification that Patient did Not Show Up for Schedule Appointment 

HL7_23_SPQ_Q01 

Stored Procedure Request HL7_23_SPR Segment Message Library 

HL7_23_SQM_S25 

Schedule Query Message and Response 

HL7_23_SQR_S25 

Segment Message Library 

HL7_23_SRM_S01 

Schedule Request Message - Request New Appointment Booking 

HL7_23_SRM_S02 

Schedule Request Message - Request Appointment Rescheduling 

HL7_23_SRM_S03 

Schedule Request Message - Request Appointment Modification 

HL7_23_SRM_S04 

Schedule Request Message - Request Appointment Cancellation 

HL7_23_SRM_S05 

Schedule Request Message - Request Appointment Discontinuation 

HL7_23_SRM_S06 

Schedule Request Message - Request Appointment Deletion 

HL7_23_SRM_S07 

Schedule Request Message - Request Addition of Service/Resource on Appointment 

HL7_23_SRM_S08 

Schedule Request Message - Request Modification of Service/ Resource on Appointment 

HL7_23_SRM_S09 

Schedule Request Message - Request Cancellation of Service/ Resource on Appointment 

HL7_23_SRM_S10 

Schedule Request Message - Request Discontinuation of Service/ Resource on Appointment 

HL7_23_SRM_S11 

Schedule Request Message - Request Deletion of Service/Resource on Appointment 

HL7_23_SRR_S01 

Segment Message Library 

HL7_23_SRR_S02 

Segment Message Library 

HL7_23_SRR_S03 

Segment Message Library 

HL7_23_SRR_S04 

Segment Message Library 

HL7_23_SRR_S05 

Segment Message Library 

HL7_23_SRR_S06 

Segment Message Library  

HL7_23_SRR_S07 

Segment Message Library 

HL7_23_SRR_S08 

Segment Message Library 

HL7_23_SRR_S09 

Segment Message Library 

HL7_23_SRR_S10 

Segment Message Library 

HL7_23_SRR_S11 

Segment Message Library 

HL7_23_STF 

Segment Message Library 

HL7_23_SUR_P09 

Summary Product Experience Report 

HL7_23_TBR_Q01 

Tabular Data Response 

HL7_23_TXA 

Segment Message Library 

HL7_23_UB1 

Segment Message Library 

HL7_23_UB2 

Segment Message Library 

HL7_23_UDM_Q05 

Unsolicited Display Update Message 

HL7_23_URD 

Segment Message Library 

HL7_23_URS 

Segment Message Library 

HL7_23_VAR 

Segment Message Library 

HL7_23_VQQ_Q01 

Virtual Table Query 

HL7_23_VTQ H 

Segment Message Library 

L7_23_VXQ_V01 

Query for Vaccination Record 

HL7_23_VXR_V03 

Vaccination Record Response 

HL7_23_VXU_V04 

Unsolicited Vaccination Record Update 

HL7_23_VXX_V02 

Response to Vaccination Query Returning Multiple PID Matches 

HL7 Version 2.2 Message Library Structure

The following table describes the HL7 Version 2.2 Message Library.

HL7 2.2 Segment 

HL7 Description 

HL7_22_ACC 

Segment Message Library 

HL7_22_ACK 

Segment Message Library 

HL7_22_ADR_A19 

Segment Message Library 

HL7_22_ADT_A01 

Admit/Visit Notification 

HL7_22_ADT_A02 

Transfer a Patient 

HL7_22_ADT_A03 

Discharge/End Visit 

HL7_22_ADT_A04 

Register a Patient 

HL7_22_ADT_A05 

Pre-Admit a Patient 

HL7_22_ADT_A06 

Change an Outpatient to an Inpatient 

HL7_22_ADT_A07 

Change an Inpatient to an Outpatient 

HL7_22_ADT_A08 

Update Patient Information 

HL7_22_ADT_A09 

Patient Departing - Tracking 

HL7_22_ADT_A10 

Patient Arriving - Tracking 

HL7_22_ADT_A11 

Cancel Admit/Visit Notification 

HL7_22_ADT_A12 

Cancel Transfer 

HL7_22_ADT_A13 

Cancel Discharge/End Visit 

HL7_22_ADT_A14 

Pending Admit 

HL7_22_ADT_A15 

Pending Transfer 

HL7_22_ADT_A16 

Pending Discharge 

HL7_22_ADT_A17 

Swap Patients 

HL7_22_ADT_A18  

Merge Patient Information 

HL7_22_ADT_A20 

Bed Status Update 

HL7_22_ADT_A21 

Patient Goes on a Leave of Absence 

HL7_22_ADT_A22 

Patient Returns from a Leave of Absence 

HL7_22_ADT_A23 

Delete a Patient Record 

HL7_22_ADT_A24 

Link Patient Information 

HL7_22_ADT_A25 

Cancel Pending Discharge 

HL7_22_ADT_A26 

Cancel Pending Transfer 

HL7_22_ADT_A27 

Cancel Pending Admit 

HL7_22_ADT_A28 

Add Person or Patient Information 

HL7_22_ADT_A29 

Delete Person Information 

HL7_22_ADT_A30 

Merge Person Information 

HL7_22_ADT_A31 

Update Person Information 

HL7_22_ADT_A32 

Cancel Patient Arriving - Tracking 

HL7_22_ADT_A33 

Cancel Patient Departing - Tracking 

HL7_22_ADT_A34 

Merge Patient Information - Patient ID Only 

HL7_22_ADT_A35 

Merge Patient Information - Account Number Only 

HL7_22_ADT_A36 

Merge Patient Information - Patient ID & Account Number 

HL7_22_ADT_A37 

Unlink Patient Information 

HL7_22_AL1 

Segment Message Library 

HL7_22_BAR_P01 

Add Patient Account 

HL7_22_BAR_P02 

Purge Patient Accounts 

HL7_22_BLG 

Segment Message Library 

HL7_22_DFT_P03 

Post Detail Financial Transactions 

HL7_22_DG1 

Segment Message Library 

HL7_22_DSC 

Segment Message Library 

HL7_22_DSP 

Segment Message Library 

HL7_22_DSR_P04 

Segment Message Library 

HL7_22_DSR_Q01 

Segment Message Library 

HL7_22_DSR_Q03 

Deferred Response to a Query 

HL7_22_DSR_R03 

Display-Oriented Results, Query/Unsol. Update (for Backward Compatibility Only) 

HL7_22_ERR 

Segment Message Library 

HL7_22_EVN 

Segment Message Library 

HL7_22_FT1 

Segment Message Library 

HL7_22_GT1 

Segment Message Library 

HL7_22_IN1 

Segment Message Library 

HL7_22_IN2 

Segment Message Library 

HL7_22_IN3 

Segment Message Library 

HL7_22_MFA 

Segment Message Library 

HL7_22_MFD_M01 

Master Files Delayed Application Acknowledgment - Not Otherwise Specified (for Backward Compatibility Only) 

HL7_22_MFD_M02 

Master Files Delayed Application Acknowledgment - Staff Practitioner 

HL7_22_MFD_M03 

Master Files Delayed Application Acknowledgment - Test/ Observation (for Backward Compatibility Only) 

HL7_22_MFE 

Segment Message Library 

HL7_22_MFI 

Segment Message Library 

HL7_22_MFK_M01 

Segment Message Library 

HL7_22_MFK_M02 

Segment Message Library 

HL7_22_MFK_M03 

Segment Message Library 

HL7_22_MFN_M01 

Master File Notification - Master File Not Otherwise Specified 

HL7_22_MFN_M02 

Staff/Practitioner Master File Message 

HL7_22_MFN_M03 

Master File Notification - Test/Observation 

HL7_22_MFQ_M01 

Master Files Query - Not Otherwise Specified (for backward compatibility only) 

HL7_22_MFQ_M02  

Master Files Query - Staff/Practitioner 

HL7_22_MFQ_M03 

Master Files Query - Test/Observation (for backward compatibility only) 

HL7_22_MFR_M01 

Segment Message Library 

HL7_22_MFR_M02 

Segment Message Library 

HL7_22_MFR_M03 

Segment Message Library 

HL7_22_MRG 

Segment Message Library 

HL7_22_MSA 

Segment Message Library 

HL7_22_MSH 

Segment Message Library 

HL7_22_NCK 

Segment Message Library 

HL7_22_NK1 

Segment Message Library 

HL7_22_NMD_N01 

Application Management Data Message 

HL7_22_NMQ_N02 

Application Management Query Message 

HL7_22_NMR_N02 

Segment Message Library 

HL7_22_NPU 

Segment Message Library 

HL7_22_NSC 

Segment Message Library 

HL7_22_NST 

Segment Message Library 

HL7_22_NTE 

Segment Message Library 

HL7_22_OBR 

Segment Message Library 

HL7_22_OBX 

Segment Message Library 

HL7_22_ODS 

Segment Message Library 

HL7_22_ODT 

Segment Message Library  

HL7_22_ORC 

Segment Message Library 

HL7_22_ORF_R04 

Response to Query; Transmission of Requested Observation 

HL7_22_ORM_O01 

Pharmacy/Treatment - Order Message 

HL7_22_ORR_O02 

Pharmacy/Treatment - Order Response  

HL7_22_ORU_R01 

Unsolicited Transmission of an Observation Message 

HL7_22_PID 

Segment Message Library 

HL7_22_PR1 

Segment Message Library 

HL7_22_PV1 

Segment Message Library 

HL7_22_PV2 

Segment Message Library 

HL7_22_QRD 

Segment Message Library 

HL7_22_QRF 

Segment Message Library 

HL7_22_QRY_A19 

Patient Query 

HL7_22_QRY_P04 

Generate Bill and A/R Statements 

HL7_22_QRY_Q01 

Query Sent for Immediate Response 

HL7_22_QRY_Q02 

Query Sent for Deferred Response 

HL7_22_QRY_R02 

Unsolicited Transmission of an Observation Message 

HL7_22_RQ1 

Segment Message Library 

HL7_22_RQD 

Segment Message Library 

HL7_22_RXO 

Segment Message Library 

HL7_22_UB1 

Segment Message Library 

HL7_22_UB2 

Segment Message Library 

HL7_22_UDM_Q05 

Unsolicited Display Update Message 

HL7_22_URD 

Segment Message Library 

HL7_22_URS 

Segment Message Library 

HL7 Version 2.1 Message Library Structure

The following table describes the HL7 Version 2.1 Message Library.

HL7 2.1 Segment 

HL7 Description 

HL7_21_ADT_A01 

Admit/Visit Notification 

HL7_21_ADT_A02 

Transfer a Patient 

HL7_21_ADT_A03 

Discharge/End Visit 

HL7_21_ADT_A04 

Register a Patient 

HL7_21_ADT_A05 

Pre-Admit a Patient 

HL7_21_ADT_A06 

Change an Outpatient to an Inpatient 

HL7_21_ADT_A07 

Change an Inpatient to an Outpatient 

HL7_21_ADT_A08 

Update Patient Information 

HL7_21_ADT_A09 

Patient Departing - Tracking 

HL7_21_ADT_A10 

Patient Arriving - Tracking 

HL7_21_ADT_A11 

Cancel Admit/Visit Notification 

HL7_21_ADT_A12 

Cancel Transfer 

HL7_21_ADT_A13 

Cancel Discharge/End Visit 

HL7_21_ADT_A14 

Pending Admit 

HL7_21_ADT_A15 

Pending Transfer 

HL7_21_ADT_A16 

Pending Discharge 

HL7_21_ADT_A17 

Swap Patients 

HL7_21_ADT_A18 

Merge Patient Information 

HL7_21_ADT_A20 

Bed Status Update 

HL7_21_ADT_A21 

Patient Goes on a Leave of Absence 

HL7_21_ADT_A22 

Patient Returns from a Leave of Absence 

HL7_21_ADT_A23 

Delete a Patient Record 

HL7_21_ADT_A24 

Link Patient Information 

HL7_21_BAR_P01 

Add Patient Account 

HL7_21_BAR_P02 

Purge Patient Accounts 

HL7_21_BLG 

Segment Message Library 

HL7_21_DFT_P03 

Post Detail Financial Transactions 

HL7_21_DG1 

Segment Message Library 

HL7_21_DSC 

Segment Message Library 

HL7_21_DSP 

Segment Message Library 

HL7_21_DSR_Q01 

Segment Message Library 

HL7_21_DSR_Q03 

Deferred Response to a Query 

HL7_21_ERR 

Segment Message Library 

HL7_21_EVN 

Segment Message Library 

HL7_21_FT1 

Segment Message Library 

HL7_21_GT1 

Segment Message Library 

HL7_21_IN1 

Segment Message Library 

HL7_21_MCF 

Segment Message Library 

HL7_21_MRG 

Segment Message Library 

HL7_21_MSA 

Segment Message Library 

HL7_21_MSH 

Segment Message Library 

HL7_21_NK1 

Segment Message Library 

HL7_21_NPU 

Segment Message Library 

HL7_21_NTE 

Segment Message Library 

HL7_21_OBR 

Segment Message Library 

HL7_21_OBX 

Segment Message Library 

HL7_21_ORC 

Segment Message Library 

HL7_21_ORM_O01 

Pharmacy/Treatment Order Message 

HL7_21_ORO 

Segment Message Library 

HL7_21_ORR_O02 

General Order Response Message Response to any ORM HL7_21_ORU_R01 Unsolicited Transmission of an Observation Message 

HL7_21_ORU_R03 

Unsolicited Transmission of an Observation Message 

HL7_21_PID 

Segment Message Library 

HL7_21_PR1 

Segment Message Library 

HL7_21_PV1 

Segment Message Library 

HL7_21_QRD 

Segment Message Library 

HL7_21_QRF 

Segment Message Library 

HL7_21_QRY_A19 

Patient Query 

HL7_21_QRY_Q01 

Query Sent for Immediate Response 

HL7_21_QRY_Q02 

Query Sent for Deferred Response 

HL7_21_RX1 

Segment Message Library 

HL7_21_UB1 

Segment Message Library 

HL7_21_UDM_Q05 

Unsolicited Display Update Message 

HL7_21_URD 

Segment Message Library  

HL7_21_URS 

Segment Message Library