HL7 - REFACTORED

18.8.90 NST - Application Control-Level Statistics Segment (14.4.3)

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 (new)
(base framework)
Segment (new)
(w/o profiles)
Segment (new)
(w/ profiles)
Segment (classic)
(w/ profiles)
Segment (classic)
(w/o profiles)
FHIR
Structure Definition
v2.xml
XSD

Base Framework
	Seq#	Data Element	Description	Flags	Implement	Cardinality	Length	C.LEN	Vocabulary	Data Type
NST
	1	01173	Statistics Available		SHALL	[1..1]	[1..1]		univ: Yes/noIndicator (CD) hl7VS-yes-no-Indicator (VS) expandedYes-NoIndicator (CS)	ID Coded Value for HL7 Defined Tables
	2	01174	Source Identifier		MAY	[0..1]				ST String Data
	3	01175	Source Type		MAY	[0..1]			univ: SourceType (CD) hl7VS-networkSourceType (VS) sourceType (CS)	ID Coded Value for HL7 Defined Tables
	4	01176	Statistics Start		MAY	[0..1]				DTM Date/Time
	5	01177	Statistics End		MAY	[0..1]				DTM Date/Time
	6	01178	Receive Character Count		MAY	[0..1]				NM Numeric
	7	01179	Send Character Count		MAY	[0..1]				NM Numeric
	8	01180	Messages Received		MAY	[0..1]				NM Numeric
	9	01181	Messages Sent		MAY	[0..1]				NM Numeric
	10	01182	Checksum Errors Received		MAY	[0..1]				NM Numeric
	11	01183	Length Errors Received		MAY	[0..1]				NM Numeric
	12	01184	Other Errors Received		MAY	[0..1]				NM Numeric
	13	01185	Connect Timeouts		MAY	[0..1]				NM Numeric
	14	01186	Receive Timeouts		MAY	[0..1]				NM Numeric
	15	01187	Application control-level Errors		MAY	[0..1]				NM Numeric

	Seq#	Data Element	Description	Implement	Cardinality	Length	Vocabulary	Data Type
NST
	1	01173	Statistics Available	SHALL	[1..1]	[1..1]	univ: Yes/noIndicator (CD) hl7VS-yes-no-Indicator (VS) expandedYes-NoIndicator (CS)	ID Coded Value for HL7 Defined Tables
	2	01174	Source Identifier	MAY	[0..1]			ST String Data
	3	01175	Source Type	MAY	[0..1]		univ: SourceType (CD) hl7VS-networkSourceType (VS) sourceType (CS)	ID Coded Value for HL7 Defined Tables
	4	01176	Statistics Start	MAY	[0..1]			DTM Date/Time
	5	01177	Statistics End	MAY	[0..1]			DTM Date/Time
	6	01178	Receive Character Count	MAY	[0..1]			NM Numeric
	7	01179	Send Character Count	MAY	[0..1]			NM Numeric
	8	01180	Messages Received	MAY	[0..1]			NM Numeric
	9	01181	Messages Sent	MAY	[0..1]			NM Numeric
	10	01182	Checksum Errors Received	MAY	[0..1]			NM Numeric
	11	01183	Length Errors Received	MAY	[0..1]			NM Numeric
	12	01184	Other Errors Received	MAY	[0..1]			NM Numeric
	13	01185	Connect Timeouts	MAY	[0..1]			NM Numeric
	14	01186	Receive Timeouts	MAY	[0..1]			NM Numeric
	15	01187	Application control-level Errors	MAY	[0..1]			NM Numeric

Base Framework											Base Standard Profile
	Seq#	Data Element	Description	Flags	Implement	Cardinality	Length	C.LEN	Vocabulary	Data Type	Implement	Vocabulary
NST
	1	01173	Statistics Available		SHALL	[1..1]	[1..1]		univ: Yes/noIndicator (CD) hl7VS-yes-no-Indicator (VS) expandedYes-NoIndicator (CS)	ID Coded Value for HL7 Defined Tables	SHALL
	2	01174	Source Identifier		MAY	[0..1]				ST String Data	MAY
	3	01175	Source Type		MAY	[0..1]			univ: SourceType (CD) hl7VS-networkSourceType (VS) sourceType (CS)	ID Coded Value for HL7 Defined Tables	MAY
	4	01176	Statistics Start		MAY	[0..1]				DTM Date/Time	MAY
	5	01177	Statistics End		MAY	[0..1]				DTM Date/Time	MAY
	6	01178	Receive Character Count		MAY	[0..1]				NM Numeric	MAY
	7	01179	Send Character Count		MAY	[0..1]				NM Numeric	MAY
	8	01180	Messages Received		MAY	[0..1]				NM Numeric	MAY
	9	01181	Messages Sent		MAY	[0..1]				NM Numeric	MAY
	10	01182	Checksum Errors Received		MAY	[0..1]				NM Numeric	MAY
	11	01183	Length Errors Received		MAY	[0..1]				NM Numeric	MAY
	12	01184	Other Errors Received		MAY	[0..1]				NM Numeric	MAY
	13	01185	Connect Timeouts		MAY	[0..1]				NM Numeric	MAY
	14	01186	Receive Timeouts		MAY	[0..1]				NM Numeric	MAY
	15	01187	Application control-level Errors		MAY	[0..1]				NM Numeric	MAY

Base Framework											Base Standard Profile
	Seq#	Data Element	Description	Flags	Optionality	Repetition	Length	C.LEN	Table	Data Type	Optionality	Table
NST
	1	01173	Statistics Available		O		[1..1]		(0136)	ID Coded Value for HL7 Defined Tables	R
	2	01174	Source Identifier		O					ST String Data
	3	01175	Source Type		O					ID Coded Value for HL7 Defined Tables		(0332)
	4	01176	Statistics Start		O					DTM Date/Time
	5	01177	Statistics End		O					DTM Date/Time
	6	01178	Receive Character Count		O					NM Numeric
	7	01179	Send Character Count		O					NM Numeric
	8	01180	Messages Received		O					NM Numeric
	9	01181	Messages Sent		O					NM Numeric
	10	01182	Checksum Errors Received		O					NM Numeric
	11	01183	Length Errors Received		O					NM Numeric
	12	01184	Other Errors Received		O					NM Numeric
	13	01185	Connect Timeouts		O					NM Numeric
	14	01186	Receive Timeouts		O					NM Numeric
	15	01187	Application control-level Errors		O					NM Numeric

	Seq#	Data Element	Description	Optionality	Length	Table	Data Type
NST
	1	01173	Statistics Available	R	[1..1]	(0136)	ID Coded Value for HL7 Defined Tables
	2	01174	Source Identifier	O			ST String Data
	3	01175	Source Type	O		(0332)	ID Coded Value for HL7 Defined Tables
	4	01176	Statistics Start	O			DTM Date/Time
	5	01177	Statistics End	O			DTM Date/Time
	6	01178	Receive Character Count	O			NM Numeric
	7	01179	Send Character Count	O			NM Numeric
	8	01180	Messages Received	O			NM Numeric
	9	01181	Messages Sent	O			NM Numeric
	10	01182	Checksum Errors Received	O			NM Numeric
	11	01183	Length Errors Received	O			NM Numeric
	12	01184	Other Errors Received	O			NM Numeric
	13	01185	Connect Timeouts	O			NM Numeric
	14	01186	Receive Timeouts	O			NM Numeric
	15	01187	Application control-level Errors	O			NM Numeric

18.8.90.1 NST Field Definitions (14.4.3.0)

18.8.90.2 NST-1 Statistics Available (ID) 01173 (14.4.3.1)

Definition: This field indicates the availability of statistics. Refer to HL7 Table 0136 - Yes/no Indicator for valid values.

N - the responding application does not keep any statistics. If the value "N" is specified, the response message is used to signify to the initiating application that the communication link between the initiating application and the responding application is operational (and fields 2-15 are empty in the response message).

Y - the responding application does keep statistics, fields 4 and 5 are required (and the response message contains one or more not empty or not unvalued fields in the range 2-3, 6-15).

18.8.90.3 NST-2 Source Identifier (ST) 01174 (14.4.3.2)

Definition: This field identifies a particular lower level link (e.g., a port number).

18.8.90.4 NST-3 Source Type (ID) 01175 (14.4.3.3)

Definition: This field identifies (in certain systems) whether a lower level source identifier is an initiate or accept type. Refer to HL7 Table 0332 - Source Type in Chapter 2C, Code Tables, for valid values.

18.8.90.5 NST-4 Statistics Start (DTM) 01176 (14.4.3.4)

Definition: This field contains the date/time stamp of the start of the collection of the statistics reported in fields 6-15 of this segment. It is strongly recommended that this value include seconds.

18.8.90.6 NST-5 Statistics End (DTM) 01177 (14.4.3.5)

Definition: This field contains the date/time stamp of the end of the statistics collection period reported in fields 6-15 of this segment. It is strongly recommended that this value include seconds.

18.8.90.7 NST-6 Receive Character Count (NM) 01178 (14.4.3.6)

Definition: This field contains the number of characters received.

18.8.90.8 NST-7 Send Character Count (NM) 01179 (14.4.3.7)

Definition: This field contains the number of characters sent.

18.8.90.9 NST-8 Messages Received (NM) 01180 (14.4.3.8)

Definition: This field contains the number of messages received.

18.8.90.10 NST-9 Messages Sent (NM) 01181 (14.4.3.9)

Definition: This field contains the number of messages sent.

18.8.90.11 NST-10 Checksum Errors Received (NM) 01182 (14.4.3.10)

Definition: This field contains the number of messages received with checksum errors.

18.8.90.12 NST-11 Length Errors Received (NM) 01183 (14.4.3.11)

Definition: This field contains the number of messages received with length errors.

18.8.90.13 NST-12 Other Errors Received (NM) 01184 (14.4.3.12)

Definition: This field contains the number of "other" invalid messages received (excluding length and checksum errors).

18.8.90.14 NST-13 Connect Timeouts (NM) 01185 (14.4.3.13)

Definition: This field contains the number of connect timeout errors.

18.8.90.15 NST-14 Receive Timeouts (NM) 01186 (14.4.3.14)

Definition: This field contains the number of timeouts while waiting for a response to an initiated message.

18.8.90.16 NST-15 Application Control-level Errors (NM) 01187 (14.4.3.15)

Definition: This field contains the number of application control-level errors in response to an initiated message.