#### HL7 V2 ADT
Message Specifications

### Cancel Pending Admit Tabular View

ADT_A27 |
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.
EVN [1..1] [R] |
EVN.1 [Event Type Code] [0..*] [X] (ID) | not used in ITK
EVN.2 [Recorded Date/Time] [1..1] [R] (TS) | Definition: Most systems will default to the system date/time when the transaction was entered.
EVN.3 [Date/Time Planned Event] [0..*] [X] (TS) | not used in ITK
EVN.4 [Event Reason Code] [0..*] [X] (IS) | not used in ITK
EVN.5 [Operator ID] [0..1] [O] (XCN) | Definition: This field identifies the individual responsible for triggering the event. Operator ID field carry information about clinical/non-clinical operator who triggered the event.
EVN.6 [Event Occurred] [1..1] [R] (TS) | Definition: This field contains the date/time that the event actually occurred. For example, on a transfer (A02 transfer a patient), this field would contain the date/time the patient was actually transferred. On a cancellation event, this field should contain the date/time that the event being cancelled occurred. Recording the actual time of the event rather than the time the message was generated can be used to help ensure that process of sequencing on an episode basis can be reconstructed if necessary to deal with the possibility of events being received out of sequence. Further guidance is available in the accompanying document 01 - ITK - Toolkit Architecture Overview.
EVN.7 [Event Facility] [0..*] [X] (HD) | not used in ITK
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.
PV1 [1..1] [R] |
PV1.1 [Set ID - PV1] [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.
PV1.2 [Patient Class] [1..1] [R] (IS) { Table : 0004-PatientClass } | Definition: This field is used by systems to categorize patients by site. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0004
PV1.3 [Assigned Patient Location] [0..1] [O] (PL) | Definition: This field contains the patient's initial assigned location or the location to which the patient is being moved. The first component may be the nursing station for inpatient locations, or clinic or department, for locations other than inpatient. For canceling a transaction or discharging a patient, the current location (after the cancellation event or before the discharge event) should be in this field.
PV1.4 [Admission Type] [0..1] [O] (IS) { Table : 0007-AdmissionType } | Definition: This field indicates the circumstances under which the patient was or will be admitted. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0007
PV1.5 [Preadmit Number] [0..*] [X] (CX) | not used in ITK
PV1.6 [Prior Patient Location] [0..1] [O] (PL) | Definition: This field contains the prior patient location if the patient is being transferred. The old location is null if the patient is new.
PV1.7 [Attending Doctor] [0..1] [O] (XCN) { Table : 0010-PhysicianID } | Definition: This field contains the attending physician information. National GP / Consultant Code Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0010
PV1.8 [Referring Doctor] [0..1] [O] (XCN) { Table : 0010-PhysicianID } | Definition: This field contains the referring physician information. National GP / Consultant Code Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0010
PV1.9 [Consulting Doctor] [0..*] [O] (XCN) { Table : 0010-PhysicianID } | Definition: This field contains the consulting physician information. This is the consultant in charge of the care spell. The first one being the main consultant. In the cases of shared care it is a list of the separate consultants. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0010
PV1.10 [Hospital Service] [0..1] [O] (CE) { Table : 0069-HospitalService } | Definition: This field contains the treatment or type of surgery that the patient is scheduled to receive. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0069.
PV1.11 [Temporary Location] [0..*] [X] (PL) | not used in ITK
PV1.12 [Preadmit Test Indicator] [0..*] [X] (IS) | not used in ITK
PV1.13 [Re-admission Indicator] [0..1] [O] (IS) { Table : 0092-Re-AdmissionIndicator } | Definition: This field indicates that a patient is being re-admitted to the healthcare facility and gives the circumstances. We suggest using "R" for readmission or else null. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0092
PV1.14 [Admit Source] [0..1] [O] (CE) { Table : 0023-AdmitSource } | Definition: This field indicates where the patient was admitted. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0023.
PV1.15 [Ambulatory Status] [0..*] [O] (IS) { Table : 0009-AmbulatoryStatus } | Definition: This field indicates any permanent or transient handicapped conditions. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0009.
PV1.16 [VIP Indicator] [0..1] [O] (IS) { Table : 0099-VIPIndicator } | Definition: This field identifies the type of VIP. Field Length: 1 character. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0099.
PV1.17 [Admitting Doctor] [0..1] [O] (XCN) { Table : 0010-PhysicianID } | Definition: This field contains the admitting physician information. This is the Doctor who made the decision to admit. The responsible HCP. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0010.
PV1.18 [Patient Type] [0..1] [O] (IS) { Table : 0018-PatientType } | Definition: This field contains site-specific values that identify the patient type. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0018.
PV1.19 [Visit Number] [0..1] [O] (CX) | Definition: This field contains the unique number assigned to each patient visit. This is a unique number representing the actual visit by a patient. The number shall be unique within assigning authority and number type.
PV1.20 [Financial Class] [0..*] [X] (FC) | not used in ITK
PV1.21 [Charge Price Indicator] [0..*] [X] (IS) | not used in ITK
PV1.22 [Courtesy Code] [0..*] [X] (IS) | not used in ITK
PV1.23 [Credit Rating] [0..*] [X] (IS) | not used in ITK
PV1.24 [Contract Code] [0..*] [X] (IS) | not used in ITK
PV1.25 [Contract Effective Date] [0..*] [X] (DT) | not used in ITK
PV1.26 [Contract Amount] [0..*] [X] (NM) | not used in ITK
PV1.27 [Contract Period] [0..*] [X] (NM) | not used in ITK
PV1.28 [Interest Code] [0..*] [X] (IS) | not used in ITK
PV1.29 [Transfer to Bad Debt Code] [0..*] [X] (IS) | not used in ITK
PV1.30 [Transfer to Bad Debt Date] [0..*] [X] (DT) | not used in ITK
PV1.31 [Bad Debt Agency Code] [0..*] [X] (IS) | not used in ITK
PV1.32 [Bad Debt Transfer Amount] [0..*] [X] (NM) | not used in ITK
PV1.33 [Bad Debt Recovery Amount] [0..*] [X] (NM) | not used in ITK
PV1.34 [Delete Account Indicator] [0..*] [X] (IS) | not used in ITK
PV1.35 [Delete Account Date] [0..*] [X] (DT) | not used in ITK
PV1.36 [Discharge Disposition] [0..1] [O] (IS) { Table : 0112-DischargeDisposition } | Definition: This field contains the disposition of the patient at time of discharge (i.e., discharged to home, expired, etc.).
PV1.37 [Discharged to Location] [0..1] [O] (DLD) { Table : 0113-DischargedToLocation } | Definition: This field indicates the healthcare facility to which the patient was discharged. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0113
PV1.38 [Diet Type] [0..1] [O] (CE) { Table : 0114-DietType } | Definition: This field indicates a special diet type for a patient.
PV1.39 [Servicing Facility] [0..*] [X] (IS) | not used in ITK
PV1.40 [Bed Status] [0..*] [X] (IS) | not used in ITK
PV1.41 [Account Status] [0..*] [X] (IS) | not used in ITK
PV1.42 [Pending Location] [0..*] [X] (PL) | not used in ITK
PV1.43 [Prior Temporary Location] [0..*] [X] (PL) | not used in ITK
PV1.44 [Admit Date/Time] [0..1] [C] (TS) | Definition: This field contains the admit date/time. It is to be used if the event date/time is different than the admit date and time, i.e., a retroactive update. This field is also used to reflect the date/time of an outpatient/emergency patient registration. The Admit Date/Time is conditionally required by this Standard in those events where it should be present. For example, it might not be present in an A05 - Pre Admit a Patient, however PV2-8 Expected Admit Date would be populated
PV1.45 [Discharge Date/Time] [0..1] [C] (TS) | Definition: This field contains the discharge date/time. It is to be used if the event date/time is different than the discharge date and time, that is, a retroactive update. This field is also used to reflect the date/time of an outpatient/emergency patient discharge. The Discharge Date/Time is conditionally required by this Standard in those events where it should be present. For example, it would not be present in an A05 - Pre Admit a Patient; however it should be present in an A03 - Discharge a Patient.
PV1.46 [Current Patient Balance] [0..*] [X] (NM) | not used in ITK
PV1.47 [Total Charges] [0..*] [X] (NM) | not used in ITK
PV1.48 [Total Adjustments] [0..*] [X] (NM) | not used in ITK
PV1.49 [Total Payments] [0..*] [X] (NM) | not used in ITK
PV1.50 [Alternate Visit ID] [0..1] [O] (CX) { Table : 0203} | Definition: This field contains the alternative, temporary, or pending optional visit ID number to be used if needed.
PV1.51 [Visit Indicator] [0..*] [X] (IS) | not used in ITK
PV1.52 [Other Healthcare Provider] [0..*] [X] (XCN) | not used in ITK
PV2 [0..1] [O] |
PV2.1 [Prior Pending Location] [0..*] [X] (PL) | not used in ITK
PV2.2 [Accommodation Code] [0..*] [X] (CE) | not used in ITK
PV2.3 [Admit Reason] [0..1] [O] (CE) { Table : ZU001-AdmitReason } | Definition: This field contains the short description of the reason for patient admission. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU001
PV2.4 [Transfer Reason] [0..1] [O] (CE) { Table : ZU036-TransferReason } | Definition: This field contains the short description of the reason for a patient location change. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU036
PV2.5 [Patient Valuables] [0..*] [X] (ST) | not used in ITK
PV2.6 [Patient Valuables Location] [0..*] [X] (ST) | not used in ITK
PV2.7 [Visit User Code] [0..*] [X] (IS) | not used in ITK
PV2.8 [Expected Admit Date/Time] [0..1] [C] (TS) | Definition: This field contains the date and time that the patient is expected to be admitted. This field is also used to reflect the date/time of an outpatient/emergency patient registration. This field is conditionally required by this standard. It is required in A05 Pre-Admit a Patient and A14 - Pending Admit messages.
PV2.9 [Expected Discharge Date/Time] [0..1] [C] (TS) | Definition: This field contains the date and time that the patient is expected to be discharged. This field is also used to reflect the anticipated discharge date/time of an outpatient/emergency patient, or an inpatient. This field is conditionally required by this standard. It is required in A16 - Pending Discharge messages.
PV2.10 [Estimated Length of Inpatient Stay] [0..*] [X] (NM) | not used in ITK
PV2.11 [Actual Length of Inpatient Stay] [0..*] [X] (NM) | not used in ITK
PV2.12 [Visit Description] [0..1] [O] (ST) | Definition: This field contains a brief user-defined description of the visit.
PV2.13 [Referral Source Code] [0..*] [X] (XCN) | not used in ITK
PV2.14 [Previous Service Date] [0..*] [X] (DT) | not used in ITK
PV2.15 [Employment Illness Related Indicator] [0..*] [X] (ID) | not used in ITK
PV2.16 [Purge Status Code] [0..*] [X] (IS) | not used in ITK
PV2.17 [Purge Status Date] [0..*] [X] (DT) | not used in ITK
PV2.18 [Special Program Code] [0..*] [X] (IS) | not used in ITK
PV2.19 [Retention Indicator] [0..*] [X] (ID) | not used in ITK
PV2.20 [Expected Number of Insurance Plans] [0..*] [X] (NM) | not used in ITK
PV2.21 [Visit Publicity Code] [0..*] [X] (IS) | not used in ITK
PV2.22 [Visit Protection Indicator] [0..*] [X] (ID) | not used in ITK
PV2.23 [Clinic Organization Name] [0..*] [X] (XON) | not used in ITK
PV2.24 [Patient Status Code] [0..*] [X] (IS) | not used in ITK
PV2.25 [Visit Priority Code] [0..1] [O] (IS) { Table : 0217-VisitPriorityCode } | Definition: This field contains the priority of the visit. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0217
PV2.26 [Previous Treatment Date] [0..*] [X] (DT) | not used in ITK
PV2.27 [Expected Discharge Disposition] [0..*] [X] (IS) | not used in ITK
PV2.28 [Signature on File Date] [0..*] [X] (DT) | not used in ITK
PV2.29 [First Similar Illness Date] [0..*] [X] (DT) | not used in ITK
PV2.30 [Patient Charge Adjustment Code] [0..*] [X] (CE) | not used in ITK
PV2.31 [Recurring Service Code] [0..*] [X] (IS) | not used in ITK
PV2.32 [Billing Media Code] [0..*] [X] (ID) | not used in ITK
PV2.33 [Expected Surgery Date and Time] [0..*] [X] (TS) | not used in ITK
PV2.34 [Military Partnership Code] [0..*] [X] (ID) | not used in ITK
PV2.35 [Military Non-Availability Code] [0..*] [X] (ID) | not used in ITK
PV2.36 [Newborn Baby Indicator] [0..*] [X] (ID) | not used in ITK
PV2.37 [Baby Detained Indicator] [0..*] [X] (ID) | not used in ITK
PV2.38 [Mode of Arrival Code] [0..1] [O] (CE) { Table : 0430-ModeOfArrivalCode } | Definition: Identifies how the patient was brought to the healthcare facility. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0430
PV2.39 [Recreational Drug Use Code] [0..*] [X] (CE) | not used in ITK
PV2.40 [Admission Level of Care Code] [0..*] [X] (CE) | not used in ITK
PV2.41 [Precaution Code] [0..*] [X] (CE) | not used in ITK
PV2.42 [Patient Condition Code] [0..*] [X] (CE) | not used in ITK
PV2.43 [Living Will Code] [0..*] [X] (IS) | not used in ITK
PV2.44 [Organ Donor Code] [0..*] [X] (IS) | not used in ITK
PV2.45 [Advance Directive Code] [0..*] [X] (CE) | not used in ITK
PV2.46 [Patient Status Effective Date] [0..*] [X] (DT) | not used in ITK
PV2.47 [Expected LOA Return Date/Time] [0..*] [X] (TS) | not used in ITK
OBX [0..*] [O] |
OBX.1 [Set ID - OBX] [0..1] [O] (SI) | Definition: This field contains the sequence number.
OBX.2 [Value Type] [0..1] [C] (ID) { Table : 0125-ValueType } | Definition: This field contains the format of the observation value in OBX. It must be valued if OBX-11-Observ result status is not valued with an `X". If the value is CE then the result must be a coded entry. When the value type is TX or FT then the results are bulk text. Defines the value type for the data to be collected in Observation Value (OBX.5). Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0125.
OBX.3 [Observation Identifier] [1..1] [R] (CE) | Definition: This field contains a unique identifier for the observation.
OBX.4 [Observation Sub-Id] [0..1] [O] (ST) | Definition: This field is used to distinguish between multiple OBX segments with the same observation ID organized under one OBR. For example, a chest X-ray report might include three separate diagnostic impressions. The standard requires three OBX segments, one for each impression. By putting a 1 in the Sub-ID of the first of these OBX segments, 2 in the second, and 3 in the third, we can uniquely identify each OBX segment for editing or replacement. This field is not relevant in ADT messages.
OBX.5 [Observation Value] [0..*] [O] (VARIES) | Definition: This field contains the value observed by the observation producer. The length of this field is variable depending upon value type. See OBX-2 Value type in International HL7 v2 specifications.
OBX.6 [Units] [0..1] [O] (CE) { Table : ZU038-Units } | Background: When an observation's value is measured on a continuous scale, one must report the measurement units within the units field of the OBX segment.
OBX.7 [References Range] [0..1] [O] (ST) | Definition: When the observation quantifies the amount of a toxic substance, then the upper limit of the range identifies the toxic limit. If the observation quantifies a drug, the lower limits identify the lower therapeutic bounds and the upper limits represent the upper therapeutic bounds above which toxic side effects are common.
OBX.8 [Abnormal Flags] [0..1] [O] (IS) { Table : 0078-AbnormalFlags } | Definition: This field contains a table lookup indicating the normalcy status of the result. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0078.
OBX.9 [Probability] [0..1] [O] (NM) | Definition: This field contains the probability of a result being true for results with categorical values. It mainly applies to discrete coded results. It is a decimal number represented as an ASCII string that must be between 0 and 1, inclusive.
OBX.10 [Nature of Abnormal Test] [0..1] [O] (ID) | Definition: This field contains the nature of the abnormal test.
OBX.11 [Observation Result Status] [1..1] [R] (ID) | Definition: This field contains the observation result status. This field reflects the current completion status of the results for one Observation Identifier.
OBX.12 [Date Last Observation Normal Value] [0..1] [O] (TS) | Definition: This field contains the changes in the observation methods that would make values obtained from the old method not comparable with those obtained from the new method.
OBX.13 [User Defined Access Checks] [0..1] [O] (ST) | Definition: This field permits the producer to record results-dependent codes for classifying the observation at the receiving system.
OBX.14 [Date/Time of the Observation] [0..1] [O] (TS) | Definition: This field is required in two circumstances. The first is when the observations reported beneath one report header (OBR) have different dates/times. This could occur in the case of queries, timed test sequences, or clearance studies where one measurement within a battery may have a different time than another measurement. It is also needed in the case of OBX segments that are being sent by the placer to the filler, in which case the date of the observation being transmitted is likely to have no relation to the date of the requested observation.
OBX.15 [Producer's ID] [0..1] [O] (CE) { Table : ZU025-ProducersID } | Definition: This field contains a unique identifier of the responsible producing service.
OBX.16 [Responsible Observer] [0..1] [O] (XCN) | Definition: When required, this field contains the identifier of the individual directly responsible for the observation (i.e., the person who either performed or verified it). In a nursing service, the observer is usually the professional who performed the observation (e.g., took the blood pressure). In a laboratory, the observer is the technician who performed or verified the analysis.
OBX.17 [Observation Method] [0..1] [O] (CE) { Table : ZU021-ObservationMethod } | Definition: This optional field can be used to transmit the method or procedure by which an observation was obtained when the sending system wishes to distinguish among one measurement obtained by different methods and the distinction is not implicit in the test ID.
OBX.18 [Equipment Instance Identifier] [0..1] [O] (EI) | Definition: This field identifies the Equipment Instance (e.g., Analyzer, Analyzer module, group of Analyzers, etc) responsible for the production of the observation.
OBX.19 [Date/Time of the Analysis] [0..1] [O] (TS) | Definition: This field is used to transfer the time stamp associated with generation of the analytical result by the instrument specified in Equipment Instance Identifier.
ZU1 [0..1] [O] | Required if available
ZU1.1 [Date of decision to admit] [0..1] [O] (TS) |
ZU1.2 [Intended Management] [0..1] [O] (CE) { Table : ZU051-IntendedManagement } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU051.
ZU1.3 [Coding Status] [0..1] [O] (IS) { Table : ZU010-CodingStatus } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU010
ZU1.4 [Consultant Episode Start Date/Time] [0..1] [O] (TS) |
ZU1.5 [Consultant Episode End Date Time] [0..1] [O] (TS) |
ZU1.6 [Consultant main specialty] [0..1] [O] (CE) { Table : ZU012-ConsultantsMainSpecialty } | This is the consultant's main specialty. This may be different from the specialty under which the patient is being treated. The national code and any local code will be sent in this field. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU012
ZU1.7 [Treatment Specialty Code] [0..*] [X] (CE) | not used in ITK
ZU1.8 [(Not used)] [0..*] [X] (IS) | not used
ZU1.9 [Neonatal level of care] [0..1] [O] (CE) { Table : ZU020-NeonatalLevelOfCare } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU020.
ZU1.10 [Overseas Visitor Status] [0..1] [O] (CE) { Table : 0171-Citizenship } | This field carries the Overseas Visitor Status of the patient Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0171.
ZU1.11 [(Not Used)] [0..*] [X] (IS) | not used
ZU1.12 [(Not Used)] [0..*] [X] (IS) | not used
ZU1.13 [Source of Referral] [0..1] [O] (CE) { Table : ZU035-SourceOfReferral } |
ZU1.14 [Service Type Requested] [0..1] [O] (CE) { Table : ZU031-ServiceTypeRequested } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU031
ZU1.15 [Referral Request Received Date] [0..1] [O] (TS) |
ZU1.16 [Rererral Date] [0..1] [O] (TS) |
ZU1.17 [Referral Receipt Method] [0..1] [O] (CE) { Table : ZU028-ReferralReceiptMethod } |
ZU1.18 [Written Referral Indicator] [0..1] [O] (ID) { Table : 0136-Yes_noIndicator } | Values 'Y' or 'N'. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0136.
ZU1.19 [First Regular Day or Night Admission] [0..1] [O] (CE) { Table : ZU014-FirstRegularDayOrNightAdmission } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU014
ZU1.20 [Psychiatric Admission Status] [0..1] [O] (CE) { Table : ZU026-PsychiatricAdmissionStatus } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU026
ZU1.21 [Significant Facility] [0..1] [O] (ST) | This facility is that which is used in SMRs
ZU1.22 [Medically Fit Indicator] [0..1] [O] (ID) { Table : 0136-Yes_noIndicator } | Values 'Y' or 'N' Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0136.
ZU1.23 [Embedded Daycase Indicator] [0..1] [O] (ID) { Table : 0136-Yes_noIndicator } | Values 'Y' or 'N' (This is specific to Scottish implementations). Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0136.
ZU1.24 [Ready for Discharge] [0..1] [O] (TS) | Date patient became medically fit for discharge.
ZU1.25 [Borrowed Bed Specialty] [0..1] [O] (CE) { Table : ZU008-BorrowedBedSpecialty } | Specialty code of the bed, for which it was originally intended, if it is being used for another specialty. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU008.
ZU1.26 [Borrowed Bed HCP] [0..1] [O] (XCN) | National code of HCP from whom bed borrowed.
ZU1.27 [NHS Number Tracing Status] [0..1] [O] (IS) | Not required (retained for legacy use only - See PID.32 for mandatory use of NHS Number reliability.
ZU3 [0..1] [O] |
ZU3.1 [Location Type] [0..1] [O] (CE) { Table : ZU052-LocationType } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU052.
ZU3.2 [Medical Staff Type seeing Patient] [0..1] [O] (CE) { Table : ZU019-MedicalStaffTypeSeeingPatient } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU019.
ZU3.3 [Attended or DNA] [0..1] [O] (CE) { Table : ZU007-AttendedOrDNA } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU007.
ZU3.4 [Outcome of Attendance] [0..1] [O] (CE) { Table : ZU022-OutcomeOfAttendance } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU022.
ZU3.5 [Transport Requirements] [0..1] [O] (CE) { Table : ZU037-TransportRequirements } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU037.
ZU3.6 [Attendance Class] [0..1] [O] (CE) { Table : ZU006-AttendanceClass } |
ZU3.7 [Diary Type] [0..1] [O] (CE) { Table : ZU013-DiaryType } |
ZU3.8 [Appointment Type] [0..1] [O] (CE) { Table : 0277-AppointmentTypeCodes } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table 0277.
ZU3.9 [Patient Age Sex Mix] [0..1] [O] (CE) { Table : ZU024-PatientAgeSexMix } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU024.
ZU3.10 [Intended Clinical Care Intensity] [0..1] [O] (CE) { Table : ZU017-IntendedClinicalCareIntensity } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU017.
ZU3.11 [Broad Patient Group] [0..1] [O] (CE) { Table : ZU053-BroadPatientGroup } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU053.
ZU3.12 [First Attendance Indicator] [0..1] [O] (CE) { Table : ZU054-FirstAttendance } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU054
ZU3.13 [Cancelled By] [0..1] [O] (CE) { Table : ZU009-CancelledBy } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU009
ZU3.14 [Source of Attendance] [0..1] [O] (CE) { Table : ZU034-SourceOfAttendance } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU034
ZU4 [0..1] [O] |
ZU4.1 [Date this provider] [0..1] [O] (TS) | Standard Waiting List CMDS (Data Manual) item.
ZU4.2 [Original date on list] [0..1] [O] (TS) |
ZU4.3 [Guaranteed Admission date] [0..1] [O] (TS) | Standard Waiting List CMDS (Data Manual) item.
ZU4.4 [Suspension start date] [0..1] [O] (TS) |
ZU4.5 [Suspension end date] [0..1] [O] (TS) |
ZU4.6 [TCI date] [0..1] [O] (TS) |
ZU4.7 [Responsible HCP provider] [0..1] [O] (CE) { Table : ZU030-ResponsibleHCPProvider } |
ZU4.8 [Source if addition] [0..1] [O] (CE) { Table : ZU033-SourceIfAddition } |
ZU4.9 [Removal/Reinstate reason] [0..1] [O] (CE) { Table : ZU029-Removal_ReinstateReason } |
ZU4.10 [Removal/Reinstate date] [0..1] [O] (TS) |
ZU4.11 [Outcome of offer of admission] [0..1] [O] (CE) { Table : ZU023-OutcomeOfOfferOfAdmission } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU023.
ZU4.12 [Initiator of suspension] [0..1] [O] (CE) { Table : ZU016-InitiatorOfSuspension } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU016.
ZU4.13 [Waiting list type] [0..1] [O] (CE) { Table : ZU055-WaitingListType } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU055.
ZU4.14 [Reason for exceeding Guarantee Date] [0..1] [O] (CE) { Table : ZU027-ReasonForExceedingGuaranteeDate } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU027.
ZU4.15 [Last Review Date] [0..1] [O] (TS) | Standard Waiting List CMDS (Data Manual) item.
ZU6 [0..1] [O] |
ZU6.1 [Antenatal GP] [0..1] [O] (ST) |
ZU6.2 [First Antenatal Assessment Date] [0..1] [O] (TS) |
ZU6.3 [Number of Previous Pregnancies] [0..1] [O] (NM) |
ZU6.4 [Actual Delivery Place] [0..1] [O] (CE) { Table : ZU040-ActualDeliveryPlace } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU040
ZU6.5 [Delivery Date] [0..1] [O] (TS) |
ZU6.6 [Intended Delivery Place] [0..1] [O] (CE) { Table : ZU041-IntendedDeliveryPlace } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU041.
ZU6.7 [Delivery Place Change Reason] [0..1] [O] (CE) { Table : ZU042-DeliveryPlaceChangeReason } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU042
ZU6.8 [Estimated Gestation Length at Initial Assessment] [0..1] [O] (NM) | Range of values: 10-49
ZU6.9 [Labour/Delivery Onset Method] [0..1] [O] (CE) { Table : ZU018-Labour_DeliveryOnsetMethod } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU018
ZU6.10 [Delivery Method] [0..1] [O] (CE) { Table : ZU043-DeliveryMethod } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU043
ZU6.11 [Status of Person Conducting Delivery] [0..1] [O] (CE) { Table : ZU044-StatusOfPersonConductingDelivery } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU044
ZU6.12 [Anaesthetic Given During Labour/Delivery] [0..1] [O] (CE) { Table : ZU003-AnaestheticGivenDuringLabour_Delivery } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU003
ZU6.13 [Anaesthetic Given Post Labour/Delivery] [0..1] [O] (CE) { Table : ZU004-AnaestheticGivenPostLabour_Delivery } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU004
ZU6.14 [Number of babies] [0..1] [O] (NM) | Range of values: 1-9
ZU7 [0..1] [O] |
ZU7.1 [(Not Used)] [0..*] [X] (ST) | not used
ZU7.2 [Live or Still Birth Code] [0..1] [O] (CE) { Table : ZU046-LiveOrStillBirthCode } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU046.
ZU7.3 [Birth Weight] [0..1] [O] (NM) |
ZU7.4 [(Not Used)] [0..*] [X] (ST) | not used
ZU7.5 [Resuscitation Method] [0..1] [O] (CE) { Table : ZU045-ResuscitationMethod } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU045.
ZU7.6 [Gestation Length at Onset of Labour (Weeks)] [0..1] [O] (NM) |
ZU7.7 [Number of births this confinement] [0..1] [O] (NM) |
ZU7.8 [Suspected Congenital Anomaly] [0..1] [O] (ID) |
ZU7.9 [Birth Order] [0..1] [O] (NM) |
ZU8 [0..1] [O] |
ZU8.1 [Sexual Orientation] [0..1] [O] (IS) { Table : ZU032-SexualOrientation } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU032.
ZU8.2 [DCR Consent to share] [0..1] [O] (IS) { Table : ZU056-DCRConsentToShareIndicator } | Field Length: 1 character. Any information which flows across an organisational boundary MUST be agreed with the patient before transmission. This field is used to transmit a code indicating that the patient has agreed to share detailed care record information. Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU056
ZU8.3 [SCR Consent to Store] [0..1] [O] (IS) { Table : ZU058-SCRConsentToStore } | Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU058
ZU8.4 [Location Hiding] [0..1] [O] (IS) { Table : ZU057-LocationHiding } | Toolkit Applications MUST offer the ability to "shield" patient location details to protect the patient. This feature might be used, for example, to protect the location details of an abused spouse. It is intended to offer a reasonable but limited level of protection, while still allowing essential care processes to continue. Typically a shielding capability will involve blanking / obscuring / protecting location-related fields including: Addresses, Email addresses, Next of kin details, GP details Refer to latest version of HSCIC ITK HL7 V2 Reference Tables - Table ZU057