Developer documentation‎ > ‎HL7 API‎ > ‎Segments‎ > ‎

MSH


MSH: Message Header

Definition

Segment Field Component Description Example
MSH

Message header

[ MSH-3 ]
Sending application. Note that for inbound ORU R01 messages this field is used to determine whether the message contains radiology information. See the test results specification for more information.


MSH-3.1 Sending application name PAS

[ MSH-4 ]
Sending facility. If you configure org and/or team aliases with PKB, the values in this field will be mapped to whitelisted organization or teams in PKB, and this message will be treated as coming from that organization or team.

Although optional ordinarily, if aliases are configured then this field value is required and must match a defined alias.



MSH-4.1 Sending facility name MyFacility

[ MSH-5 ]
Receiving application. We do not use this field; you are welcome to send through whatever is convenient. There is only one PKB instance behind the HL7 endpoint, so no routing is required.

[ MSH-6 ]
Receiving facility. We do not use this field; you are welcome to send through whatever is convenient. There is only one PKB instance behind the HL7 endpoint, so no routing is required.

MSH-7
Message timestamp. Sending an offset in MSH-7 is discouraged; please see here for more information.


MSH-7.1 Message timestamp 201508011314

MSH-9
Message type


MSH-9.1 Message type QRY


MSH-9.2 Trigger event A19

MSH-10
Message control ID. This must be unique for all messages sent to PKB by each sender. However, PKB does not currently detect or reject duplicate messages based on this value, so it is important that each sender enforces this themselves.


MSH-10.1 Message control ID ABC0000000001

MSH-11
Processing ID


MSH-11.1 Processing ID. This must be P for our production server. P

[ MSH-12 ]
Version ID. We do not use this field. Our message definitions are not dependent on version number.


Comments