#### HL7 V2 ADT
Message Specifications

### RSP - Get Person Demographics Response Tabular View

RSP_K21 |
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.
MSA [1..1] [R] |
MSA.1 [Acknowledgment Code] [1..1] [R] (ID) { Table : 0008-AcknowledgmentCode } | Definition: This field contains an acknowledgment code Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0008.
MSA.2 [Message Control ID] [1..1] [R] (ST) | Definition: This field contains the message control ID of the message sent by the sending system. It allows the sending system to associate this response with the message for which it is intended.
MSA.3 [Text Message] [0..1] [O] (ST) | Definition: This optional field further describes an error condition. This text may be printed in error logs or presented to an end user.
MSA.4 [Expected Sequence Number] [0..1] [O] (NM) | Definition: This optional numeric field is used in the sequence number protocol.
MSA.5 [Delayed Acknowledgment Type] [0..*] [B] (ID) | not used in ITK
MSA.6 [Error Condition] [0..1] [O] (CE) { Table : 0357-MessageErrorConditionCodes } | Definition: This field allows the acknowledging system to use a user-defined error code to further specify AR or AE type acknowledgments. This field is a generalized replacement for MSA-3-text message. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0357.
ERR [0..1] [O] |
ERR.1 [Error Code and Location] [1..*] [R] (ELD) | Definition: This field identifies an erroneous segment in another message. The second component is an index if there is more than one segment of type <segment ID>. For systems that do not use the HL7 Encoding Rules, the data item number may be used for the third component. The fourth component is Message error condition code.
QAK [1..1] [R] |
QAK.1 [Query Tag] [0..1] [C] (ST) | Definition: 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. If it is valued, the responding system is required to echo it back as the first field in the query acknowledgment segment (QAK).
QAK.2 [Query Response Status] [0..1] [O] (ID) { Table : 0208-QueryResponseStatus } | Definition: This field allows the responding system to return a precise response status. It is especially useful in the case where no data is found that matches the query parameters, but where there is also no error. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0208.
QAK.3 [Message Query Name] [0..1] [O] (CE) { Table : 0471-QueryName } | Definition: This field contains the name of the query. These names are assigned by the function-specific chapters of this specification. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0471.
QAK.4 [Hit Count] [0..1] [O] (NM) | Definition: This field, when used, contains the total number of records found by the Server that matched the query. For tabular responses, this is the number of rows found.
QAK.5 [This payload] [0..1] [O] (NM) | Definition: This field, when used, contains the total number of matching records that the Server sent in the current response.
QAK.6 [Hits remaining] [0..1] [O] (NM) | Definition: This field, when used, contains the number of matching records found by the Server that have yet to be sent. It is only meaningful when the Server uses the continuation protocol to transmit partial responses.
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.
QUERY_RESPONSE [0..*] [O] |
PID
PD1
PID [1..1] [R] |
PID.1 [Set ID - PID] [0..1] [O] (SI) | Definition: This field contains the number that identifies this transaction. For the first occurrence of the segment, the sequence number shall be one, for the second occurrence, the sequence number shall be two, etc.
PID.2 [Patient ID] [0..*] [X] (CX) | not used in ITK
PID.3 [Patient Identifier List] [1..*] [R] (CX) | Definition: This field contains the list of identifiers (one or more) used by the healthcare facility to uniquely identify a patient (e.g., NHS Number, medical record number, billing number, birth registry, national unique individual identifier, etc.). At least one patient identifier, common to both sender and receiver. Where a traced NHS number is available for a patient this MUST be included in the list.
PID.4 [Alternate Patient ID - PID] [0..1] [O] (CX) | Definition: This field has been retained for backward compatibility only. It is recommended to use PID-3 - patient identifier list for all patient identifiers. When used for backward compatibility, this field contains the alternate, temporary, or pending optional patient identifier to be used if needed - or additional numbers that may be required to identify a patient. Temporary Patient Number only
PID.5 [Patient Name] [1..*] [R] (XPN) | Definition: This field contains the names of the patient, the primary or legal name of the patient is reported first. Patient Name should use the XPN-7 field to indicate the type of name being carried.
PID.6 [Mother's Maiden Name] [0..1] [O] (XPN) | Definition: This field contains the family name under which the mother was born (i.e., before marriage). It is used to distinguish between patients with the same last name.
PID.7 [Date/Time Of Birth] [0..1] [O] (TS) | Definition: This field contains the patient's date and time of birth. Field Length: 17 characters. YYYYMMDDHHMM[+/-ZZZZ] Refer to NPFIT-FNT-TO-DQM-0032 IQAP Guidance on Unknown, Estimated and Default Birth Dates where DoB is not known.
PID.8 [Administrative Sex] [0..1] [O] (IS) { Table : 0001-AdministrativeSex } | Definition: This field contains the patient's sex. Field Length: 1 numeric character. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0001
PID.9 [Patient Alias] [0..*] [B] (XPN) | Definition: This field has been retained for backward compatibility only. It is recommended to use PID-5 - patient name for all patient names. This field contained the name(s) by which the patient has been known at some time. PID-9 is included for backward compatibility ONLY in the ITK this field must NOT be populated. Patient Alias should be carried in PID-5 and differentiated using ID Data type in the PID-5 XPN-7 field.
PID.10 [Race] [0..*] [X] (CE) | not used in ITK
PID.11 [Patient Address] [0..*] [O] (XAD) | Definition: This field contains the mailing address of the patient.
PID.12 [County Code] [0..*] [X] (IS) | not used in ITK
PID.13 [Phone Number - Home] [0..*] [O] (XTN) | Definition: This field contains the patient's personal phone numbers. All personal phone numbers for the patient are sent in the following sequence. The first sequence is considered the primary number (for backward compatibility). If the primary number is not sent, then a repeat delimiter is sent in the first sequence. Use XTN-2 (Telecoms Use Code) and XTN-3 (Telecoms Equipment Type) to determine primary landline, primary mobile etc.
PID.14 [Phone Number - Business] [0..*] [O] (XTN) | Definition: This field contains the patient's business telephone numbers. All business numbers for the patient are sent in the following sequence. The first sequence is considered the patient's primary business phone number (for backward compatibility). If the primary business phone number is not sent, then a repeat delimiter must be sent in the first sequence.
PID.15 [Primary Language] [0..1] [O] (CE) { Table : 0296-PrimaryLanguage } | Definition: This field contains the patient's primary language. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0296
PID.16 [Marital Status] [0..1] [O] (CE) { Table : 0002-MaritalStatus } | Definition: This field contains the patient's marital (civil) status. Field Length: 1 character. Refer to HSCIC ITK HL7 V2 Reference Tables Table - 0002
PID.17 [Religion] [0..1] [O] (CE) { Table : 0006-Religion } | Definition: This field contains the patient's religion, for example, Baptist, Catholic, Methodist, etc. Field Length: 15 characters. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0006
PID.18 [Patient Account Number] [0..*] [X] (CX) | not used in ITK
PID.19 [SSN Number - Patient] [0..*] [X] (ST) | not used in ITK
PID.20 [Driver's License Number - Patient] [0..*] [X] (DLN) | not used in ITK
PID.21 [Mother's Identifier] [0..*] [O] (CX) | Definition: This field is used, for example, as a link field for newborns. Typically a patient ID may be used. This field can contain multiple identifiers for the same mother.
PID.22 [Ethnic Group] [0..1] [O] (CE) { Table : 0189-EthnicGroup } | Definition: This field further defines the patient's ancestry. Field Length: 2 characters. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0189
PID.23 [Birth Place] [0..1] [O] (ST) | Definition: This field indicates the location of the patient's birth, for example "St. Francis Community Hospital of Lower South Side". The actual address is reported in PID-11 with an identifier of "N". Field Length: 35 characters.
PID.24 [Multiple Birth Indicator] [0..1] [O] (ID) { Table : 0136-Yes_noIndicator } | Definition: This field indicates whether the patient was part of a multiple birth. Field Length: 1 character. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0136
PID.25 [Birth Order] [0..1] [O] (NM) | Definition: When a patient was part of a multiple birth, a value (number) indicating the patient's birth order is entered in this field. Field Length: 1 character.
PID.26 [Citizenship] [0..1] [O] (CE) { Table : 0399-CountryCode } | Definition: This field contains the patient's country of citizenship. Field Length: 3 characters. This field is NOT to be used to carry Overseas Visitor Status - use ZU1-10 to carry OVS This field carries a country code and indicates the right of citizenship to that country. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0399
PID.27 [Veterans Military Status] [0..*] [X] (CE) | not used in ITK
PID.28 [Nationality] [0..1] [O] (CE) { Table : 0399-CountryCode } | Definition:This field contains a code that identifies the nation or national grouping to which the person belongs. This information may be different from a person's citizenship in countries in which multiple nationalities are recognized. Field Length: 3 characters.This field carries a country code and indicates the nationality of the patient Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0399.
PID.29 [Patient Death Date and Time] [0..1] [O] (TS) | Definition: This field contains the date and time at which the patient death occurred. Field Length: 17 characters YYYYMMDDHHMM[+/-ZZZZ]
PID.30 [Patient Death Indicator] [0..1] [O] (ID) { Table : 0136-Yes_noIndicator } | Definition: This field indicates whether the patient is deceased. Field Length: 1 character. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0136
PID.31 [Identity Unknown Indicator] [0..1] [O] (ID) { Table : 0136-Yes_noIndicator } | Definition: This field indicates whether or not the patient's/person's identity is known. Field Length: 1 character.
PID.32 [Identity Reliability Code] [0..*] [C] (IS) { Table : 0445-IdentityReliabilityCode } | Definition: This field contains a coded value used to communicate information regarding the reliability of patient/person identifying data transmitted via a transaction. Field Length: 6 characters. This is a repeating field which may carry any number of codes from table 0445, there is no positional logic associated with this field, and codes should not be associated with any particular repeat position. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0445.
PID.33 [Last Update Date/Time] [0..*] [X] (TS) | not used in ITK
PID.34 [Last Update Facility] [0..*] [X] (HD) | not used in ITK
PID.35 [Species Code] [0..*] [X] (CE) | not used in ITK
PID.36 [Breed Code] [0..*] [X] (CE) | not used in ITK
PID.37 [Strain] [0..*] [X] (ST) | not used in ITK
PID.38 [Production Class Code] [0..*] [X] (CE) | not used in ITK
PD1 [0..1] [O] |
PD1.1 [Living Dependency] [0..*] [X] (IS) | not used in ITK
PD1.2 [Living Arrangement] [0..*] [X] (IS) | not used in ITK
PD1.3 [Patient Primary Facility] [0..2] [C] (XON) | Definition: This field contains the name and identifier that specifies the "primary care" healthcare facility. First iteration is for GP Practice, Second iteration is for Surgery. At least the first iteration should be sent where recorded against a patient record. This component is required if it is the surgery (second repetition) and there is no code available (local agreement)
PD1.4 [Patient Primary Care Provider Name & ID No.] [0..1] [O] (XCN) | Definition: This field contained the provider name and ID of the primary care provider.
PD1.5 [Student Indicator] [0..*] [X] (ID) | not used in ITK
PD1.6 [Handicap] [0..*] [X] (IS) | not used in ITK
PD1.7 [Living Will Code] [0..*] [X] (IS) | not used in ITK
PD1.8 [Organ Donor Code] [0..*] [X] (IS) | not used in ITK
PD1.9 [Separate Bill] [0..*] [X] (ID) | not used in ITK
PD1.10 [Duplicate Patient] [0..*] [X] (CX) | not used in ITK
PD1.11 [Publicity Code] [0..*] [X] (CE) | not used in ITK
PD1.12 [Protection Indicator] [0..*] [X] (ID) | not used in ITK This field must NOT be populated in the ITK and PD1:12 included for backward compatibility ONLY. Now carried in ZU8.
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.