Define HL7 Business Documents

When you create an HL7 Business Document, you specify values for certain parameters that are common to all Business Document formats and others that are specific to the HL7 format.

For more information on the HL7 Business Document structure, see HL7 Business Document.

This topic describes all HL7-specific parameters. It contains the following sections:

Create an HL7 Business Document from scratch

Edit an HL7 Business Document

Properties view

Modify node attributes

Business Document editor – define the tree structure

Node types

Add nodes to the tree structure

About HL7 Business Documents

Health Level Seven (HL7) was founded in 1987 to develop standards for the electronic interchange of clinical, financial, and administrative information among independent health care oriented computer systems, such as hospital information systems, clinical laboratory systems, enterprise systems, and pharmacy systems.

The HL7 version 3.3.1 standard defines transactions for transmitting data about:

  • Patient registration
  • Admissions
  • Discharge and transfers
  • Insurance
  • Charges and payors
  • Orders and results for laboratory tests
  • Image studies
  • Nursing and physician observations
  • Diet orders
  • Pharmacy orders
  • Supply orders
  • Master files
  • Appointment
  • Scheduling
  • Problem lists
  • Clinical trial enrollments
  • Patient permissions
  • Voice dictations
  • Advanced directives
  • Physiologic signals

Create an HL7 Business Document from scratch

To create an HL7 Business Document in an existing DML Mapping Project:

  1. From the main menu, select File > New > Business Document.
  2. Alternatively, you can right-click in the Project Explorer and select New > Business Document.
  3. Specify where you want to save the Business Document. To select a path either use the directory tree or enter the path directly.
  4. Enter a File name for your Business Document. Click Next.
  5. Select HL7 as the Business Document type.
  6. Click Finish.

Mapping Services generates the HL7 Business Document in the selected project’s Business Document folder.

The generated Business Document opens automatically and is available for editing in the Business Document editor.

Note An alternative to manually creating an HL7 Business Document is to use the Business Document importer tool to generate an HL7 Business Document from a model file. For more information, see Import Business Documents and Import a Business Document from a library .

Edit an HL7 Business Document

Properties view

In the Properties view of the Business Document editor, Mapping Services displays a set of configuration fields that define the HL7 Business Document general characteristics.

General properties

You can modify the general structural characteristics, including modifying node attributes in the General section of the Properties view.

Parameter Description
Encoding

From the drop-down list, select the encoding you want to use. This value can be the default encoding available after the installation, but this can be customized by adding new encoding to the <Mapping Services install folder>/configuration/encoding.properties file.

Modify node attributes

Some of the HL7 node attributes can be modified in the Attributes section of the Properties view.

Not all of the nodes of the HL7 Business Document have attributes that can be modified. The non-modifiable attributes are highlighted in gray.

For more information on the Business Document structure, see Business Document structure, Business Document cardinality, Business Document data types, and Format options for Real numbers.

Business Document editor – define the tree structure

The structure of an HL7 Business Document consists of a group of segments in a well-defined sequence. Every HL7 message has a message type attribute that defines the message purpose (admissions, insurance, appointments, and so on).

An HL7 message comprises of segments. A segment is a logical grouping of data fields. The segments of an HL7 message can be mandatory or optional. A segment may occur only once in a message or it may repeat. Each segment has a unique name. It begins with a three-character literal value that identifies it within a message. The HL7 standard assigns a certain number of fields to the different segment types.

MSH segment (Message Header)

The Message Header (MSH) segment of an HL7 message is a mandatory segment that contains information about the message structure, type, origin, destination, and acknowledgment requirements.

Message body segments

In addition to the header segment, each HL7 message comprises of one or more segments that contain information about a specific health organization process.

For example, HL7 standards define the Admit Patient (ADT) message that contains the following segments:

  • MSH: Message Header (mandatory)
  • EVN: Event Type
  • PID: Patient Identification
  • PD1: Additional Demographics
  • NK1: Next of Kin
  • PV1: Patient Visit
  • PV2: Patient Visit (Additional Info.)
  • DB1: Disability Information
  • OBX: Health Information
  • AL1: Allergy Information
  • DG1: Diagnosis Information
  • PR1: Procedures
  • ROL: Role
  • GT1: Guarantor Information
  • IN1: Insurance Information

Each segment type contains a set of standard message components that hold data. These components are known as data fields.

The number and organization of the data fields within a segment vary depending on the HL7 segment type.

You can edit the Business Document structure by using the Business Document editor’s Structure tab, where you can add or delete new nodes.

The default structure of an HL7 Business Document contains the MSH segment. Define your own structure by adding parent and leaf element nodes.

Node types

You can use these nodes to create the document structure:

  • Field Container
  • Component Container
  • Sub-Component Container
  • Sequence
  • Leaf

Add nodes to the tree structure

To add nodes to the tree structure, use one of the following functions in the Business Document editor's context menu:

  • Add a Field Container with Sub-Tree to group other nodes without values.
  • Add a Field Container to group other nodes without values and leaf element nodes.
  • Add a Field as a Child of the selected node.
  • Add a Component Container to group Sub-Component Container nodes and leaf element nodes.
  • Add a Sub-Component Container to group leaf element nodes.
  • Add a Sequence.
  • Add a Sequence as a Child of another Sequence node or of a Field Container node.

Related topics

HL7 Business Document

Create Business Documents

Business Document structure

Business Document cardinality

Business Document data types

Format options for Real numbers

Business Documents

Related Links