HL7 - REFACTORED

Chapter Co-Chair and Editor	Anthony Julian Mayo Clinic
Chapter Co-Chair	Nick Radov United Healthcare
Chapter Co-Chair	Sandra Stuart Kaiser Permanente
Chapter Co-Chair	Dave Shaver Corepoint Health
Sponsoring Work Group:	Infrastructure and Messaging
List Server:	inm@lists.hl7.org

Introduction

The information in this chapter was relocated from Appendix C as of v2.4 of the standard. It had previously been entitled Network Management, and has been renamed to more accurately describe the purpose of the messages described herein. This chapter does not specify a protocol for managing networks, á la TCP/IP SNMP. Rather, its messages provide a means to manage HL7-supporting applications over a network.

Because this chapter was originally named "Network Management," the messages and segments have labels beginning with the letter "N." These labels are retained for backward compatibility.

As a technical chapter, this information is now normative with respect to the HL7 standard. It is anticipated that additional messages and message content will be added to this chapter in the near future.

Trigger Events and Message Definitions

NMQ - Application Management Query Message (Event N01)

NOTE: The MFQ//MFR transaction was retained for backward compatibility as of v2.5 and has been withdrawn as of V2.7. See conformance based queries as defined in Chapter 5.

Acknowledgement Choreography

None - Refer to Chapter 5 for generic query choreography.

NMD - Application Management Data Message (Event N02)

The N02 event signifies when an unsolicited update (UU) Application Management Data message (NMD) is created by on application to transmit application management information to other applications. In this case, the initiating application sends an NMD message as an unsolicited update (UU) containing application management information to a receiving application, which responds with a generic acknowledgement message (ACK).

For example, an application going down for backups (or starting up again after backups) might issue such a message to one or more other applications. An application switching to another CPU or file-server may also need to use this transaction to notify other systems.

Note: Because this message pair does not have an application acknowledgement, the value in MSH-16 does not affect the choreography

NMD^N02^NMD_N02: Application Management Data

Message Structure
Acknowlegment Choreography
v2.xml XSD

HL7 MessageStructure Table - NMD_N02
Segment	Cardinality	Must Implement	Status
NMD_N02
MSH	1..1	Yes	additional
SFT	0..*		additional
UAC	0..1		additional
CLOCK_AND_STATS_WITH_NOTES	1..*	Yes	additional
CLOCK	0..1		additional
NCK	1..1	Yes	additional
NTE	0..*		additional
APP_STATS	0..1		additional
NST	1..1	Yes	additional
NTE	0..*		additional
APP_STATUS	0..1		additional
NSC	1..1	Yes	additional
NTE	0..*		additional

Original Mode Acknowledgement Choreography for NMD^N02^NMD_N02

Send Immediate Ack: ACK^N02^ACK

Enhanced Mode Acknowledgement Choreography for NMD^N02^NMD_N02

When the MSH-15 value of a NMD^N02^NMD_N02 message is AL or ER or SU, an ACK^N02^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a NMD^N02^NMD_N02 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a NMD^N02^NMD_N02 message is AL or ER or SU, a message SHALL be sent as an application ack.

When the MSH-16 value of a NMD^N02^NMD_N02 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^N02^ACK
MSH-15	NE, AL, ER, SU	(none)
MSH-16	AL, ER, SU	application ack:
MSH-16	NE, AL, ER, SU	(none)

<?xml version="1.0"?>
<!--   v2.xml Message Definitions for Version 2.8.2 - here: NMD_N02-->
<!--   Copyright (c) 1999-2019, Health Level Seven. All rights reserved.   -->
<!--   (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml"
targetNamespace="urn:hl7-org:v2xml" version="1.1">
  <!-- import segment definition for version -->
  <xsd:include schemaLocation="segments.xsd" />
  <!-- MESSAGE NMD_N02 -->
  <!-- .. message definition NMD_N02 -->
  <xsd:complexType name="NMD_N02.CONTENT">
    <xsd:sequence>
      <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" />
      <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" />
      <xsd:element ref="NMD_N02.CLOCK_AND_STATS_WITH_NOTES"
      minOccurs="1" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="NMD_N02" type="NMD_N02.CONTENT" />
  <xsd:complexType name="NMD_N02.CLOCK_AND_STATS_WITH_NOTES.CONTENT">

    <xsd:sequence>
      <xsd:element ref="NMD_N02.CLOCK" minOccurs="0"
      maxOccurs="1" />
      <xsd:element ref="NMD_N02.APP_STATS" minOccurs="0"
      maxOccurs="1" />
      <xsd:element ref="NMD_N02.APP_STATUS" minOccurs="0"
      maxOccurs="1" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="NMD_N02.CLOCK_AND_STATS_WITH_NOTES"
  type="NMD_N02.CLOCK_AND_STATS_WITH_NOTES.CONTENT" />
  <xsd:complexType name="NMD_N02.CLOCK.CONTENT">
    <xsd:sequence>
      <xsd:element ref="NCK" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="NMD_N02.CLOCK" type="NMD_N02.CLOCK.CONTENT" />
  <xsd:complexType name="NMD_N02.APP_STATS.CONTENT">
    <xsd:sequence>
      <xsd:element ref="NST" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="NMD_N02.APP_STATS"
  type="NMD_N02.APP_STATS.CONTENT" />
  <xsd:complexType name="NMD_N02.APP_STATUS.CONTENT">
    <xsd:sequence>
      <xsd:element ref="NSC" minOccurs="1" maxOccurs="1" />
      <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" />
    </xsd:sequence>
  </xsd:complexType>
  <xsd:element name="NMD_N02.APP_STATUS"
  type="NMD_N02.APP_STATUS.CONTENT" />
</xsd:schema>

Download

message segments

NCK - System Clock Segment

The NCK segment is used to allow the various applications on the network to synchronize their system clocks (system date and time).

Usage Notes: If this message is to be used to automatically reset/correct system clocks, it is recommended that the system or administrative personnel initiating the NMQ with the NCK segment have the authority to correct the clock (system date and time) for the other systems on the network. This is important in order to avoid the obvious confusion of multiple systems attempting to resynchronize each other's clocks.

If this message is used only to gather information on the various systems' clocks, it is still important for an administrative procedure to be worked out to avoid conflicts when resetting clocks.

HL7 Attribute Table - NCK - System Clock Segment
Seq#	Data Element Name	DataType	Usage	Vocabulary	Cardinality	Item #	Length	C.LEN	Flags
NCK
1	System Date/Time	DTM	R		[1..1]	01172	[4..24]

NCK-1: System Date/Time (DTM) 01172

FIXME

NSC - Application Status Change Segment

The NSC segment is used to inform (NMR query response) or announce (NMD unsolicited update) the start-up, shut-down, and/or migration (to a different CPU or file-server/file-system) of a particular application.

Usage Notes: Fields 2-9. These are not applicable ("n/a") when the type of change being requested or reported is start-up or shut-down. If the change is of type "M", at least one of fields 2-5 must be different from its corresponding field in range 6-9.

Fields 4-5, 8-9. See definitions for the MSH, message header segment, in Chapter 2, "Control Section," for fields 3-4, for system and facility. "Application" is available for interfacing with lower level protocols. "Facility" is entirely site-defined.

Fields 2-3, 6-7: entirely site-defined.

HL7 Attribute Table - NSC - Application Status Change Segment
Seq#	Data Element Name	DataType	Usage	Vocabulary	Cardinality	Item #
NSC
1	Application Change Type	CWE	R	0409 Application Change Type	[1..1]	01188
2	Current CPU	ST	O		[0..1]	01189
3	Current Fileserver	ST	O		[0..1]	01190
4	Current Application	HD	O	0361 Application	[0..1]	01191
5	Current Facility	HD	O	0362 Facility	[0..1]	01192
6	New CPU	ST	O		[0..1]	01193
7	New Fileserver	ST	O		[0..1]	01194
8	New Application	HD	O	0361 Application	[0..1]	01195
9	New Facility	HD	O	0362 Facility	[0..1]	01196

NSC-1: Application Change Type (CWE) 01188

FIXME

NSC-2: Current CPU (ST) 01189

FIXME

NSC-3: Current Fileserver (ST) 01190

FIXME

NSC-4: Current Application (HD) 01191

FIXME

NSC-5: Current Facility (HD) 01192

FIXME

NSC-6: New CPU (ST) 01193

FIXME

NSC-7: New Fileserver (ST) 01194

FIXME

NSC-8: New Application (HD) 01195

FIXME

NSC-9: New Facility (HD) 01196

FIXME

NST - Application Control-Level Statistics Segment

The NST segment allows application control-level statistical information to be passed between the various systems on the network. Some fields in this segment refer to portions of lower level protocols; they contain information that can be used by application management applications monitoring the state of various network links.

Usage Notes: Fields 2-15. These are all marked optional since the statistics kept on a particular link and negotiated between the two systems in question will vary. Not all values will apply to each system. Some values are concerned with the type of port, and some values pertain to the lower level protocol.

HL7 Attribute Table - NST - Application Control-Level Statistics Segment
Seq#	Data Element Name	DataType	Usage	Vocabulary	Cardinality	Item #	Length
NST
1	Statistics Available	ID	R	0136(R) Yes/no Indicator(Required)	[1..1]	01173	[1..1]
2	Source Identifier	ST	O		[0..1]	01174
3	Source Type	ID	O	0332(R) Source Type(Required)	[0..1]	01175
4	Statistics Start	DTM	O		[0..1]	01176
5	Statistics End	DTM	O		[0..1]	01177
6	Receive Character Count	NM	O		[0..1]	01178
7	Send Character Count	NM	O		[0..1]	01179
8	Messages Received	NM	O		[0..1]	01180
9	Messages Sent	NM	O		[0..1]	01181
10	Checksum Errors Received	NM	O		[0..1]	01182
11	Length Errors Received	NM	O		[0..1]	01183
12	Other Errors Received	NM	O		[0..1]	01184
13	Connect Timeouts	NM	O		[0..1]	01185
14	Receive Timeouts	NM	O		[0..1]	01186
15	Application control-level Errors	NM	O		[0..1]	01187

NST-1: Statistics Available (ID) 01173

FIXME

NST-2: Source Identifier (ST) 01174

FIXME

NST-3: Source Type (ID) 01175

FIXME

NST-4: Statistics Start (DTM) 01176

FIXME

NST-5: Statistics End (DTM) 01177

FIXME

NST-6: Receive Character Count (NM) 01178

FIXME

NST-7: Send Character Count (NM) 01179

FIXME

NST-8: Messages Received (NM) 01180

FIXME

NST-9: Messages Sent (NM) 01181

FIXME

NST-10: Checksum Errors Received (NM) 01182

FIXME

NST-11: Length Errors Received (NM) 01183

FIXME

NST-12: Other Errors Received (NM) 01184

FIXME

NST-13: Connect Timeouts (NM) 01185

FIXME

NST-14: Receive Timeouts (NM) 01186

FIXME

NST-15: Application control-level Errors (NM) 01187

FIXME

outstanding issues

None.

Draft Website - For Review Purposes Only

Application Management

Introduction

Trigger Events and Message Definitions

NMQ - Application Management Query Message (Event N01)

Acknowledgement Choreography

NMD - Application Management Data Message (Event N02)

Original Mode Acknowledgement Choreography for NMD^N02^NMD_N02

Enhanced Mode Acknowledgement Choreography for NMD^N02^NMD_N02

message segments

NCK - System Clock Segment

NCK-1: System Date/Time (DTM) 01172

NSC - Application Status Change Segment

NSC-1: Application Change Type (CWE) 01188

NSC-2: Current CPU (ST) 01189

NSC-3: Current Fileserver (ST) 01190

NSC-4: Current Application (HD) 01191

NSC-5: Current Facility (HD) 01192

NSC-6: New CPU (ST) 01193

NSC-7: New Fileserver (ST) 01194

NSC-8: New Application (HD) 01195

NSC-9: New Facility (HD) 01196

NST - Application Control-Level Statistics Segment

NST-1: Statistics Available (ID) 01173

NST-2: Source Identifier (ST) 01174

NST-3: Source Type (ID) 01175

NST-4: Statistics Start (DTM) 01176

NST-5: Statistics End (DTM) 01177

NST-6: Receive Character Count (NM) 01178

NST-7: Send Character Count (NM) 01179

NST-8: Messages Received (NM) 01180

NST-9: Messages Sent (NM) 01181

NST-10: Checksum Errors Received (NM) 01182

NST-11: Length Errors Received (NM) 01183

NST-12: Other Errors Received (NM) 01184

NST-13: Connect Timeouts (NM) 01185

NST-14: Receive Timeouts (NM) 01186

NST-15: Application control-level Errors (NM) 01187

outstanding issues