MSH
MSH: Message Header
Definition
Segment | Field | Opt | RP/# | Component | Description | Example |
---|---|---|---|---|---|---|
MSH |
|
|
|
| Message header |
|
| MSH-3 | O |
|
| Sending application. Note that for inbound ORU R01 messages this field is used to determine whether the message contains radiology information. See the ORU R01 specification for more information. |
|
|
|
|
| MSH-3.1 | Sending application name | PAS |
| MSH-4 | O |
|
| Sending facility. If you configure org and/or team aliases with PKB, the value in this field will be mapped to a whitelisted organisation or team in PKB, and this message will be treated as coming from that organisation or team. |
|
|
|
|
| MSH-4.1 | Sending facility name | MyFacility |
| MSH-5 | O |
|
| 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 | O |
|
| 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 | R |
|
| Message timestamp. This will be set into [[Data Point.Entered Timestamp]] for data extracted from HL7 messages. Sending an offset in MSH-7 is discouraged; please see our notes on time stamp handling for more information. |
|
|
|
|
| MSH-7.1 | Message timestamp | 20210521092210 |
| MSH-9 | R |
|
| Message type |
|
|
|
|
| MSH-9.1 | Message type | QRY |
|
|
|
| MSH-9.2 | Trigger event | A19 |
| MSH-10 | R |
|
| 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 | 4003ace9-ab29-4a97-a76a-69d45052dbc6 |
| MSH-11 | R |
|
| Processing ID |
|
|
|
|
| MSH-11.1 | Processing ID. This must be P for our production server. | P |
| MSH-12 | O |
|
| Version ID. We do not use this field. Our message definitions are not dependent on version number. |
|
| MSH-22 | O |
|
| Responsible Organisation |
|
|
|
|
| MSH-22.10 | Responsible Organisation Identifier | org.id.123 |
PKB customer sites: deploy | developer | information governance | procurement | manual
© Patients Know Best, Ltd. Registered in England and Wales Number: 6517382. VAT Number: GB 944 9739 67.
This API specification and design is licensed under a Creative Commons Attribution 4.0 International License.