Messages
HSCIC ITK HL7 V2 Message Specifications
The HSCIC ITK HL7 V2 Message Specifications is the definitive document which contains the specifications for the ITK Standard of HL7 V2 for electronic data exchange in all healthcare environments. It has special emphasis on inpatient acute care facilities (i.e., hospitals) and contains example messages for admission, discharge and transfer (ADT) of a patient. |
Message Structure | Tabular View | Profile | On-the-wire Schema | Conformance Schema | |
---|---|---|---|---|---|
Admit Patient (ADT A01)
An A01 event is intended to be used for 'Admitted' patients only. An A01 event is sent as a result of a patient undergoing the admission process which assigns the patient to a bed/location with in healthcare facility. View Examples |
View | View | View | View | View |
Transfer Patient (ADT A02)
An A02 event is issued as a result of the patient changing his or her assigned physical location. View Examples |
View | View | View | View | View |
Discharge Patient (ADT A03)
An A03 event signals the end of a patient's stay in a healthcare facility. It signals that the patient's status has changed to 'discharged' and that a discharge date has been recorded. The patient is no longer in the facility. View Examples |
View | View | View | View | View |
Register Outpatient (ADT A04)
An A04 event signals that the patient has arrived or checked in as a one-time, or recurring outpatient, and is not assigned to a bed. View Examples |
View | View | View | View | View |
Pre Admit Patient (ADT A05)
An A05 event is sent when a patient undergoes the pre-admission process. During this process, episode-related data is collected in preparation for a patient's visit or stay in a healthcare facility. View Examples |
View | View | View | View | View |
Update Encounter (ADT A08)
This trigger event is used when any patient information has changed but when no other trigger event has occurred. For example, an A08 event can be used to notify the receiving systems of a change of address or a name change. We recommend that the A08 transaction be used to update fields that are not related to any of the other trigger events. The A08 event can include information specific to an episode of care, but it can also be used for demographic information only. View Examples |
View | View | View | View | View |
Cancel Admit Patient (ADT A11)
For 'admitted' patients, the A11 event is sent when an A01 (admit/visit notification) event is cancelled, either because of an erroneous entry of the A01 event, or because of a decision not to admit the patient after all. For 'non-admitted' patients, the A11 event is sent when an A04 (register a patient) event is cancelled, either because of an erroneous entry of the A04 event, or because of a decision not to check the patient in for the visit after all. View Examples |
View | View | View | View | View |
Cancel Transfer Patient (ADT A12)
The A12 event is sent when an A02 (transfer a patient) event is cancelled, either because of erroneous entry of the A02 event or because of a decision not to transfer the patient after all. View Examples |
View | View | View | View | View |
Cancel Discharge Patient (ADT A13)
The A13 event is sent when an A03 (discharge/end visit) event is cancelled, either because of erroneous entry of the A03 event or because of a decision not to discharge or end the visit of the patient after all. View Examples |
View | View | View | View | View |
Pending Admit (ADT A14)
An A14 event notifies other systems of a planned admission, when there is a reservation or when patient admission is to occur imminently. The A14 event is similar to a pre-admit, but without the implication that the tests are required prior to the admission. It is used when advanced notification of an admit is required in order to prepare for the patient's arrival. View Examples |
View | View | View | View | View |
Pending Transfer (ADT A15)
An A15 event notifies other systems of a plan to transfer a patient to a new location when the patient has not yet left the old location. It is used when advanced notification of a transfer is required in order to prepare for the patient's location change. View Examples |
View | View | View | View | View |
Pending Discharge (ADT A16)
An A16 event notifies other systems of a plan to discharge a patient when the patient has not yet left the healthcare facility. It is used when advanced notification of a discharge is required in order to prepare for the patient's change in location. View Examples |
View | View | View | View | View |
Leave Of Absence (ADT A21)
An A21 event is sent to notify systems that an admitted patient has left the healthcare institution temporarily. It is used for systems in which a bed is still assigned to the patient, and it puts the current admitted patient activities on hold. View Examples |
View | View | View | View | View |
Return From Leave Of Absence (ADT A22)
An A22 event is sent to notify systems that an admitted patient has returned to the healthcare institution after a temporary 'leave of absence'. It is used for systems in which a bed is still assigned to the patient, and it takes their current admitted patient activities off of 'hold' status. View Examples |
View | View | View | View | View |
Cancel Pending Discharge (ADT A25)
The A25 event is sent when an A16 (pending discharge) event is cancelled, either because of erroneous entry of the A16 event or because of a decision not to discharge the patient after all. View Examples |
View | View | View | View | View |
Cancel Pending Transfer (ADT A26)
The A26 event is sent when an A15 (pending transfer) event is cancelled, either because of erroneous entry of the A15 event or because of a decision not to transfer the patient after all. View Examples |
View | View | View | View | View |
Cancel Pending Admit (ADT A27)
The A27 event is sent when an A14 (pending admit) event is canceled, either because of erroneous entry of the A14 event or because of a decision not to admit the patient after all. View Examples |
View | View | View | View | View |
Create Patient (ADT A28)
The purpose of this message event was to allow sites with multiple systems and respective master patient databases to communicate activity related to a person regardless of whether that person is currently a patient on each system. View Examples |
View | View | View | View | View |
Update Patient (ADT A31)
An A31 event can be used to update person information. View Examples |
View | View | View | View | View |
Cancel Pre Admit Patient (ADT A38)
The A38 event is sent when an A05 (pre-admit a patient) event is cancelled, either because of erroneous entry of the A05 event or because of a decision not to pre-admit the patient after all. View Examples |
View | View | View | View | View |
Merge Patient (ADT A40)
An A40 event is used to signal a merge of records for a patient that was incorrectly filed under two different identifiers. View Examples |
View | View | View | View | View |
Cancel Leave Of Absence (ADT A52)
The A52 event is sent when an A21 (patient goes on 'leave of absence') event is cancelled, either because of erroneous entry of the A21 event or because of a decision not to put the patient on 'leave of absence' after all. View Examples |
View | View | View | View | View |
Cancel Return Leave Of Absence (ADT A53)
The A53 event is sent when an A22 (patient returns from 'leave of absence') event is cancelled, either because of erroneous entry of the A22 event or because of a decision not to return the patient from 'leave of absence' after all. View Examples |
View | View | View | View | View |
Query Patient Demographics And Visit (QBP ZV1)
Message to support query for a patient by visit information and demographics. View Examples |
View | View | View | View | View |
Query Patient Demographics (QBP Q21)
Message to support query for a patient by demographics. View Examples |
View | View | View | View | View |
Find Candidates Query (QBP Q22)
Message to support query for candidates data. View Examples |
View | View | View | View | View |
Query Patient Demographics And Visit Response (RSP ZV2)
Message to support response to the query for a patient by visit information and demographics. View Examples |
View | View | View | View | View |
Query Patient Demographics Response (RSP K21)
Message to support response to the query for a patient by demographics. View Examples |
View | View | View | View | View |
Find Candidates Query Response (RSP K22)
Message to support response to the query for candidates data. View Examples |
View | View | View | View | View |
Cancel Query (QCN J01)
Message to support cancellation of the query. View Examples |
View | View | View | View | View |
HL7v2 Acknowledgement (ADT ACK)
Message to support the HL7v2 Acknowledgement. View Examples |
View | View | View | View | View |