#### HL7 V2 ADT
Message Specifications

### QBP - Find Candidates Tabular View

QBP_Q22 |
MSH [1..1] [R] |
MSH.1 [Field Separator] [1..1] [R] (ST) | Definition: This field contains the separator between the segment ID and the first real field, MSH-2-encoding characters. As such it serves as the separator and defines the character to be used as a separator for the rest of the message. Recommended value is |, (ASCII 124).
MSH.2 [Encoding Characters] [1..1] [R] (ST) | Definition: This field contains the four characters in the following order: the component separator, repetition separator, escape character, and subcomponent separator. Recommended values are ^~\& (ASCII 94, 126, 92, and 38, respectively). These encoding characters is valid only for pipe-and-hat encoding. When message is translated into XML these encoding characters are carried in MSH.2 element.
MSH.3 [Sending Application] [1..1] [R] (HD) { Table : 0361-Application } | Definition: This field uniquely identifies the sending application among all other applications within the network enterprise.
MSH.4 [Sending Facility] [1..1] [R] (HD) { Table : 0362-Facility } | Definition: This field further describes the sending application, MSH-3-sending application. ITK compliant systems use 3 characters ODS code for NHS organization. 5 Character codes may also be used when there are more than one sending facilities within NHS organization or this field is used to carry data at more granular level.
MSH.5 [Receiving Application] [1..1] [R] (HD) { Table : 0361-Application } | Definition: This field uniquely identifies the receiving application among all other applications within the network enterprise. Where the message is being broadcast by PAS to a number of consumer systems via the toolkit, this field should be populated with 'ROUTE' to indicate that the toolkit will take responsibility for onward routing.
MSH.6 [Receiving Facility] [1..1] [R] (HD) { Table : 0362-Facility } | Definition: This field identifies the receiving application among multiple identical instances of the application running on behalf of different organizations. ITK compliant systems use 3 character ODS code for NHS organization, or in the case of broadcast (see note above) may populate with 'ROUTE'. 5 Character codes may also be used when there are more than one receiving facilities within NHS organization or this field is used to carry data at more granular level.
MSH.7 [Date/Time of Message] [1..1] [R] (TS) | Definition: This field contains the date/time that the sending system created the message. If the time zone is specified, it will be used throughout the message as the default time zone. To ensure consistency of message processing all participating systems should be registered on the same consistent time server.
MSH.8 [Security] [0..*] [X] (ST) | not used in ITK
MSH.9 [Message Type] [1..1] [R] (MSG) | Definition: This field contains the message type, trigger event, and the message structure ID for the message. Note, it is important to ensure that the correct format is used in this field. The toolkit uses the third element e.g. ADT_A01 to select the appropriate WSDL and Schema for message handling.
MSH.10 [Message Control ID] [1..1] [R] (ST) | Definition: This field contains a number or other identifier that uniquely identifies the message. The receiving system echoes this ID back to the sending system in the Message acknowledgment segment (MSA).
MSH.11 [Processing ID] [1..1] [R] (PT) | Definition: This field is used to decide whether to process the message as defined in HL7 Application (level 7) Processing rules. The first component defines whether the message is part of a production, training, or debugging system.
MSH.12 [Version ID] [1..1] [R] (VID) | Definition: This field is matched by the receiving system to its own version to be sure the message will be interpreted correctly.
MSH.13 [Sequence Number] [0..1] [O] (NM) | Definition: A non-null value in this field implies that the sequence number protocol is in use. This numeric field is incremented by one for each subsequent value. In a multi-hop environment, it is possible that messages may be received out of sequence. This number can be used in conjunction with the Date/Time Value to assist in the identification of messaging which happens out of sequence. Further detail on this can be found in the accompanying document 01 - ITK - Toolkit Architecture Overview.
MSH.14 [Continuation Pointer] [0..1] [O] (ST) | Definition: This field is used to define continuations in application-specific ways. Only the sender of a fragmented message values this field.
MSH.15 [Accept Acknowledgment Type] [0..*] [X] (ID) | not supported in ITK
MSH.16 [Application Acknowledgment Type] [0..*] [X] (ID) | not supported in ITK
MSH.17 [Country Code] [1..1] [R] (ID) { Table : 0399-CountryCode } | Definition: This field contains the country of origin for the message. Field Length: 3 characters. e.g. 'GBR' Use ISO 3166-1 Alpha 3 (3 character codes). Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0399
MSH.18 [Character Set] [0..1] [C] (ID) { Table : 0211-AlternateCharacterSets } | Definition: This field contains the character set for the entire message. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0211.
MSH.19 [Prinicipal Language of Message] [1..1] [R] (CE) { Table : 0296-PrimaryLanguage } | Definition: This field contains the principal language of the message. Field Length: 2 characters. e.g. 'EN' Use ISO Table 639-1 Alpha 2 (2 character codes). Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0296.
MSH.20 [Alternate Character Set Handling Scheme] [0..*] [X] (ID) | not used in ITK
MSH.21 [Message Profile Identifier] [1..*] [R] (ID) | Definition: Sites use this field to assert adherence to a Conformance Statement published by ITK. This is a mandatory specification conformance statement, indicates which version of the ITK the message is compliant with e.g. ITKv1.0.
QPD [1..1] [R] |
QPD.1 [Message Query Name] [1..1] [R] (CE) { Table : 0471-QueryName } | Definition: Identifies the name of the query. It is an identifier of the conformance statement for this query. This field shall contain the same value specified in QID-2. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0471.
QPD.2 [Query Tag] [0..1] [C] (ST) | Definition: Identifies instance of the query. This field may be valued by the initiating system to identify the query, and may be used to match response messages to the originating query.
QPD.3 [User Parameters (in successive fields)] [0..*] [O] (varies) | This field contains query critiera.
RCP [1..1] [R] |
RCP.1 [Query Priority] [0..1] [O] (ID) { Table : 0091-QueryPriority } | Definition: This field contains the time frame in which the response is expected. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0091.
RCP.2 [Quantity Limited Request] [0..1] [O] (CQ) { Table : 0126-QuantityLimitedRequest } | Definition: This field contains the maximum length of the response that can be accepted by the requesting system. Valid entries are numerical values (in the first component) given in the units specified in the second component. This is where a locally defined value for restricting the amount of records returned is displayed. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0126.
RCP.3 [Response Modality] [0..1] [O] (CE) { Table : 0394-ResponseModality } | Definition: This field specifies the timing and grouping of the response message(s). Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0394.
RCP.4 [Execution and Delivery Time] [0..1] [C] (TS) | Specifies the time the response is to be returned. This field is only valued when RCP-1-Query priority contains the value D (Deferred).
RCP.5 [Modify Indicator] [0..1] [O] (ID) { Table : 0395-ModifyIndicator } | Definition: This field specifies whether the subscription is new or is being modified. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0395.
RCP.6 [Sort-by Field] [0..*] [O] (SRT) | Definition: For queries requesting a tabular response, this field specifies by which fields the response is to be sorted, and the order(s) in which sorting is to be performed.
RCP.7 [Segment group inclusion] [0..*] [O] (ID) { Table : 0391-SegmentGroup } | Definition: Specifies those optional segment groups which are to be included in the response. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0391.
DSC [0..1] [O] |
DSC.1 [Continuation Pointer] [0..1] [O] (ST) | Definition: This field contains the continuation pointer. In an initial query, this field is not present. If the responder returns a value of null or not present, then there is no more data to fulfill any future continuation requests.
DSC.2 [Continuation Style] [0..1] [O] (ID) { Table : 0398-ContinuationStyleCode } | Definition: Indicates whether this is a fragmented message OR if it is part of an interactive continuation message. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0398.