HL7 V2 ADT
Message Specifications

Examples

Admit Patient (ADT A01) XML Payload PH Payload
Example 1:

Inpatient Admission (ADT A01)

Scenario: Mrs Smith is being admitted to hospital following a referral by her GP Dr Townley of the Malton GP Practice. She arrives at York hospital by car, and is put under the care of Dr. Darwin, who also attends to Mrs Smith. Mrs Smith is admitted for an inpatient spell under the speciality General Medicine. She has a recorded allergy to an anaesthetic agent and has been diagnosed with stress incontinence. A colonic examination procedure is then performed.

View View
Transfer Patient (ADT A02) XML Payload PH Payload
Example 1:

Transfer Patient (ADT A02)

Scenario: Mrs Smith was to be transferred to the recovery ward following her interval appendicectomy procedure. Following the successful surgery, Dr Darwin, who had performed the procedure, used the functionality of the surgery and anaesthesia dashboard system to transfer the patient to the recovery ward. This triggered a A02 message from the main PAS system.

View View
Example 2:

Transfer Patient Update Master (ADT A02)

Scenario: Mrs Smith was to be transferred to the recovery ward following her interval appendicectomy procedure. Following the successful surgery, Dr Darwin, who had performed the procedure, used the functionality of the surgery and anaesthesia dashboard system to transfer the patient to the recovery ward. This triggered a A02 message to the main PAS system.

View View
Discharge Patient (ADT A03) XML Payload PH Payload
Example 1:

Discharge Patient (ADT A03)

Scenario: Mrs Smith is discharged from her hospital provider spell. The discharge reports 2 observations from the hospital provider spell. The first is a weight measurement and the second a blood pressure. She is discharged with no follow up required, and returns home.

View View
Example 2:

Discharge Patient Update Master (ADT A03)

Scenario: Mr Smith had driven Mrs Smith to the maternity ward at York Hospital as she had gone into labour. As there was a lack of staff that day, the attending Doctor Dr Samuels was the only person able to assist in the birth. After her successful delivery the baby was born with no issues and Mrs Smith was declared medically fit and ready for discharge home. Using the specialist maternity systems in the maternity ward, Miss Cortana the receptionist processed her discharge. ADT A03 update master message was sent from the Matenrity system to the PAS system.

View View
Register Outpatient (ADT A04) XML Payload PH Payload
Example 1:

Register Outpatient (ADT A04)

Scenario: Mrs Smith is being admitted to hospital following a referral by her GP Dr Townley of the Malton GP Practice. She arrives at York hospital by car, and is put under the care of Dr. Darwin, who also attends to Mrs Smith. Mrs Smith is admitted for an inpatient spell under the speciality General Medicine. She has a recorded allergy to an anaesthetic agent and has been diagnosed with stress incontinence. A colonic examination procedure is then performed.

View View
Example 2:

Register Outpatient Update Master (ADT A04)

Scenario: Mrs Smith is being admitted to hospital following a referral by her GP Dr Townley of the Malton GP Practice. She arrives at York hospital by car, and is put under the care of Dr. Darwin, who also attends to Mrs Smith. Mrs Smith is admitted for an inpatient spell under the speciality General Medicine. She has a recorded allergy to an anaesthetic agent and has been diagnosed with stress incontinence. A colonic examination procedure is then performed.

View View
Pre Admit Patient (ADT A05) XML Payload PH Payload
Example 1:

Pre Admit Patient (ADT A05)

Scenario: Following Mrs Smith's first antenatal assessment, a due date for her baby was estimated by her consulting doctor Dr Darwin. This due date was used in order pre-admit the patient so that she was provisionally booked to attend York Hospital for her delivery.

View View
Update Encounter (ADT A08) XML Payload PH Payload
Example 1:

Update Encounter (ADT A08)

Scenario: Mrs Fredrica Smith had been admitted to the ENT department of York Hospital having been diagnosed with Streptococcal tonsillitis by Dr Darwin. Upon admission Mrs Smith informed Miss Cortana the receptionist, that she now knew the exact date and time of birth and wished to update the hospital's records. As her mother Helgar had found her original birth certificate, Mrs Smith's demographic record no longer needed to contain an estimated date of birth flag. Miss Cortana confirmed and entered the patient's exact date of birth, and removed the estimated date of birth flag. This triggered a HL7 A08 message to update the patient's encounter information.

View View
Cancel Admit Patient (ADT A11) XML Payload PH Payload
Example 1:

Cancel Admit Patient (ADT A11)

Scenario: Mrs Francesca Smith’s GP Dr Townley decides she needs to be admitted to the hospital for general medical checks and stronger medication. The Malton GP practice receptionist rings up the York Hospital to organise a referral. Miss Cortana the hospital receptionist takes the details of Mrs Smith's surname, first initial, date of birth, street number and postcode. When she searches on the system, she can only find two Mrs F Smith's with the same date of birth and postcode and chooses the first one. The inpatient admission is scheduled with Dr Darwin. Miss Cortana realises that upon opening the full record view which shows full surnames, she had chosen Mrs Fredrica Smith. Both were born in the same month, live at the same address and have estimated date of birth flags. Whoever had entered their original details had set both the patient’s default date of birth the same. Miss Cortana undid the inpatient admission triggering an HL7 A11 message.

View View
Cancel Transfer Patient (ADT A12) XML Payload PH Payload
Example 1:

Cancel Transfer Patient (ADT A12)

Scenario: Mrs Smith was due to be transferred to the recovery ward following her interval appendicectomy procedure. Just after the procedure had completed as Mrs Smith was being moved, there was a complication and she had to be brought back to the surgical ward. The transfer which had already been recorded on the system had to be cancelled. This was recorded by Dr Darwin, who had performed the procedure, using the PAS system so that information is updated in Surgery System.

View View
Example 2:

Cancel Transfer Patient Update Master (ADT A12)

Scenario: Mrs Smith was due to be transferred to the recovery ward following her interval appendicectomy procedure. Just after the procedure had completed as Mrs Smith was being moved, there was a complication and she had to be brought back to the surgical ward. The transfer which had already been recorded on the system had to be cancelled. This was recorded by Dr Darwin, who had performed the procedure, using the surgery and anaesthesia dashboard system used in the theatre to monitor the patient.

View View
Cancel Discharge Patient (ADT A13) XML Payload PH Payload
Example 1:

Cancel Discharge Patient (ADT A13)

Scenario: Mrs Smith's discharge from her hospital provider spell is cancelled. Her discharge is cancelled because just before the time of discharge, Mrs Smith's health detoriated and she urgently required medical attention.

View View
Example 2:

Cancel Discharge Patient Update Master (ADT A13)

Scenario: The receptionist in the recovery ward Miss Cortana was tasked with updating the bed board using the electronic whiteboard that had recently been installed. She saw that bed 2 where Mrs Smith was according to the system, was now empty and appeared free. Miss Cortana marked the patient as discharged using the electronic whiteboard. However she then realised that Mrs Smith had been transferred to another ward and not actually discharged after asking another member of staff. Using the bedboard Miss Cortana chose the option to undo the discharge. This sent a A13 message to the PAS system to cancel the discharge.

View View
Pending Admit (ADT A14) XML Payload PH Payload
Example 1:

Pending Admit (ADT A14)

Scenario: Mrs Smith following her outpatient appointment was told she needed to be admitted for further tests. In advance of admitting Mrs Smith, a pending admission was set up in the PAS by Miss Cortana the receptionist, to inform the ward of her arrival so a bed could be prepared. This triggered a A14 HL7 message.

View View
Pending Transfer (ADT A15) XML Payload PH Payload
Example 1:

Pending Transfer (ADT A15)

Scenario: Mrs Smith was due to be transferred to the surgical ward for her interval appendicectomy procedure. In advance of moving Mrs Smith, a pending transfer was set up in the PAS by Miss Cortana the receptionist, to inform the surgical ward. This triggered a A15 HL7 message.

View View
Pending Discharge (ADT A16) XML Payload PH Payload
Example 1:

Pending Discharge (ADT A16)

Scenario: Mrs Smith was due to be discharged from care facility. In advance of discharge Mrs Smith, a pending dsicharge was set up in the PAS by Miss Cortana the receptionist, to inform the pharmacy to prepare for discharge. This triggered a A16 HL7 message.

View View
Leave Of Absence (ADT A21) XML Payload PH Payload
Example 1:

Leave Of Absence (ADT A21)

Scenario: Mrs Smith is allowed to take a leave of absence to return home to Malton following treatment until her next appointment.

View View
Return From Leave Of Absence (ADT A22) XML Payload PH Payload
Example 1:

Return From Leave Of Absence (ADT A22)

Scenario: Mrs Smith returned to York Hospital for another visit to the clinical oncology department to see Dr Darwin. As part of a series of visits, Mrs Smith was allowed to take a leave of absence to return home to Malton following treatment until her next appointment. Mrs Cortana the receptionist, greeted Mrs Smith as she arrived and marked her in the PAS system as returned from leave of absence, triggering an A22 HL7 message.

View View
Cancel Pending Discharge (ADT A25) XML Payload PH Payload
Example 1:

Cancel Pending Discharge (ADT A25)

Scenario: Mrs Smith was due to be discharged from recovery ward after her stay in hospital. In advance of moving Mrs Smith, a pending discharge had been set up in the PAS by Miss Cortana the receptionist, to inform the pharmacy. However Dr Darwin the consulting doctor, observed that Mrs Smith may not be discharged on 15th April 2010 1130AM so the pending discharge was cancelled and A25 message is triggered from PAS.

View View
Cancel Pending Transfer (ADT A26) XML Payload PH Payload
Example 1:

Cancel Pending Transfer (ADT A26)

Scenario: Mrs Smith was due to be transferred to the surgical ward for her interval appendicectomy procedure. In advance of moving Mrs Smith, a pending transfer had been set up in the PAS by Miss Cortana the receptionist, to inform the surgical ward. However Dr Darwin the consulting doctor, observed that Mrs Smith was improving and may not require surgery after all and so the pending transfer was cancelled so that further tests could be carried out.

View View
Cancel Pending Admit (ADT A27) XML Payload PH Payload
Example 1:

Cancel Pending Admit (ADT A27)

Scenario: Mrs Smith following her outpatient appointment was told she should be admitted for further tests. In advance of admitting Mrs Smith, a pending admission was set up in the PAS by Miss Cortana the receptionist, to inform the ward of her arrival so a bed could be prepared. However shortly after this, Mrs Smith decided not want to stay in the hospital further and since Dr Darwin had declared Mrs Smith was medically fit, she did not have to be admitted. Miss Cortana cancelled her previous pending admission triggering a A27 HL7 message.

View View
Create Patient (ADT A28) XML Payload PH Payload
Example 1:

Patient Creation (ADT A28)

Scenario: Mrs Smith attends the hospital to attend a drop in outpatient clinic recommended by her GP Dr. Townley of the Malton GP Practice. She arrives at the hospital and speaks to the receptionist Miss Cortana at the front desk. As this is the first time she has ever visited York Hospital, Miss Cortana takes the patient's name, address and date of birth and searches on the Personal Demographics Service for her details. This is found and Miss Cortana confirms it is the correct person. As Miss Cortana had previously consented to having a Summary Care Record, her allergy information was recieved from PSIS and this was also added to the record. Once this was saved and Mrs Smith was registered, this triggered a HL7 A28 message.

View View
Update Patient (ADT A31) XML Payload PH Payload
Example 1:

Update Patient (ADT A31)

Scenario: Mrs Smith's record is updated with the addition of a further allergy.

View View
Example 2:

Update Patient Update Master (ADT A31)

Scenario: Mrs Smith has been referred for an inpatient appointment by her GP Dr. Townley of the Malton GP Practice. She arrives at York hospital to find a self check in service is being implemented to inform the hospital that she has arrived. Using a self service check in kiosk, she enters her details and is then asked whether she would like to add or change any of her demographic details. Mrs Smith decides to enter some emergency contact information and adds her mother as a next of kin. She also decides that she no longer wants to store a summary care record. Once these changes were entered, the kiosk sends a A31 master update message to the PAS system to update it's records with this new information.

View View
Cancel Pre Admit Patient (ADT A38) XML Payload PH Payload
Example 1:

Cancel Pre Admit Patient (ADT A38)

Scenario: Mrs Smith is being pre-admitted to hospital following a referral by her GP Dr Townley of the Malton GP Practice. She arrives at York hospital by car, which is cancelled.

View View
Merge Patient (ADT A40) XML Payload PH Payload
Example 1:

Patients Merging (ADT A40)

Scenario: Miss Cortana, the administrative staff member working for York Hospital discovered that an unidentified patient who came into A&E is Mrs Smith from Malton. The patient that had been assigned a local ID 22789, had already been created to allow her to be admitted into A&E, as she was unconscious and had no form of identification with her at that time. Miss Cortana needed to merge this patient with Mrs Smith's record and this triggered a A40 message to do this.

View View
Cancel Leave Of Absence (ADT A52) XML Payload PH Payload
Example 1:

Cancel Leave Of Absence (ADT A52)

Scenario: Mrs Smith had been given permission by Dr Darwin to take a leave of absence between her visits to the clinical oncology department. Her leave of absence had been actioned in the system and Mrs Smith was due to go home to Malton. However Dr Darwin observed that her condition had worsened, and that her leave of absence should be cancelled. Mrs Cortana the receptionist, cancelled the leave of absence in the PAS system triggering an A52 HL7 message.

View View
Cancel Return Leave Of Absence (ADT A53) XML Payload PH Payload
Example 1:

Cancel Return Leave Of Absence (ADT A53)

Scenario: Mrs Smith had been given permission by Dr Darwin to take a leave of absence between her visits to the clinical oncology department. She takes the leave, but cancels the original return.

View View
Query Patient Demographics And Visit (QBP ZV1) XML Payload PH Payload
Example 1:

Query Patient Demographics And Visit (QBP ZV1)

View View
Query Patient Demographics (QBP Q21) XML Payload PH Payload
Example 1:

Query Patient Demographics (QBP Q21)

View View
Find Candidates Query (QBP Q22) XML Payload PH Payload
Example 1:

Find Candidates Query (QBP Q22)

View View
Query Patient Demographics And Visit Response (RSP ZV2) XML Payload PH Payload
Example 1:

Query Patient Demographics And Visit Response (RSP ZV2)

View View
Query Patient Demographics Response (RSP K21) XML Payload PH Payload
Example 1:

Query Patient Demographics Response (RSP K21)

View View
Find Candidates Query Response (RSP K22) XML Payload PH Payload
Example 1:

Find Candidates Query Response (RSP K22)

View View
Cancel Query (QCN J01) XML Payload PH Payload
Example 1:

Cancel Query (QCN J01)

View View
HL7v2 Acknowledgement (ADT ACK) XML Payload PH Payload
No examples currently available.