ADT/ACK - Admit/Visit Notification (Event 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. It signals the beginning of a patient's stay in a healthcare facility. Normally, this information is entered in the primary Patient Administration system and broadcast to the nursing units and ancillary systems. It includes short stay and "Adam Everyman" (e.g., patient name is unknown) admissions. For example, an A01 event can be used to notify: the pharmacy system that a patient has been admitted and may be legitimately prescribed drugs; the nursing system that the patient has been admitted and needs a care plan prepared; the finance system of the start of the billing period; the dietary system that a new patient has been installed and requires dietary services; the laboratory, pathology, and radiology systems that a patient has been admitted and is entitled to receive services; the clinical repository that an admission has taken place for the EMR (electronic medical record).

When an account's start and end dates span a period greater than any particular visit, the P01 (add patient account) event should be used to transmit the opening of an account. The A01 event can notify systems of the creation of an account as well as notify them of a patient's arrival in the healthcare facility. In order to create a new account without notifying of patient's arrival, use the P01 event.

The ROL segment has been deprecated and retained for backwards compatiblity purposes only as of v 2.9. The reader is referred to the PRT segment instead.

The PRT – Participation Information Segment is used in this message to communicate providers not specified elsewhere. Person level providers with an ongoing relationship are reported in the PRT segment following the PID/PD1 segments. Providers corresponding to the PV1 data are reported in the PRT segment following the PV1/PV2 segments. Providers related to a specific procedure are reported in the PRT segment following the PR1 segment. Providers related to a specific insurance are reported in the PRT segment following the IN1/IN2/IN3 segments. To communicate the begin and end date of the provider, use the –PRT-11 - Begin Date/Time and the –PRT-12 - End Date/Time in the PRT segment, with the applicable PRT-4 – Role of Participation. Refer to Chapter 7 for the definition of the PRT segment.

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ADT_A01

Segment	Cardinality	Must Implement	Status
ADT_A01
MSH	1..1	Yes
ARV	0..*
SFT	0..*
UAC	0..1
EVN	1..1	Yes
PID	1..1	Yes
PD1	0..1
OH1	0..*
OH2	0..*
OH3	0..1
OH4	0..*
ARV	0..*		B
ROL	0..*		B
PRT	0..*
NEXT_OF_KIN	0..*
NK1	1..1	Yes
OH2	0..*
OH3	0..1
PV1	1..1	Yes
PV2	0..1
ARV	0..*		B
ROL	0..*		B
PRT	0..*
DB1	0..*
OBSERVATION	0..*
OBX	1..1	Yes
PRT	0..*
AL1	0..*
IAM	0..*
DG1	0..*
DRG	0..1
PROCEDURE	0..*
PR1	1..1	Yes
ROL	0..*		B
PRT	0..*
GT1	0..*
INSURANCE	0..*
IN1	1..1	Yes
IN2	0..1
IN3	0..*
ROL	0..*		B
PRT	0..*
AUTHORIZATION	0..*
AUT	1..1	Yes
PRT	0..*
REFERRAL	0..*
RF1	1..1	Yes
PRT	0..*
ACC	0..1
UB1	0..1
UB2	0..1
PDA	0..1

Original Mode Acknowledgement Choreography for ADT^A01^ADT_A01

Send Application Ack: ACK^A01^ACK

Enhanced Mode Acknowledgement Choreography for ADT^A01^ADT_A01

When the MSH-15 value of an ADT^A01^ADT_A01 message is AL or ER or SU, an ACK^A01^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ADT^A01^ADT_A01 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an ADT^A01^ADT_A01 message is AL or ER or SU, an ACK^A01^ACK message SHALL be sent as an application ack.

When the MSH-16 value of an ADT^A01^ADT_A01 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A01^ACK
	NE	(none)
MSH-16	AL, ER, SU	application ack: ACK^A01^ACK
	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ADT_A01--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ADT_A01 --> <!-- .. message definition ADT_A01 --> <xsd:complexType name="ADT_A01.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="EVN" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PD1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NK1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="PV1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PV2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DB1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="OBX" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="AL1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DG1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DRG" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ADT_A01.PROCEDURE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="GT1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ADT_A01.INSURANCE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ACC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="UB1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="UB2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="PDA" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A01" type="ADT_A01.CONTENT" /> <xsd:complexType name="ADT_A01.PROCEDURE.CONTENT"> <xsd:sequence> <xsd:element ref="PR1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A01.PROCEDURE" type="ADT_A01.PROCEDURE.CONTENT" /> <xsd:complexType name="ADT_A01.INSURANCE.CONTENT"> <xsd:sequence> <xsd:element ref="IN1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="IN2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="IN3" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="AUT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RF1" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A01.INSURANCE" type="ADT_A01.INSURANCE.CONTENT" /> </xsd:schema>

Download

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ACK

Segment	Cardinality	Must Implement	Status
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^A01^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^A01^ACK

When the MSH-15 value of an ACK^A01^ACK message is AL or ER or SU, an ACK^A01^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^A01^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A01^ACK
	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ACK--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ACK --> <!-- .. message definition ACK --> <xsd:complexType name="ACK.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ACK" type="ACK.CONTENT" /> </xsd:schema>

Download

ADT/ACK - Transfer a Patient (Event A02)

An A02 event is issued as a result of the patient changing his or her assigned physical location.

The fields included when this message is sent should be the fields pertinent to communicate this event. When other important fields change, it is recommended that the A08 (update patient information) event be used in addition. If the transfer function of your Patient Administration system allows demographics to change at the same time as the transfer (for example an address change), we recommend (but do not require) sending two messages (an A02 followed by an A08). This A02 event can be used with admitted and non-admitted patients.

The new patient location should appear in PV1-3 - Assigned Patient Location while the old patient location should appear in PV1-6 - Prior Patient Location. For example, an A02 event can be used to notify: laboratory, radiology, pathology that the patient has changed location and test results should be redirected; pharmacy that drugs should be redirected for the patient; dietary that the meals should be delivered to a different location; the clinical repository that a transfer has taken place for the Electronic Medical Record.

If the patient is going to a temporary location (such as the O/R, X-RAY, LIMBO, the HALLWAY) it is recommended that the A09 (patient departing-tracking) and A10 (patient arriving-tracking) events be used instead of A02. It is recommended that A02 be used only for a real change in the census bed in the Patient Administration system.

The ROL segment has been deprecated and retained for backwards compatiblity purposes only as of v 2.9. The reader is referred to the PRT segment instead.

The PRT – Participation Information Segment is used in this message to communicate providers not specified elsewhere. Person level providers with an ongoing relationship are reported in the PRT segment following the PID/PD1 segments. Providers corresponding to the PV1 data are reported in the PRT segment following the PV1/PV2 segments. Providers related to a specific procedure are reported in the PRT segment following the PR1 segment. Providers related to a specific insurance are reported in the PRT segment following the IN1/IN2/IN3 segments. To communicate the begin- and end-date of the provider, use the –PRT-11 - Begin Date/Time and the –PRT-12 - End Date/Time in the PRT segment, with the applicable PRT-4 – Role of Participation. Refer to Chapter 7 for the definition of the PRT segment.

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ADT_A02

Segment	Cardinality	Must Implement	Status
ADT_A02
MSH	1..1	Yes
ARV	0..*
SFT	0..*
UAC	0..1
EVN	1..1	Yes
PID	1..1	Yes
PD1	0..1
OH1	0..*
OH2	0..*
OH3	0..1
OH4	0..*
ARV	0..*		B
ROL	0..*		B
PRT	0..*
PV1	1..1	Yes
PV2	0..1
ARV	0..*		B
ROL	0..*		B
PRT	0..*
DB1	0..*
OBSERVATION	0..*
OBX	1..1	Yes
PRT	0..*
PDA	0..1

Original Mode Acknowledgement Choreography for ADT^A02^ADT_A02

Send Application Ack: ADT^A02^ADT_A02

Enhanced Mode Acknowledgement Choreography for ADT^A02^ADT_A02

When the MSH-15 value of an ADT^A02^ADT_A02 message is AL or ER or SU, an ACK^A02^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ADT^A02^ADT_A02 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an ADT^A02^ADT_A02 message is AL or ER or SU, an ACK^A02^ACK message SHALL be sent as an application ack.

When the MSH-16 value of an ADT^A02^ADT_A02 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A02^ACK
	NE	(none)
MSH-16	AL, ER, SU	application ack: ACK^A02^ACK
	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ADT_A02--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ADT_A02 --> <!-- .. message definition ADT_A02 --> <xsd:complexType name="ADT_A02.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="EVN" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PD1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="PV1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PV2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DB1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="OBX" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="PDA" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A02" type="ADT_A02.CONTENT" /> </xsd:schema>

Download

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ACK

Segment	Cardinality	Must Implement	Status
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^A02^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^A02^ACK

When the MSH-15 value of an ACK^A02^ACK message is AL or ER or SU, an ACK^A02^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^A02^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A02^ACK
	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ACK--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ACK --> <!-- .. message definition ACK --> <xsd:complexType name="ACK.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ACK" type="ACK.CONTENT" /> </xsd:schema>

Download

ADT/ACK - Discharge/End Visit (Event 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. The patient's location prior to discharge should be entered in PV1-3 - Assigned Patient Location.

An A03 event can be sent to notify: the pharmacy that the patient's stay has ended and that entitlement to drugs has changed accordingly; the nursing system that the patient has been discharged and that the care plan can be completed; the extended care or home health system that the patient has been discharged and that the new extended care or home health admission assessment can be scheduled; the finance system that the patient billing period has ended; and/or the clinical repository that discharge has taken place for the EMR.

For non-admitted patients, an A03 event signals the end of a patient's visit to a healthcare facility. It could be used to signal the end of a visit for a one-time or recurring outpatient who is not assigned to a bed. It could also be used to signal the end of a visit to the Emergency Room. PV1-45 - Discharge Date/Time can be used for the visit end date/time.

When an account's start and end dates span a period greater than any particular visit, the P06 (end account) event should be used to transmit information about the closing of an account. To indicate that a patient has expired, use an A03 event with the PID-29 - Patient Death Date and Time and PID-30 - Patient Death Indicator filled in.

The fields included when this message is sent should be the fields pertinent to communicate this event. The optional allergy, next-of-kin, insurance and guarantor fields should be sent when required to support advanced notification for pending extended care or home health admission requirements (such as scheduling of a nursing assessment in preparation for completion of the extended care plan). When other important fields change, it is recommended that the A08 (update patient information) event be used in addition.

The ROL segment has been deprecated and retained for backwards compatiblity purposes only as of v 2.9. The reader is referred to the PRT segment instead.

The PRT - Participation Segment is used in this message to communicate providers not specified elsewhere. Person level providers with an ongoing relationship are reported in the PRT segment following the PID/PD1 segments. Providers corresponding to the PV1 data are reported in the PRT segment following the PV1/PV2 segments. Providers related to a specific procedure are reported in the PRT segment following the PR1 segment. Providers related to a specific insurance are reported in the PRT segment following the IN1/IN2/IN3 segments. To communicate the begin date and end date of the provider, use the –PRT-11 - Begin Date/Time and the –PRT-12 - End Date/Time in the PRT segment, with the applicable PRT-4 – Role of Particpation. Refer to Chapter 7 for the definition of the PRT segment.

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ADT_A03

Segment	Cardinality	Must Implement	Status
ADT_A03
MSH	1..1	Yes
ARV	0..*
SFT	0..*
UAC	0..1
EVN	1..1	Yes
PID	1..1	Yes
PD1	0..1
OH1	0..*
OH2	0..*
OH3	0..1
OH4	0..*
ARV	0..*		B
ROL	0..*		B
PRT	0..*
NEXT_OF_KIN	0..*
NK1	1..1	Yes
OH2	0..*
OH3	0..1
PV1	1..1	Yes
PV2	0..1
ARV	0..*		B
ROL	0..*		B
PRT	0..*
DB1	0..*
AL1	0..*
IAM	0..*
DG1	0..*
DRG	0..1
PROCEDURE	0..*
PR1	1..1	Yes
ROL	0..*		B
PRT	0..*
OBSERVATION	0..*
OBX	1..1	Yes
PRT	0..*
GT1	0..*
INSURANCE	0..*
IN1	1..1	Yes
IN2	0..1
IN3	0..*
ROL	0..*		B
PRT	0..*
AUTHORIZATION	0..*
AUT	1..1	Yes
PRT	0..*
REFERRAL	0..*
RF1	1..1	Yes
PRT	0..*
ACC	0..1
PDA	0..1

Original Mode Acknowledgement Choreography for ADT^A03^ADT_A03

Send Application Ack: ADT^A03^ADT_A03

Enhanced Mode Acknowledgement Choreography for ADT^A03^ADT_A03

When the MSH-15 value of an ADT^A03^ADT_A03 message is AL or ER or SU, an ACK^A03^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ADT^A03^ADT_A03 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an ADT^A03^ADT_A03 message is AL or ER or SU, an ACK^A03^ACK message SHALL be sent as an application ack.

When the MSH-16 value of an ADT^A03^ADT_A03 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A03^ACK
	NE	(none)
MSH-16	AL, ER, SU	application ack: ACK^A03^ACK
	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ADT_A03--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ADT_A03 --> <!-- .. message definition ADT_A03 --> <xsd:complexType name="ADT_A03.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="EVN" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PD1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NK1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="PV1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PV2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DB1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="AL1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DG1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DRG" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ADT_A03.PROCEDURE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="OBX" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="GT1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ADT_A03.INSURANCE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ACC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="PDA" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A03" type="ADT_A03.CONTENT" /> <xsd:complexType name="ADT_A03.PROCEDURE.CONTENT"> <xsd:sequence> <xsd:element ref="PR1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A03.PROCEDURE" type="ADT_A03.PROCEDURE.CONTENT" /> <xsd:complexType name="ADT_A03.INSURANCE.CONTENT"> <xsd:sequence> <xsd:element ref="IN1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="IN2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="IN3" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="AUT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RF1" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A03.INSURANCE" type="ADT_A03.INSURANCE.CONTENT" /> </xsd:schema>

Download

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ACK

Segment	Cardinality	Must Implement	Status
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^A03^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^A03^ACK

When the MSH-15 value of an ACK^A03^ACK message is AL or ER or SU, an ACK^A03^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^A03^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A03^ACK
	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ACK--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ACK --> <!-- .. message definition ACK --> <xsd:complexType name="ACK.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ACK" type="ACK.CONTENT" /> </xsd:schema>

Download

ADT/ACK - Register a Patient (Event 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. One example might be its use to signal the beginning of a visit to the Emergency Room (= Casualty, etc.).

Note: Some systems refer to these events as outpatient registrations or emergency admissions. PV1-44 - Admit Date/Time is used for the visit start date/time.

The ROL segment has been deprecated and retained for backwards compatiblity purposes only as of v 2.9. The reader is referred to the PRT segment instead.

The PRT - Participation Segment is used in this message to communicate providers not specified elsewhere. Person level providers with an ongoing relationship are reported in the PRT segment following the PID/PD1 segments. Providers corresponding to the PV1 data are reported in the PRTsegment following the PV1/PV2 segments. Providers related to a specific procedure are reported in the PRT segment following the PR1 segment. Providers related to a specific insurance are reported in the PRT segment following the IN1/IN2/IN3 segments. To communicate the begin- and end-date of the provider, use the –PRT-11 - Begin Date/Time and the –PRT-12 - End Date/Time in the PRT segment, with the applicable PRT-4 – role of Participation. Refer to Chapter 7 for the definition of the PRT segment.

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ADT_A01

Segment	Cardinality	Must Implement	Status
ADT_A01
MSH	1..1	Yes
ARV	0..*
SFT	0..*
UAC	0..1
EVN	1..1	Yes
PID	1..1	Yes
PD1	0..1
OH1	0..*
OH2	0..*
OH3	0..1
OH4	0..*
ARV	0..*		B
ROL	0..*		B
PRT	0..*
NEXT_OF_KIN	0..*
NK1	1..1	Yes
OH2	0..*
OH3	0..1
PV1	1..1	Yes
PV2	0..1
ARV	0..*		B
ROL	0..*		B
PRT	0..*
DB1	0..*
OBSERVATION	0..*
OBX	1..1	Yes
PRT	0..*
AL1	0..*
IAM	0..*
DG1	0..*
DRG	0..1
PROCEDURE	0..*
PR1	1..1	Yes
ROL	0..*		B
PRT	0..*
GT1	0..*
INSURANCE	0..*
IN1	1..1	Yes
IN2	0..1
IN3	0..*
ROL	0..*		B
PRT	0..*
AUTHORIZATION	0..*
AUT	1..1	Yes
PRT	0..*
REFERRAL	0..*
RF1	1..1	Yes
PRT	0..*
ACC	0..1
UB1	0..1
UB2	0..1
PDA	0..1

Original Mode Acknowledgement Choreography for ADT^A04^ADT_A01

Send Application Ack: ADT^A04^ADT_A01

Enhanced Mode Acknowledgement Choreography for ADT^A04^ADT_A01

When the MSH-15 value of an ADT^A04^ADT_A01 message is AL or ER or SU, an ACK^A04^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ADT^A04^ADT_A01 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an ADT^A04^ADT_A01 message is AL or ER or SU, an ACK^A04^ACK message SHALL be sent as an application ack.

When the MSH-16 value of an ADT^A04^ADT_A01 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A04^ACK
	NE	(none)
MSH-16	AL, ER, SU	application ack: ACK^A04^ACK
	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ADT_A01--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ADT_A01 --> <!-- .. message definition ADT_A01 --> <xsd:complexType name="ADT_A01.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="EVN" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PD1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NK1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="PV1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PV2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DB1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="OBX" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="AL1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DG1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DRG" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ADT_A01.PROCEDURE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="GT1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ADT_A01.INSURANCE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ACC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="UB1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="UB2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="PDA" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A01" type="ADT_A01.CONTENT" /> <xsd:complexType name="ADT_A01.PROCEDURE.CONTENT"> <xsd:sequence> <xsd:element ref="PR1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A01.PROCEDURE" type="ADT_A01.PROCEDURE.CONTENT" /> <xsd:complexType name="ADT_A01.INSURANCE.CONTENT"> <xsd:sequence> <xsd:element ref="IN1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="IN2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="IN3" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="AUT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RF1" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A01.INSURANCE" type="ADT_A01.INSURANCE.CONTENT" /> </xsd:schema>

Download

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ACK

Segment	Cardinality	Must Implement	Status
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^A04^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^A04^ACK

When the MSH-15 value of an ACK^A04^ACK message is AL or ER or SU, an ACK^A04^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^A04^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A04^ACK
	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ACK--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ACK --> <!-- .. message definition ACK --> <xsd:complexType name="ACK.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ACK" type="ACK.CONTENT" /> </xsd:schema>

Download

ADT/ACK - Pre-Admit a Patient (Event 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. For example, a pre-admit may be performed prior to inpatient or outpatient surgery so that lab tests can be performed prior to the surgery. This event can also be used to pre-register a non-admitted patient.

The ROL segment has been deprecated and retained for backwards compatiblity purposes only as of v 2.9. The reader is referred to the PRT segment instead.

The PRT - Participation Segment is used in this message to communicate providers not specified elsewhere. Person level providers with an ongoing relationship are reported in the PRT segment following the PID/PD1 segments. Visit level providers (corresponding to the PV1 data) are reported in the PRT segment following the PV1/PV2 segments. Providers related to a specific procedure are reported in the PRT segment following the PR1 segment. Providers related to a specific insurance are reported in the PRT segment following the IN1/IN2/IN3 segments. To communicate the begin- and end-date of the provider, use the –PRT-11 - Begin Date/Time and the –PRT-12 - End Date/Time in the PRT segment, with the applicable PRT-4 – Role of Participation. Refer to Chapter 15 for the definition of the PRT segment.

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ADT_A05

Segment	Cardinality	Must Implement	Status
ADT_A05
MSH	1..1	Yes
ARV	0..*
SFT	0..*
UAC	0..1
EVN	1..1	Yes
PID	1..1	Yes
PD1	0..1
OH1	0..*
OH2	0..*
OH3	0..1
OH4	0..*
ARV	0..*		B
ROL	0..*		B
PRT	0..*
NEXT_OF_KIN	0..*
NK1	1..1	Yes
OH2	0..*
OH3	0..1
PV1	1..1	Yes
PV2	0..1
ARV	0..*		B
ROL	0..*		B
PRT	0..*
DB1	0..*
OBSERVATION	0..*
OBX	1..1	Yes
PRT	0..*
AL1	0..*
IAM	0..*
DG1	0..*
DRG	0..1
PROCEDURE	0..*
PR1	1..1	Yes
ROL	0..*		B
PRT	0..*
GT1	0..*
INSURANCE	0..*
IN1	1..1	Yes
IN2	0..1
IN3	0..*
ROL	0..*		B
PRT	0..*
AUTHORIZATION	0..*
AUT	1..1	Yes
PRT	0..*
REFERRAL	0..*
RF1	1..1	Yes
PRT	0..*
ACC	0..1
UB1	0..1
UB2	0..1

Original Mode Acknowledgement Choreography for ADT^A05^ADT_A05

Send Application Ack: ADT^A05^ADT_A05

Enhanced Mode Acknowledgement Choreography for ADT^A05^ADT_A05

When the MSH-15 value of an ADT^A05^ADT_A05 message is AL or ER or SU, an ACK^A05^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ADT^A05^ADT_A05 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an ADT^A05^ADT_A05 message is AL or ER or SU, an ACK^A05^ACK message SHALL be sent as an application ack.

When the MSH-16 value of an ADT^A05^ADT_A05 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A05^ACK
	NE	(none)
MSH-16	AL, ER, SU	application ack: ACK^A05^ACK
	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ADT_A05--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ADT_A05 --> <!-- .. message definition ADT_A05 --> <xsd:complexType name="ADT_A05.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="EVN" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PD1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NK1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="PV1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PV2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DB1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="OBX" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="AL1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DG1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DRG" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ADT_A05.PROCEDURE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="GT1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ADT_A05.INSURANCE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ACC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="UB1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="UB2" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A05" type="ADT_A05.CONTENT" /> <xsd:complexType name="ADT_A05.PROCEDURE.CONTENT"> <xsd:sequence> <xsd:element ref="PR1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A05.PROCEDURE" type="ADT_A05.PROCEDURE.CONTENT" /> <xsd:complexType name="ADT_A05.INSURANCE.CONTENT"> <xsd:sequence> <xsd:element ref="IN1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="IN2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="IN3" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="AUT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RF1" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A05.INSURANCE" type="ADT_A05.INSURANCE.CONTENT" /> </xsd:schema>

Download

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ACK

Segment	Cardinality	Must Implement	Status
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^A05^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^A05^ACK

When the MSH-15 value of an ACK^A05^ACK message is AL or ER or SU, an ACK^A05^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^A05^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A05^ACK
	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ACK--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ACK --> <!-- .. message definition ACK --> <xsd:complexType name="ACK.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ACK" type="ACK.CONTENT" /> </xsd:schema>

Download

ADT/ACK - Change an Outpatient to an Inpatient (Event A06)

An A06 event is sent when a patient who was present for a non-admitted visit is being admitted after an evaluation of the seriousness of the patient's condition. This event changes a patient's status from non-admitted to admitted. The new patient location should appear in PV1-3 - Assigned Patient Location, while the old patient location (if different) should appear in PV1-6 - Prior Patient Location. The new patient class should appear in PV1-2 - Patient Class.

It will be left to implementation negotiation to determine whether disparate systems merely change the patient class, or close and open a new account. The current active account number should appear in field PID-18 - Patient Account Number; the prior account number can be included optionally in MRG-3 - Prior Patient Account Number. This arrangement is not intended to be a type of merge. The MRG segment is used here only for MRG-3 - Prior Patient Account Number. PV1-19 - Visit Number may also be changed during this event.

The fields included when this message is sent should be the fields pertinent to communicate this event. When other important fields change, it is recommended that the A08 (update patient information) event be used in addition.

The ROL segment has been deprecated and retained for backwards compatiblity purposes only as of v 2.9. The reader is referred to the PRT segment instead.

The PRT – Participation Information Segment is used in this message to communicate providers not specified elsewhere. Person level providers with an ongoing relationship are reported in the PRT segment following the PID/PD1 segments. Visit level providers (corresponding to the PV1 data) are reported in the PRT segment following the PV1/PV2 segments. Providers related to a specific procedure are reported in the PRT segment following the PR1 segment. Providers related to a specific insurance are reported in the PRT segment following the IN1/IN2/IN3 segments. To communicate the begin- and end-date of the provider, use the PRT-11 –Begin Date/Time and the PRT-12 –End Date/Time in the PRT segment, with the applicable PRT-4 – role of Participation. Refer to Chapter 7 for the definition of the PRT segment.

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ADT_A06

Segment	Cardinality	Must Implement	Status
ADT_A06
MSH	1..1	Yes
ARV	0..*
SFT	0..*
UAC	0..1
EVN	1..1	Yes
PID	1..1	Yes
PD1	0..1
OH1	0..*
OH2	0..*
OH3	0..1
OH4	0..*
ARV	0..*		B
ROL	0..*		B
PRT	0..*
MRG	0..1
NEXT_OF_KIN	0..*
NK1	1..1	Yes
OH2	0..*
OH3	1..1	Yes
PV1	1..1	Yes
PV2	0..1
ARV	0..*		B
ROL	0..*		B
PRT	0..*
DB1	0..*
OBSERVATION	0..*
OBX	1..1	Yes
PRT	0..*
AL1	0..*
IAM	0..*
DG1	0..*
DRG	0..1
PROCEDURE	0..*
PR1	1..1	Yes
ROL	0..*		B
PRT	0..*
GT1	0..*
INSURANCE	0..*
IN1	1..1	Yes
IN2	0..1
IN3	0..*
ROL	0..*		B
PRT	0..*
ACC	0..1
UB1	0..1
UB2	0..1

Original Mode Acknowledgement Choreography for ADT^A06^ADT_A06

Send Application Ack: ADT^A06^ADT_A06

Enhanced Mode Acknowledgement Choreography for ADT^A06^ADT_A06

When the MSH-15 value of an ADT^A06^ADT_A06 message is AL or ER or SU, an ACK^A06^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ADT^A06^ADT_A06 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an ADT^A06^ADT_A06 message is AL or ER or SU, an ACK^A06^ACK message SHALL be sent as an application ack.

When the MSH-16 value of an ADT^A06^ADT_A06 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A06^ACK
	NE	(none)
MSH-16	AL, ER, SU	application ack: ACK^A06^ACK
	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ADT_A06--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ADT_A06 --> <!-- .. message definition ADT_A06 --> <xsd:complexType name="ADT_A06.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="EVN" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PD1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="MRG" minOccurs="0" maxOccurs="1" /> <xsd:element ref="NK1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="PV1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PV2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DB1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="OBX" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="AL1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DG1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DRG" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ADT_A06.PROCEDURE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="GT1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ADT_A06.INSURANCE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ACC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="UB1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="UB2" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A06" type="ADT_A06.CONTENT" /> <xsd:complexType name="ADT_A06.PROCEDURE.CONTENT"> <xsd:sequence> <xsd:element ref="PR1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A06.PROCEDURE" type="ADT_A06.PROCEDURE.CONTENT" /> <xsd:complexType name="ADT_A06.INSURANCE.CONTENT"> <xsd:sequence> <xsd:element ref="IN1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="IN2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="IN3" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A06.INSURANCE" type="ADT_A06.INSURANCE.CONTENT" /> </xsd:schema>

Download

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ACK

Segment	Cardinality	Must Implement	Status
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^A06^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^A06^ACK

When the MSH-15 value of an ACK^A06^ACK message is AL or ER or SU, an ACK^A06^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^A06^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A06^ACK
	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ACK--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ACK --> <!-- .. message definition ACK --> <xsd:complexType name="ACK.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ACK" type="ACK.CONTENT" /> </xsd:schema>

Download

ADT/ACK - Change an Inpatient to an Outpatient (Event A07)

An A07 event is sent when a patient who was admitted changes his/her status to "no longer admitted" but is still being seen for this episode of care. This event changes a patient from an "admitted" to a "non-admitted" status. The new patient location should appear in PV1-3 - Assigned Patient Location, while the old patient location (if different) should appear in PV1-6 - Prior Patient Location.

It will be left to implementation negotiation to determine whether disparate systems merely change the patient class, or close and open a new account. The current active account number should appear in field PID-18 - Patient Account Number; the prior account number can be included optionally in MRG-3 - Prior Patient Account Number. This arrangement is not intended to be a type of merge. The MRG segment is used here only for MRG-3 - Prior Patient Account Number. PV1-19 - Visit Number may also be changed during this event.

The fields included when this message is sent should be the fields pertinent to communicate this event. When other important fields change, it is recommended that the A08 (update patient information) event be used in addition.

The ROL segment has been deprecated and retained for backwards compatiblity purposes only as of v 2.9. The reader is referred to the PRT segment instead.

The PRT – Participation Information Segment is used in this message to communicate providers not specified elsewhere. Person level providers with an ongoing relationship are reported in the PRT segment following the PID/PD1 segments. Providers corresponding to the PV1 data are reported in the PRT segment following the PV1/PV2 segments. Providers related to a specific procedure are reported in the PRT segment following the PR1 segment. Providers related to a specific insurance are reported in the PRT segment following the IN1/IN2/IN3 segments. To communicate the begin and end date of the provider, use the –PRT-11 - Begin Date/Time and the –PRT-12 - End Date/Time in the PRT segment, with the applicable PRT-4 – Role of Participation. Refer to Chapter 7 for the definition of the PRT segment.

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ADT_A06

Segment	Cardinality	Must Implement	Status
ADT_A06
MSH	1..1	Yes
ARV	0..*
SFT	0..*
UAC	0..1
EVN	1..1	Yes
PID	1..1	Yes
PD1	0..1
OH1	0..*
OH2	0..*
OH3	0..1
OH4	0..*
ARV	0..*		B
ROL	0..*		B
PRT	0..*
MRG	0..1
NEXT_OF_KIN	0..*
NK1	1..1	Yes
OH2	0..*
OH3	1..1	Yes
PV1	1..1	Yes
PV2	0..1
ARV	0..*		B
ROL	0..*		B
PRT	0..*
DB1	0..*
OBSERVATION	0..*
OBX	1..1	Yes
PRT	0..*
AL1	0..*
IAM	0..*
DG1	0..*
DRG	0..1
PROCEDURE	0..*
PR1	1..1	Yes
ROL	0..*		B
PRT	0..*
GT1	0..*
INSURANCE	0..*
IN1	1..1	Yes
IN2	0..1
IN3	0..*
ROL	0..*		B
PRT	0..*
ACC	0..1
UB1	0..1
UB2	0..1

Original Mode Acknowledgement Choreography for ADT^A07^ADT_A06

Send Application Ack: ADT^A07^ADT_A06

Enhanced Mode Acknowledgement Choreography for ADT^A07^ADT_A06

When the MSH-15 value of an ADT^A07^ADT_A06 message is AL or ER or SU, an ACK^A07^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ADT^A07^ADT_A06 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an ADT^A07^ADT_A06 message is AL or ER or SU, an ACK^A07^ACK message SHALL be sent as an application ack.

When the MSH-16 value of an ADT^A07^ADT_A06 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A07^ACK
	NE	(none)
MSH-16	AL, ER, SU	application ack: ACK^A07^ACK
	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ADT_A06--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ADT_A06 --> <!-- .. message definition ADT_A06 --> <xsd:complexType name="ADT_A06.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="EVN" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PD1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="MRG" minOccurs="0" maxOccurs="1" /> <xsd:element ref="NK1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="PV1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PV2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DB1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="OBX" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="AL1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DG1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DRG" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ADT_A06.PROCEDURE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="GT1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ADT_A06.INSURANCE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ACC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="UB1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="UB2" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A06" type="ADT_A06.CONTENT" /> <xsd:complexType name="ADT_A06.PROCEDURE.CONTENT"> <xsd:sequence> <xsd:element ref="PR1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A06.PROCEDURE" type="ADT_A06.PROCEDURE.CONTENT" /> <xsd:complexType name="ADT_A06.INSURANCE.CONTENT"> <xsd:sequence> <xsd:element ref="IN1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="IN2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="IN3" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A06.INSURANCE" type="ADT_A06.INSURANCE.CONTENT" /> </xsd:schema>

Download

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ACK

Segment	Cardinality	Must Implement	Status
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^A07^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^A07^ACK

When the MSH-15 value of an ACK^A07^ACK message is AL or ER or SU, an ACK^A07^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^A07^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A07^ACK
	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ACK--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ACK --> <!-- .. message definition ACK --> <xsd:complexType name="ACK.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ACK" type="ACK.CONTENT" /> </xsd:schema>

Download

ADT/ACK - Update Patient Information (Event 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 strongly recommend that the A08 transaction be used to update fields that are not updated by any of the other trigger events. If there are specific trigger events for this update, these trigger events should be used. For example, if a patient's address and location are to be changed, then an A08 is used to change the patient address and the appropriate patient location trigger event is used to change the patient location. The A08 event can include information specific to an episode of care, but it can also be used for demographic information only.

The ROL segment has been deprecated and retained for backwards compatiblity purposes only as of v 2.9. The reader is referred to the PRT segment instead.

The PRT – Participation Information Segment is used in this message to communicate providers not specified elsewhere. Person level providers with an ongoing relationship are reported in the PRT segment following the PID/PD1 segments. Providers corresponding to the PV1 data are reported in the PRT segment following the PV1/PV2 segments. Providers related to a specific procedure are reported in the PRT segment following the PR1 segment. Providers related to a specific insurance are reported in the PRT segment following the IN1/IN2/IN3 segments. To communicate the begin- and end-date of the provider, use the PRT-11 – Begin Date/Time and the –PRT-12 - End Date/Time in the PRT, with the applicable PRT-4 – role of Participation. Refer to Chapter 7 for the definition of the PRT segment.

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ADT_A01

Segment	Cardinality	Must Implement	Status
ADT_A01
MSH	1..1	Yes
ARV	0..*
SFT	0..*
UAC	0..1
EVN	1..1	Yes
PID	1..1	Yes
PD1	0..1
OH1	0..*
OH2	0..*
OH3	0..1
OH4	0..*
ARV	0..*		B
ROL	0..*		B
PRT	0..*
NEXT_OF_KIN	0..*
NK1	1..1	Yes
OH2	0..*
OH3	0..1
PV1	1..1	Yes
PV2	0..1
ARV	0..*		B
ROL	0..*		B
PRT	0..*
DB1	0..*
OBSERVATION	0..*
OBX	1..1	Yes
PRT	0..*
AL1	0..*
IAM	0..*
DG1	0..*
DRG	0..1
PROCEDURE	0..*
PR1	1..1	Yes
ROL	0..*		B
PRT	0..*
GT1	0..*
INSURANCE	0..*
IN1	1..1	Yes
IN2	0..1
IN3	0..*
ROL	0..*		B
PRT	0..*
AUTHORIZATION	0..*
AUT	1..1	Yes
PRT	0..*
REFERRAL	0..*
RF1	1..1	Yes
PRT	0..*
ACC	0..1
UB1	0..1
UB2	0..1
PDA	0..1

Original Mode Acknowledgement Choreography for ADT^A08^ADT_A01

Send Application Ack: ADT^A08^ADT_A01

Enhanced Mode Acknowledgement Choreography for ADT^A08^ADT_A01

When the MSH-15 value of an ADT^A08^ADT_A01 message is AL or ER or SU, an ACK^A08^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ADT^A08^ADT_A01 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an ADT^A08^ADT_A01 message is AL or ER or SU, an ACK^A08^ACK message SHALL be sent as an application ack.

When the MSH-16 value of an ADT^A08^ADT_A01 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A08^ACK
	NE	(none)
MSH-16	AL, ER, SU	application ack: ACK^A08^ACK
	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ADT_A01--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ADT_A01 --> <!-- .. message definition ADT_A01 --> <xsd:complexType name="ADT_A01.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="EVN" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PD1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NK1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="PV1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PV2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DB1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="OBX" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="AL1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DG1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DRG" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ADT_A01.PROCEDURE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="GT1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ADT_A01.INSURANCE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ACC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="UB1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="UB2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="PDA" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A01" type="ADT_A01.CONTENT" /> <xsd:complexType name="ADT_A01.PROCEDURE.CONTENT"> <xsd:sequence> <xsd:element ref="PR1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A01.PROCEDURE" type="ADT_A01.PROCEDURE.CONTENT" /> <xsd:complexType name="ADT_A01.INSURANCE.CONTENT"> <xsd:sequence> <xsd:element ref="IN1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="IN2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="IN3" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="AUT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RF1" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A01.INSURANCE" type="ADT_A01.INSURANCE.CONTENT" /> </xsd:schema>

Download

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ACK

Segment	Cardinality	Must Implement	Status
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^A08^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^A08^ACK

When the MSH-15 value of an ACK^A08^ACK message is AL or ER or SU, an ACK^A08^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^A08^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A08^ACK
	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ACK--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ACK --> <!-- .. message definition ACK --> <xsd:complexType name="ACK.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ACK" type="ACK.CONTENT" /> </xsd:schema>

Download

ADT/ACK - Patient Departing - Tracking (Event A09)

The A09 and A10 - patient arriving-tracking events are used when there is a change in a patient's physical location (inpatient or outpatient) and when this is NOT a change in the official census bed location, as in the case of an outpatient setting. There are three situations that qualify as non-census location changes: (a) patient tracking, (b) the patient is in transit between locations for some time, (c) a notification of temporary location change.

Patient tracking: This can be used when the nursing application sends a "transfer" before the Patient Administration (or official census) system issues an A02 (transfer a patient) event. If the patient has left for a non-temporary location and is not in transit, then the PV1-3 - Assigned Patient Location must contain the new patient location, while PV1-6 - Prior Patient Location must contain the old patient location.

In transit: The patient's location during the time between an A09 and an A10 (patient arriving - tracking) is defined as "in transit." The A09 event is sent when a patient departs from one area of the healthcare facility for the purpose of arriving at another area, but without leaving the healthcare institution. This event is used when there is a time span during which the patient is neither at his/her old location nor at his/her new location. This process can take some time if a patient is being sent to another area in a multi-campus or multi-facility environment. The combination of an A09 and an A10 would serve the same purpose as an A02 (transfer a patient) event, except that it accounts for a gap in time required for transport between facilities. If the patient will be in transit during the time between the A09 (patient departing - tracking) event and the A10 (patient arriving - tracking) event, then PV1-42 - Pending Location is used for the new location, and PV1-11 - Temporary Location and PV1-43 - Prior Temporary Location would not be used. PV1-6 - Prior Patient Location should be used for the old location.

Temporary location: An A09 can also be used when the patient is being sent to a temporary location (such as the O/R, X-RAY, LIMBO, or HALLWAY). The patient may or may not return to the same assigned location after occupying the temporary location. If the patient is going to a temporary location (such as the O/R, X-RAY, LIMBO, or HALLWAY), then PV1-11 - Temporary Location is used to indicate the new temporary location. If the patient is moving from one temporary location to another, then PV1-43 - Prior Temporary Location may also be used. PV1-6 - Prior Patient Location and PV1-11 - Temporary Location should be used when the patient is moving from a permanent location to a temporary location.

The fields included when this message is sent should be the fields pertinent to communicate this event. When other important fields change, it is recommended that the A08 (update patient information) event be used in addition.

Attention: The DG1 segment was retained for backward compatibility only as of v2.4 and was withdrawn and removed from this message structure as of v2.7.

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ADT_A09

Segment	Cardinality	Must Implement	Status
ADT_A09
MSH	1..1	Yes
ARV	0..*
SFT	0..*
UAC	0..1
EVN	1..1	Yes
PID	1..1	Yes
PD1	0..1
PV1	1..1	Yes
PV2	0..1
DB1	0..*
OBSERVATION	0..*
OBX	1..1	Yes
PRT	0..*

Original Mode Acknowledgement Choreography for ADT^A09^ADT_A09

Send Application Ack: ADT^A09^ADT_A09

Enhanced Mode Acknowledgement Choreography for ADT^A09^ADT_A09

When the MSH-15 value of an ADT^A09^ADT_A09 message is AL or ER or SU, an ACK^A09^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ADT^A09^ADT_A09 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an ADT^A09^ADT_A09 message is AL or ER or SU, an ACK^A09^ACK message SHALL be sent as an application ack.

When the MSH-16 value of an ADT^A09^ADT_A09 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A09^ACK
	NE	(none)
MSH-16	AL, ER, SU	application ack: ACK^A09^ACK
	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ADT_A09--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ADT_A09 --> <!-- .. message definition ADT_A09 --> <xsd:complexType name="ADT_A09.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="EVN" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PD1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="PV1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PV2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="DB1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="OBX" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A09" type="ADT_A09.CONTENT" /> </xsd:schema>

Download

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ACK

Segment	Cardinality	Must Implement	Status
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^A09^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^A09^ACK

When the MSH-15 value of an ACK^A09^ACK message is AL or ER or SU, an ACK^A09^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^A09^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A09^ACK
	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ACK--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ACK --> <!-- .. message definition ACK --> <xsd:complexType name="ACK.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ACK" type="ACK.CONTENT" /> </xsd:schema>

Download

ADT/ACK - Patient Arriving - Tracking (Event A10)

The A10 event is sent when a patient arrives at a new location in the healthcare facility (inpatient or outpatient). The A09 - patient departing-tracking and A10 events are used when there is a change in a patient's physical location and when this is NOT a change in the official census bed location, as in the case of an outpatient setting. There are three varieties of these non-census location changes involving three different kinds of notification: (a) an unofficial notification of location change prior to the official notification of patient tracking, (b) the patient is in transit between locations for some time, (c) a notification of a temporary location change.

Patient tracking: If the patient is now at a non-temporary location and is not in transit, then PV1-3 - Assigned Patient Location must contain the new patient location and PV1-6 - Prior Patient Location can contain the old patient location.

In transit: This is used when there is some period of time between when the patient leaves his/her old location and when he/she arrives at the new assigned location. If the patient was in transit during the time between the A09 (patient departing-tracking) event and the A10 (patient arriving-tracking) event, then PV1-3 - Assigned Patient Location is used for the new location and PV1-6 - Prior Patient Location should be used for the old location. PV1-11 - Temporary Location and PV1-43 - Prior Temporary Location are not used.

Temporary location: An A10 event can also be used when the patient is being transferred from a temporary location (X-RAY, O/R, LIMBO, or HALLWAY) to the new assigned location. If the patient is arriving at a temporary location (such as the O/R, X-RAY, LIMBO, or HALLWAY), then PV1-11 - Temporary Location would be used to indicate the new temporary location. If the patient is moving from one temporary location to another, then PV1-43 - Prior Temporary Location may also be used. If the patient is arriving at a permanent location from a temporary location, PV1-3 - Assigned Patient Location should be used for the new location, and PV1-43 - Prior Temporary Location should be used for the old location.

The fields included when this message is sent should be the fields pertinent to communicate this event. When other important fields change, it is recommended that the A08 (update patient information) event be used in addition.

Attention: The DG1 segment was retained for backward compatibility only as of v2.4 and was withdrawn and removed from this message structure as of v2.7.

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ADT_A09

Segment	Cardinality	Must Implement	Status
ADT_A09
MSH	1..1	Yes
ARV	0..*
SFT	0..*
UAC	0..1
EVN	1..1	Yes
PID	1..1	Yes
PD1	0..1
PV1	1..1	Yes
PV2	0..1
DB1	0..*
OBSERVATION	0..*
OBX	1..1	Yes
PRT	0..*

Original Mode Acknowledgement Choreography for ADT^A10^ADT_A09

Send Application Ack: ADT^A10^ADT_A09

Enhanced Mode Acknowledgement Choreography for ADT^A10^ADT_A09

When the MSH-15 value of an ADT^A10^ADT_A09 message is AL or ER or SU, an ACK^A10^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ADT^A10^ADT_A09 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an ADT^A10^ADT_A09 message is AL or ER or SU, an ACK^A10^ACK message SHALL be sent as an application ack.

When the MSH-16 value of an ADT^A10^ADT_A09 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A10^ACK
	NE	(none)
MSH-16	AL, ER, SU	application ack: ACK^A10^ACK
	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ADT_A09--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ADT_A09 --> <!-- .. message definition ADT_A09 --> <xsd:complexType name="ADT_A09.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="EVN" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PD1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="PV1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PV2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="DB1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="OBX" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A09" type="ADT_A09.CONTENT" /> </xsd:schema>

Download

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ACK

Segment	Cardinality	Must Implement	Status
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^A10^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^A10^ACK

When the MSH-15 value of an ACK^A10^ACK message is AL or ER or SU, an ACK^A10^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^A10^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A10^ACK
	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ACK--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ACK --> <!-- .. message definition ACK --> <xsd:complexType name="ACK.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ACK" type="ACK.CONTENT" /> </xsd:schema>

Download

ADT/ACK - Cancel Admit / Visit Notification (Event 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. To cancel an A05 (pre-admit a patient) event, use the A38 (cancel pre-admit), which was new for Version 2.3 of this Standard.

The fields included when this message is sent should be the fields pertinent to communicate this event. When other important fields change, it is recommended that the A08 (update patient information) event be used in addition.

Attention: The DG1 segment was retained for backward compatibility only as of v2.4 and was withdrawn and removed from this message structure as of v2.7.

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ADT_A09

Segment	Cardinality	Must Implement	Status
ADT_A09
MSH	1..1	Yes
ARV	0..*
SFT	0..*
UAC	0..1
EVN	1..1	Yes
PID	1..1	Yes
PD1	0..1
PV1	1..1	Yes
PV2	0..1
DB1	0..*
OBSERVATION	0..*
OBX	1..1	Yes
PRT	0..*

Original Mode Acknowledgement Choreography for ADT^A11^ADT_A09

Send Application Ack: ADT^A11^ADT_A09

Enhanced Mode Acknowledgement Choreography for ADT^A11^ADT_A09

When the MSH-15 value of an ADT^A11^ADT_A09 message is AL or ER or SU, an ACK^A11^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ADT^A11^ADT_A09 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an ADT^A11^ADT_A09 message is AL or ER or SU, an ACK^A11^ACK message SHALL be sent as an application ack.

When the MSH-16 value of an ADT^A11^ADT_A09 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A11^ACK
	NE	(none)
MSH-16	AL, ER, SU	application ack: ACK^A11^ACK
	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ADT_A09--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ADT_A09 --> <!-- .. message definition ADT_A09 --> <xsd:complexType name="ADT_A09.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="EVN" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PD1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="PV1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PV2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="DB1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="OBX" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A09" type="ADT_A09.CONTENT" /> </xsd:schema>

Download

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ACK

Segment	Cardinality	Must Implement	Status
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^A11^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^A11^ACK

When the MSH-15 value of an ACK^A11^ACK message is AL or ER or SU, an ACK^A11^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^A11^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A11^ACK
	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ACK--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ACK --> <!-- .. message definition ACK --> <xsd:complexType name="ACK.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ACK" type="ACK.CONTENT" /> </xsd:schema>

Download

ADT/ACK - Cancel Transfer (Event 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. PV1-3 - Assigned Patient Location must show the location of the patient prior to the original transfer.

The fields included when this message is sent should be the fields pertinent to communicate this event. When other important fields change, it is recommended that the A08 (update patient information) even be used in addition.

Attention: The DG1 segment was retained for backward compatibility only as of v2.4 and was withdrawn and removed from this message structure as of v2.7.

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ADT_A09

Segment	Cardinality	Must Implement	Status
ADT_A09
MSH	1..1	Yes
ARV	0..*
SFT	0..*
UAC	0..1
EVN	1..1	Yes
PID	1..1	Yes
PD1	0..1
PV1	1..1	Yes
PV2	0..1
DB1	0..*
OBSERVATION	0..*
OBX	1..1	Yes
PRT	0..*

Original Mode Acknowledgement Choreography for ADT^A12^ADT_A12

Send Application Ack: ADT^A12^ADT_A12

Enhanced Mode Acknowledgement Choreography for ADT^A12^ADT_A12

When the MSH-15 value of an ADT^A12^ADT_A12 message is AL or ER or SU, an ACK^A12^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ADT^A12^ADT_A12 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an ADT^A12^ADT_A12 message is AL or ER or SU, an ACK^A12^ACK message SHALL be sent as an application ack.

When the MSH-16 value of an ADT^A12^ADT_A12 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A12^ACK
	NE	(none)
MSH-16	AL, ER, SU	application ack: ACK^A12^ACK
	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ADT_A12--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ADT_A12 --> <!-- .. message definition ADT_A12 --> <xsd:complexType name="ADT_A12.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="EVN" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PD1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="PV1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PV2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="DB1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="OBX" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A12" type="ADT_A12.CONTENT" /> </xsd:schema>

Download

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ACK

Segment	Cardinality	Must Implement	Status
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^A12^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^A12^ACK

When the MSH-15 value of an ACK^A12^ACK message is AL or ER or SU, an ACK^A12^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^A12^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A12^ACK
	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ACK--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ACK --> <!-- .. message definition ACK --> <xsd:complexType name="ACK.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ACK" type="ACK.CONTENT" /> </xsd:schema>

Download

ADT/ACK - Cancel Discharge / End Visit (Event 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. PV1-3 - Assigned Patient Location should reflect the location of the patient after the cancellation has been processed.

Note: This location may be different from the patient's location prior to the erroneous discharge. Prior Location could be used to show the location of the patient prior to the erroneous discharge.

The fields included when this message is sent should be the fields pertinent to communicate this event. When other important fields change, it is recommended that the A08 (update patient information) event be used in addition.

The PRT - Participation Segment is used in this message to communicate providers not specified elsewhere. Person level providers with an ongoing relationship are reported in the PRT segment following the PID/PD1 segments. Providers corresponding to the PV1 data are reported in the PRT segment following the PV1/PV2 segments. Providers related to a specific procedure are reported in the PRT segment following the PR1 segment. Providers related to a specific insurance are reported in the PRT segment following the IN1/IN2/IN3 segments. To communicate the begin- and end-date of the provider, use the –PRT-11 - Begin Date/Time and the –PRT-12 - End Date/Time in the ROL, with the applicable PRT-4 – Role of Participation. Refer to Chapter 7 for the definition of the PRT segment.

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ADT_A01

Segment	Cardinality	Must Implement	Status
ADT_A01
MSH	1..1	Yes
ARV	0..*
SFT	0..*
UAC	0..1
EVN	1..1	Yes
PID	1..1	Yes
PD1	0..1
OH1	0..*
OH2	0..*
OH3	0..1
OH4	0..*
ARV	0..*		B
ROL	0..*		B
PRT	0..*
NEXT_OF_KIN	0..*
NK1	1..1	Yes
OH2	0..*
OH3	0..1
PV1	1..1	Yes
PV2	0..1
ARV	0..*		B
ROL	0..*		B
PRT	0..*
DB1	0..*
OBSERVATION	0..*
OBX	1..1	Yes
PRT	0..*
AL1	0..*
IAM	0..*
DG1	0..*
DRG	0..1
PROCEDURE	0..*
PR1	1..1	Yes
ROL	0..*		B
PRT	0..*
GT1	0..*
INSURANCE	0..*
IN1	1..1	Yes
IN2	0..1
IN3	0..*
ROL	0..*		B
PRT	0..*
AUTHORIZATION	0..*
AUT	1..1	Yes
PRT	0..*
REFERRAL	0..*
RF1	1..1	Yes
PRT	0..*
ACC	0..1
UB1	0..1
UB2	0..1
PDA	0..1

Original Mode Acknowledgement Choreography for ADT^A13^ADT_A01

Send Application Ack: ADT^A13^ADT_A01

Enhanced Mode Acknowledgement Choreography for ADT^A13^ADT_A01

When the MSH-15 value of an ADT^A13^ADT_A01 message is AL or ER or SU, an ACK^A13^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ADT^A13^ADT_A01 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an ADT^A13^ADT_A01 message is AL or ER or SU, an ACK^A13^ACK message SHALL be sent as an application ack.

When the MSH-16 value of an ADT^A13^ADT_A01 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A13^ACK
	NE	(none)
MSH-16	AL, ER, SU	application ack: ACK^A13^ACK
	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ADT_A01--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ADT_A01 --> <!-- .. message definition ADT_A01 --> <xsd:complexType name="ADT_A01.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="EVN" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PD1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NK1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="PV1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PV2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DB1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="OBX" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="AL1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DG1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DRG" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ADT_A01.PROCEDURE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="GT1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ADT_A01.INSURANCE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ACC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="UB1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="UB2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="PDA" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A01" type="ADT_A01.CONTENT" /> <xsd:complexType name="ADT_A01.PROCEDURE.CONTENT"> <xsd:sequence> <xsd:element ref="PR1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A01.PROCEDURE" type="ADT_A01.PROCEDURE.CONTENT" /> <xsd:complexType name="ADT_A01.INSURANCE.CONTENT"> <xsd:sequence> <xsd:element ref="IN1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="IN2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="IN3" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="AUT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RF1" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A01.INSURANCE" type="ADT_A01.INSURANCE.CONTENT" /> </xsd:schema>

Download

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ACK

Segment	Cardinality	Must Implement	Status
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^A13^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^A13^ACK

When the MSH-15 value of an ACK^A13^ACK message is AL or ER or SU, an ACK^A13^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^A13^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A13^ACK
	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ACK--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ACK --> <!-- .. message definition ACK --> <xsd:complexType name="ACK.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ACK" type="ACK.CONTENT" /> </xsd:schema>

Download

ADT/ACK - Pending Admit (Event 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 an account should be opened for the purposes of tests prior to admission. It is used when advanced notification of an admit is required in order to prepare for the patient's arrival.

The PRT - Participation Segment is used in this message to communicate providers not specified elsewhere. Person level providers with an ongoing relationship are reported in the PRT segment following the PID/PD1 segments. Providers corresponding to the PV1 data are reported in the PRT segment following the PV1/PV2 segments. Providers related to a specific procedure are reported in the PRT segment following the PR1 segment. Providers related to a specific insurance are reported in the PRT segment following the IN1/IN2/IN3 segments. To communicate the begin- and end-date of the provider, use the –PRT-11 - Begin Date/Time and the –PRT-12 - End Date/Time in the PRT, with the applicable PRT-4 – Role of Participation. Refer to Chapter 7 for the definition of the PRT segment.

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ADT_A05

Segment	Cardinality	Must Implement	Status
ADT_A05
MSH	1..1	Yes
ARV	0..*
SFT	0..*
UAC	0..1
EVN	1..1	Yes
PID	1..1	Yes
PD1	0..1
OH1	0..*
OH2	0..*
OH3	0..1
OH4	0..*
ARV	0..*		B
ROL	0..*		B
PRT	0..*
NEXT_OF_KIN	0..*
NK1	1..1	Yes
OH2	0..*
OH3	0..1
PV1	1..1	Yes
PV2	0..1
ARV	0..*		B
ROL	0..*		B
PRT	0..*
DB1	0..*
OBSERVATION	0..*
OBX	1..1	Yes
PRT	0..*
AL1	0..*
IAM	0..*
DG1	0..*
DRG	0..1
PROCEDURE	0..*
PR1	1..1	Yes
ROL	0..*		B
PRT	0..*
GT1	0..*
INSURANCE	0..*
IN1	1..1	Yes
IN2	0..1
IN3	0..*
ROL	0..*		B
PRT	0..*
AUTHORIZATION	0..*
AUT	1..1	Yes
PRT	0..*
REFERRAL	0..*
RF1	1..1	Yes
PRT	0..*
ACC	0..1
UB1	0..1
UB2	0..1

Original Mode Acknowledgement Choreography for ADT^A14^ADT_A05

Send Application Ack: ADT^A14^ADT_A05

Enhanced Mode Acknowledgement Choreography for ADT^A14^ADT_A05

When the MSH-15 value of an ADT^A14^ADT_A05 message is AL or ER or SU, an ACK^A14^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ADT^A14^ADT_A05 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an ADT^A14^ADT_A05 message is AL or ER or SU, an ACK^A14^ACK message SHALL be sent as an application ack.

When the MSH-16 value of an ADT^A14^ADT_A05 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A14^ACK
	NE	(none)
MSH-16	AL, ER, SU	application ack: ACK^A14^ACK
	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ADT_A05--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ADT_A05 --> <!-- .. message definition ADT_A05 --> <xsd:complexType name="ADT_A05.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="EVN" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PD1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NK1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="PV1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PV2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DB1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="OBX" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="AL1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DG1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DRG" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ADT_A05.PROCEDURE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="GT1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ADT_A05.INSURANCE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ACC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="UB1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="UB2" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A05" type="ADT_A05.CONTENT" /> <xsd:complexType name="ADT_A05.PROCEDURE.CONTENT"> <xsd:sequence> <xsd:element ref="PR1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A05.PROCEDURE" type="ADT_A05.PROCEDURE.CONTENT" /> <xsd:complexType name="ADT_A05.INSURANCE.CONTENT"> <xsd:sequence> <xsd:element ref="IN1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="IN2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="IN3" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="AUT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RF1" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A05.INSURANCE" type="ADT_A05.INSURANCE.CONTENT" /> </xsd:schema>

Download

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ACK

Segment	Cardinality	Must Implement	Status
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^A14^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^A14^ACK

When the MSH-15 value of an ACK^A14^ACK message is AL or ER or SU, an ACK^A14^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^A14^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A14^ACK
	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ACK--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ACK --> <!-- .. message definition ACK --> <xsd:complexType name="ACK.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ACK" type="ACK.CONTENT" /> </xsd:schema>

Download

ADT/ACK - Pending Transfer (Event 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. For example, this transaction could be sent so that staff will be on hand to move the patient or so that dietary services can route the next meal to the new location.

The fields included when this message is sent should be the fields pertinent to communicate this event. When other important fields change, it is recommended that the A08 (update patient information) event be used in addition.

The ROL segment has been deprecated and retained for backwards compatiblity purposes only as of v 2.9. The reader is referred to the PRT segment instead.

The PRT - Participation Segment is used in this message to communicate providers not specified elsewhere. Person level providers with an ongoing relationship are reported in the PRT segment following the PID/PD1 segments. Providers corresponding to the PV1 data are reported in the PRT segment following the PV1/PV2 segments. Providers related to a specific procedure are reported in the PRT segment following the PR1 segment. Providers related to a specific insurance are reported in the PRT segment following the IN1/IN2/IN3 segments. To communicate the begin- and end-date of the provider, use the PRT-11 - Begin Date/Time and the PRT-12 - End Date/Time in the PRT segment, with the applicable PRT-4 – Role of Participation. Refer to Chapter 7 for the definition of the PRT segment.

Attention: The DG1 segment was retained in this message for backward compatibility only as of v2.4 and was withdrawn and removed from this message structure as of v2.7.

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ADT_A15

Segment	Cardinality	Must Implement	Status
ADT_A15
MSH	1..1	Yes
ARV	0..*
SFT	0..*
UAC	0..1
EVN	1..1	Yes
PID	1..1	Yes
PD1	0..1
ARV	0..*		B
ROL	0..*		B
PRT	0..*
PV1	1..1	Yes
PV2	0..1
ARV	0..*		B
ROL	0..*		B
PRT	1..*	Yes
DB1	0..*
OBSERVATION	0..*
OBX	1..1	Yes
PRT	0..*

Original Mode Acknowledgement Choreography for ADT^A15^ADT_A15

Send Application Ack: ADT^A15^ADT_A15

Enhanced Mode Acknowledgement Choreography for ADT^A15^ADT_A15

When the MSH-15 value of an ADT^A15^ADT_A15 message is AL or ER or SU, an ACK^A15^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ADT^A15^ADT_A15 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an ADT^A15^ADT_A15 message is AL or ER or SU, an ACK^A15^ACK message SHALL be sent as an application ack.

When the MSH-16 value of an ADT^A15^ADT_A15 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A15^ACK
	NE	(none)
MSH-16	AL, ER, SU	application ack: ACK^A15^ACK
	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ADT_A15--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ADT_A15 --> <!-- .. message definition ADT_A15 --> <xsd:complexType name="ADT_A15.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="EVN" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PD1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="PV1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PV2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DB1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="OBX" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A15" type="ADT_A15.CONTENT" /> </xsd:schema>

Download

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ACK

Segment	Cardinality	Must Implement	Status
ACK
MSH	1..1	Yes
SFT	0..*
UAC	0..1
MSA	1..1	Yes
ERR	0..*

Original Mode Acknowledgement Choreography for ACK^A15^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^A15^ACK

When the MSH-15 value of an ACK^A15^ACK message is AL or ER or SU, an ACK^A15^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^A15^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A15^ACK
	NE	(none)
MSH-16	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ACK--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ACK --> <!-- .. message definition ACK --> <xsd:complexType name="ACK.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ACK" type="ACK.CONTENT" /> </xsd:schema>

Download

ADT/ACK - Pending Discharge (Event 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. For example, it is used to notify the pharmacy of the possible need for discharge drugs or to notify psychotherapy of the possible need for post-discharge appointments or to notify the extended care or home health system that the patient will be discharged and that the new extended care and home health admission assessment can be scheduled.

The fields included when this message is sent should be the fields pertinent to communicate this event. When other important fields change, it is recommended that the A08 (update patient information) event be used in addition.

The ROL segment has been deprecated and retained for backwards compatiblity purposes only as of v 2.9. The reader is referred to the PRT segment instead.

The PRT – Participation Information Segment is used in this message to communicate providers not specified elsewhere. Person level providers with an ongoing relationship are reported in the PRT segment following the PID/PD1 segments. Providers corresponding to the PV1 data are reported in the PRT segment following the PV1/PV2 segments. Providers related to a specific procedure are reported in the PRT segment following the PR1 segment. Providers related to a specific insurance are reported in the PRT segment following the IN1/IN2/IN3 segments. To communicate the begin- and end-date of the provider, use the PRT-11 - Begin Date/Time and the PRT-12 - End Date/Time in the PRT, with the applicable PRT-4 – Role of Participation. Refer to Chapter 7 for the definition of the PRT segment.

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ADT_A16

Segment	Cardinality	Must Implement	Status
ADT_A16
MSH	1..1	Yes
ARV	0..*
SFT	0..*
UAC	0..1
EVN	1..1	Yes
PID	1..1	Yes
PD1	0..1
OH1	0..*
OH2	0..*
OH3	0..1
OH4	0..*
ARV	0..*		B
ROL	0..*		B
PRT	0..*
NEXT_OF_KIN	0..*
NK1	1..1	Yes
OH2	0..*
OH3	0..1
PV1	1..1	Yes
PV2	0..1
ARV	0..*		B
ROL	0..*		B
PRT	0..*
DB1	0..*
OBSERVATION	0..*
OBX	1..1	Yes
PRT	0..*
AL1	0..*
IAM	0..*
DG1	0..*
DRG	0..1
PROCEDURE	0..*
PR1	1..1	Yes
ROL	0..*		B
PRT	0..*
GT1	0..*
INSURANCE	0..*
IN1	1..1	Yes
IN2	0..1
IN3	0..*
ROL	0..*		B
PRT	0..*
AUTHORIZATION	0..*
AUT	1..1	Yes
PRT	0..*
REFERRAL	0..*
RF1	1..1	Yes
PRT	0..*
ACC	0..1

Original Mode Acknowledgement Choreography for ADT^A16^ADT_A16

Send Application Ack: ADT^A16^ADT_A16

Enhanced Mode Acknowledgement Choreography for ADT^A16^ADT_A16

When the MSH-15 value of an ADT^A16^ADT_A16 message is AL or ER or SU, an ACK^A16^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ADT^A16^ADT_A16 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an ADT^A16^ADT_A16 message is AL or ER or SU, an ACK^A16^ACK message SHALL be sent as an application ack.

When the MSH-16 value of an ADT^A16^ADT_A16 message is NE, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^A16^ACK
	NE	(none)
MSH-16	AL, ER, SU	application ack: ACK^A16^ACK
	NE	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ADT_A16--> <!-- Copyright (c) 1999-2019, Health Level Seven. All rights reserved. --> <!-- (generated on 09.01.2019 by HL7-Database) D:\Eigene Dateien\HL7\Datenbank\hl7_94.mdb--> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:hl7-org:v2xml" xmlns:hl7="urn:hl7-org:v2xml" targetNamespace="urn:hl7-org:v2xml" version="1.1"> <!-- import segment definition for version --> <xsd:include schemaLocation="segments.xsd" /> <!-- MESSAGE ADT_A16 --> <!-- .. message definition ADT_A16 --> <xsd:complexType name="ADT_A16.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="EVN" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PD1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NK1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="PV1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PV2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DB1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="OBX" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="AL1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DG1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="DRG" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ADT_A16.PROCEDURE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="GT1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ADT_A16.INSURANCE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ACC" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A16" type="ADT_A16.CONTENT" /> <xsd:complexType name="ADT_A16.PROCEDURE.CONTENT"> <xsd:sequence> <xsd:element ref="PR1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A16.PROCEDURE" type="ADT_A16.PROCEDURE.CONTENT" /> <xsd:complexType name="ADT_A16.INSURANCE.CONTENT"> <xsd:sequence> <xsd:element ref="IN1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="IN2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="IN3" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ROL" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="AUT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RF1" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ADT_A16.INSURANCE" type="ADT_A16.INSURANCE.CONTENT" /> </xsd:schema>

Download