Usage notes for pharmacy/treatment messages

For the RDS (pharmacy/treatment dispense), RGV (pharmacy/treatment give) and RAS (pharmacy/treatment administration) messages, the placer and filler order numbers are those of the parent RDE (pharmacy/treatment encoded order) message. In these messages, the filler order number does not provide a unique identification of the instance of the pharmacy/treatment action (dispense, give or administer). To correct this problem, each of the defining segments (RXD, RXG, and RXA) has an appropriately named sub-ID field (dispense sub-ID counter, give sub-ID counter, and administration sub-ID counter). The combination of the filler order number (including its application ID component) and the appropriate sub-ID counter uniquely identifies the instance of the pharmacy/treatment action(s) present in these messages.

Although the default order control code for the RDE, RDS, RGV and RAS messages is "RE," there are cases in which the pharmacy or treatment system and the receiving system must communicate changes in state. Depending on whether the pharmacy or treatment supplier's relationship to the receiving system is that of placer or filler, the appropriate order control code may be substituted for the default value of RE. The receiving system can also use an appropriate order control code to report status back to the pharmacy or treatment system.

For example, suppose that a pharmacy or treatment system is sending RGV messages to a nursing system which will administer the medication and that the pharmacy or treatment system needs to request that several instances of a give order be discontinued. To implement this request, the RGV message may be sent with a "DC" order control code (discontinue request), and the appropriate RXG segments whose give sub-ID fields identify the instances to be discontinued. If a notification back to the pharmacy or treatment supplier is needed, the nursing system can initiate an RGV message with a "DR" order control code (discontinue as requested), and containing RXG segments whose give sub-ID fields identify the discontinued instances.

IV solution groups

An order for a group of IV solutions to be given sequentially can be supported in two similar ways: Parent/Child and Separate Orders. This HL7 Standard supports both methods of ordering. The method used at a particular site must be negotiated between the site institution and the various application vendors. See Chapter 2, section 2.A.53 OSD Order Sequence Definition, "Use Case 1 Cyclic placer order groups," for further details.

OMP - Pharmacy/Treatment Order Message (Event O09)

OMP^O09^OMP_O09: Pharmacy/treatment Order Message

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - OMP_O09

Segment	Cardinality	Must Implement	Status
OMP_O09
MSH	1..1	Yes	additional
ARV	0..*		additional
SFT	0..*		additional
UAC	0..1		additional
NTE	0..*		additional
PATIENT	0..1		additional
PID	1..1	Yes	additional
NTE	0..*		additional
ARV	0..*		B
GT1	0..1		additional
AL1	0..*		additional
ADDITIONAL_DEMOGRAPHICS	0..1		additional
PD1	1..1	Yes	additional
PRT	0..*		additional
PATIENT_VISIT	0..1		additional
PV1	1..1	Yes	additional
PV2	0..1		additional
PRT	0..*		additional
ARV	0..*		B
INSURANCE	0..*		additional
IN1	1..1	Yes	additional
IN2	0..1		additional
IN3	0..1		additional
ORDER	1..*	Yes	additional
ORC	1..1	Yes	additional
RXO	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
RXR	1..*	Yes	additional
CDO	0..*		additional
FT1	0..*		additional
BLG	0..1		additional
TIMING	0..*		additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
COMPONENT	0..*		additional
RXC	1..1	Yes	additional
NTE	0..*		additional
OBSERVATION	0..*		additional
OBX	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional

Original Mode Acknowledgement Choreography for OMP^O09^OMP_O09

Send Application Ack: ORP^O10^ORP_O10

Enhanced Mode Acknowledgement Choreography for OMP^O09^OMP_O09

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

When the MSH-15 value of an OMP^O09^OMP_O09 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an OMP^O09^OMP_O09 message is AL or ER or SU, an ORP^O10^ORP_O10 or OSU^O52^OSU_O52 message SHALL be sent as an application ack.

When the MSH-16 value of an OMP^O09^OMP_O09 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^O09^ACK
	NE, AL, ER, SU	(none)
MSH-16	AL, ER, SU	application ack: ORP^O10^ORP_O10 or OSU^O52^OSU_O52
	NE, AL, ER, SU	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: OMP_O09--> <!-- 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 OMP_O09 --> <!-- .. message definition OMP_O09 --> <xsd:complexType name="OMP_O09.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="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="OMP_O09.PATIENT" minOccurs="0" maxOccurs="1" /> <xsd:element ref="OMP_O09.ORDER" minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="OMP_O09" type="OMP_O09.CONTENT" /> <xsd:complexType name="OMP_O09.PATIENT.CONTENT"> <xsd:sequence> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="OMP_O09.ADDITIONAL_DEMOGRAPHICS" minOccurs="0" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="OMP_O09.PATIENT_VISIT" minOccurs="0" maxOccurs="1" /> <xsd:element ref="OMP_O09.INSURANCE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="GT1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="AL1" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="OMP_O09.PATIENT" type="OMP_O09.PATIENT.CONTENT" /> <xsd:complexType name="OMP_O09.ADDITIONAL_DEMOGRAPHICS.CONTENT"> <xsd:sequence> <xsd:element ref="PD1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="OMP_O09.ADDITIONAL_DEMOGRAPHICS" type="OMP_O09.ADDITIONAL_DEMOGRAPHICS.CONTENT" /> <xsd:complexType name="OMP_O09.PATIENT_VISIT.CONTENT"> <xsd:sequence> <xsd:element ref="PV1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PV2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="OMP_O09.PATIENT_VISIT" type="OMP_O09.PATIENT_VISIT.CONTENT" /> <xsd:complexType name="OMP_O09.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="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="OMP_O09.INSURANCE" type="OMP_O09.INSURANCE.CONTENT" /> <xsd:complexType name="OMP_O09.ORDER.CONTENT"> <xsd:sequence> <xsd:element ref="ORC" minOccurs="1" maxOccurs="1" /> <xsd:element ref="OMP_O09.TIMING" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RXO" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RXR" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="OMP_O09.COMPONENT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="CDO" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="OMP_O09.OBSERVATION" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="FT1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="BLG" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="OMP_O09.ORDER" type="OMP_O09.ORDER.CONTENT" /> <xsd:complexType name="OMP_O09.TIMING.CONTENT"> <xsd:sequence> <xsd:element ref="TQ1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="TQ2" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="OMP_O09.TIMING" type="OMP_O09.TIMING.CONTENT" /> <xsd:complexType name="OMP_O09.COMPONENT.CONTENT"> <xsd:sequence> <xsd:element ref="RXC" minOccurs="1" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="OMP_O09.COMPONENT" type="OMP_O09.COMPONENT.CONTENT" /> <xsd:complexType name="OMP_O09.OBSERVATION.CONTENT"> <xsd:sequence> <xsd:element ref="OBX" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="OMP_O09.OBSERVATION" type="OMP_O09.OBSERVATION.CONTENT" /> </xsd:schema>

Download

ORP - Pharmacy/Treatment Order Acknowledgment (Event O10)

There is not supposed to be an Application Level acknowledgement to an Application Level Acknowledgement message. In Enhanced Mode, MSH-16 SHALL always be set to NE (Never).

ORP^O10^ORP_O10: Description

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - ORP_O10

Segment	Cardinality	Must Implement	Status
ORP_O10
MSH	1..1	Yes	additional
MSA	1..1	Yes	additional
ERR	0..*		additional
SFT	0..*		additional
UAC	0..1		additional
NTE	0..*		additional
RESPONSE	0..1		additional
PATIENT	0..1		additional
PID	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
ORDER	1..*	Yes	additional
ORC	1..1	Yes	additional
PRT	0..*		additional
TIMING	0..*		additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
ORDER_DETAIL	0..1		additional
RXO	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
RXR	1..*	Yes	additional
COMPONENT	0..*		additional
RXC	1..1	Yes	additional
NTE	0..*		additional

Original Mode Acknowledgement Choreography for ORP^O10^ORP_O10

Send Immediate Ack: ACK^O10^ACK

Enhanced Mode Acknowledgement Choreography for ORP^O10^ORP_O10

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

When the MSH-15 value of an ORP^O10^ORP_O10 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.

When the MSH-16 value of an ORP^O10^ORP_O10 message is AL or ER or SU, a message SHALL be sent as an application ack.

When the MSH-16 value of an ORP^O10^ORP_O10 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.

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

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: ORP_O10--> <!-- 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 ORP_O10 --> <!-- .. message definition ORP_O10 --> <xsd:complexType name="ORP_O10.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ORP_O10.RESPONSE" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ORP_O10" type="ORP_O10.CONTENT" /> <xsd:complexType name="ORP_O10.RESPONSE.CONTENT"> <xsd:sequence> <xsd:element ref="ORP_O10.PATIENT" minOccurs="0" maxOccurs="1" /> <xsd:element ref="ORP_O10.ORDER" minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ORP_O10.RESPONSE" type="ORP_O10.RESPONSE.CONTENT" /> <xsd:complexType name="ORP_O10.PATIENT.CONTENT"> <xsd:sequence> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ORP_O10.PATIENT" type="ORP_O10.PATIENT.CONTENT" /> <xsd:complexType name="ORP_O10.ORDER.CONTENT"> <xsd:sequence> <xsd:element ref="ORC" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ORP_O10.TIMING" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ORP_O10.ORDER_DETAIL" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ORP_O10.ORDER" type="ORP_O10.ORDER.CONTENT" /> <xsd:complexType name="ORP_O10.TIMING.CONTENT"> <xsd:sequence> <xsd:element ref="TQ1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="TQ2" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ORP_O10.TIMING" type="ORP_O10.TIMING.CONTENT" /> <xsd:complexType name="ORP_O10.ORDER_DETAIL.CONTENT"> <xsd:sequence> <xsd:element ref="RXO" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RXR" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="ORP_O10.COMPONENT" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ORP_O10.ORDER_DETAIL" type="ORP_O10.ORDER_DETAIL.CONTENT" /> <xsd:complexType name="ORP_O10.COMPONENT.CONTENT"> <xsd:sequence> <xsd:element ref="RXC" minOccurs="1" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="ORP_O10.COMPONENT" type="ORP_O10.COMPONENT.CONTENT" /> </xsd:schema>

Download

RDE/RRE - pharmacy/treatment encoded order message (O01/O02)

Attention: The use of RDE with the trigger of O01 and RRE with the trigger O02 is maintained for backward compatibility as of v 2.4 and is withdrawn as of v 2.7. Refer to RDE with trigger O11 and RRE with trigger O12 instead.

RDE - Pharmacy/Treatment Encoded Order Message (Event O11)

This message communicates the pharmacy or treatment application's encoding of the pharmacy/treatment order ,OMP, message. It may be sent as an unsolicited message to report on either a single order or multiple pharmacy/treatment orders for a patient.

The RDE/RRE message pair can also be used to communicate a refill authorization request; however, a specific trigger event has been assigned. See section 4A.3.13 "RDE - Pharmacy/Treatment Refill Authorization Request Message (Event O25)." As a site-specific variant, the original order segments (RXO, RXRs, associated RXCs, and any NTEs) may be sent optionally (for comparison).

The event O11 represents an encoding of an order. To communicate explicit dispense requests, which are different event types, the RDE^O11/RRE^O12 message pair is also used, but the event O49 is preferred. See section 4A.3.23 "RDE - Pharmacy/Treatment Dispense Request Message (Event O49)." As a site-specific variant, the original order segments (RXO, RXRs, associated RXCs, and any NTEs) may be sent optionally (for comparison).

Note:     The RXCs which follow the RXO may not be fully encoded, but those that follow the RXE must be fully encoded.

The NTE segment(s) following the PD1 segment are intended to communicate notes and comments relative to the patient.

The NTE segment(s) following the RXO segment are intended to communicate notes and comments relative to the pharmacy/treatment order.

The NTE segment(s) following the RXE segment are intended to communicate notes and comments relative to the encoded order.

The NTE segment(s) following the RXV segment are intended to communicate notes and comments relative to the encoded order.

The NTE segment(s) following the RXC segment are intended to communicate notes and comments relative to the component(s).

The NTE segment following the OBX segment is intended to communicate notes and comments relative to the results.

RDE^O11^RDE_O11: Pharmacy/Treatment Encoded Order Message

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - RDE_O11

Segment	Cardinality	Must Implement	Status
RDE_O11
MSH	1..1	Yes	additional
ARV	0..*		additional
SFT	0..*		additional
UAC	0..1		additional
NTE	0..*		additional
PATIENT	0..1		additional
PID	1..1	Yes	additional
PD1	0..1		additional
PRT	0..*		additional
NTE	0..*		additional
ARV	0..*		B
GT1	0..1		additional
AL1	0..*		additional
PATIENT_VISIT	0..1		additional
PV1	1..1	Yes	additional
PV2	0..1		additional
PRT	0..*		additional
ARV	0..*		B
INSURANCE	0..*		additional
IN1	1..1	Yes	additional
IN2	0..1		additional
IN3	0..1		additional
ORDER	1..*	Yes	additional
ORC	1..1	Yes	additional
PRT	0..*		additional
RXE	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
RXR	1..*	Yes	additional
RXC	0..*		additional
CDO	0..*		additional
FT1	0..*		additional
BLG	0..1		additional
CTI	0..*		additional
TIMING	0..*		additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
ORDER_DETAIL	0..1		additional
RXO	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
RXR	1..*	Yes	additional
COMPONENT	0..*		additional
RXC	1..1	Yes	additional
NTE	0..*		additional
TIMING_ENCODED	1..*	Yes	additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
PHARMACY_TREATMENT_INFUSION_ORDER	0..*		additional
RXV	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
TIMING_ENCODED	1..*	Yes	additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
OBSERVATION	0..*		additional
OBX	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional

Original Mode Acknowledgement Choreography for RDE^O11^RDE_O11

Send Application Ack: RRE^O12^RRE_O12

Enhanced Mode Acknowledgement Choreography for RDE^O11^RDE_O11

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

When the MSH-15 value of a RDE^O11^RDE_O11 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a RDE^O11^RDE_O11 message is AL or ER or SU, a RRE^O12^RRE_O12 or OSU^O52^OSU_O52 message SHALL be sent as an application ack.

When the MSH-16 value of a RDE^O11^RDE_O11 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.

Field	Value	Send Response
MSH-15	AL, ER, SU	immediate ack: ACK^O11^ACK
	NE, AL, ER, SU	(none)
MSH-16	AL, ER, SU	application ack: RRE^O12^RRE_O12 or OSU^O52^OSU_O52
	NE, AL, ER, SU	(none)

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: RDE_O11--> <!-- 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 RDE_O11 --> <!-- .. message definition RDE_O11 --> <xsd:complexType name="RDE_O11.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="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RDE_O11.PATIENT" minOccurs="0" maxOccurs="1" /> <xsd:element ref="RDE_O11.ORDER" minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDE_O11" type="RDE_O11.CONTENT" /> <xsd:complexType name="RDE_O11.PATIENT.CONTENT"> <xsd:sequence> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PD1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RDE_O11.PATIENT_VISIT" minOccurs="0" maxOccurs="1" /> <xsd:element ref="RDE_O11.INSURANCE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="GT1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="AL1" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDE_O11.PATIENT" type="RDE_O11.PATIENT.CONTENT" /> <xsd:complexType name="RDE_O11.PATIENT_VISIT.CONTENT"> <xsd:sequence> <xsd:element ref="PV1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PV2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDE_O11.PATIENT_VISIT" type="RDE_O11.PATIENT_VISIT.CONTENT" /> <xsd:complexType name="RDE_O11.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="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDE_O11.INSURANCE" type="RDE_O11.INSURANCE.CONTENT" /> <xsd:complexType name="RDE_O11.ORDER.CONTENT"> <xsd:sequence> <xsd:element ref="ORC" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RDE_O11.TIMING" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RDE_O11.ORDER_DETAIL" minOccurs="0" maxOccurs="1" /> <xsd:element ref="RXE" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RDE_O11.TIMING_ENCODED" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RDE_O11.PHARMACY_TREATMENT_INFUSION_ORDER" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RXR" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXC" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="CDO" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RDE_O11.OBSERVATION" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="FT1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="BLG" minOccurs="0" maxOccurs="1" /> <xsd:element ref="CTI" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDE_O11.ORDER" type="RDE_O11.ORDER.CONTENT" /> <xsd:complexType name="RDE_O11.TIMING.CONTENT"> <xsd:sequence> <xsd:element ref="TQ1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="TQ2" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDE_O11.TIMING" type="RDE_O11.TIMING.CONTENT" /> <xsd:complexType name="RDE_O11.ORDER_DETAIL.CONTENT"> <xsd:sequence> <xsd:element ref="RXO" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RXR" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RDE_O11.COMPONENT" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDE_O11.ORDER_DETAIL" type="RDE_O11.ORDER_DETAIL.CONTENT" /> <xsd:complexType name="RDE_O11.COMPONENT.CONTENT"> <xsd:sequence> <xsd:element ref="RXC" minOccurs="1" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDE_O11.COMPONENT" type="RDE_O11.COMPONENT.CONTENT" /> <xsd:complexType name="RDE_O11.TIMING_ENCODED.CONTENT"> <xsd:sequence> <xsd:element ref="TQ1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="TQ2" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDE_O11.TIMING_ENCODED" type="RDE_O11.TIMING_ENCODED.CONTENT" /> <xsd:complexType name="RDE_O11.PHARMACY_TREATMENT_INFUSION_ORDER.CONTENT"> <xsd:sequence> <xsd:element ref="RXV" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RDE_O11.TIMING_ENCODED" minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDE_O11.PHARMACY_TREATMENT_INFUSION_ORDER" type="RDE_O11.PHARMACY_TREATMENT_INFUSION_ORDER.CONTENT" /> <xsd:complexType name="RDE_O11.OBSERVATION.CONTENT"> <xsd:sequence> <xsd:element ref="OBX" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDE_O11.OBSERVATION" type="RDE_O11.OBSERVATION.CONTENT" /> </xsd:schema>

Download

RRE - Pharmacy/Treatment Encoded Order Acknowledgment (Event O12)

There is not supposed to be an Application Level acknowledgement to an Application Level Acknowledgement message. In Enhanced Mode, MSH-16 SHALL always be set to NE (Never).

RRE^O12^RRE_O12: Pharmacy/Treatment Encoded Order Acknowledgment Message

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - RRE_O12

Segment	Cardinality	Must Implement	Status
RRE_O12
MSH	1..1	Yes	additional
MSA	1..1	Yes	additional
ERR	0..*		additional
SFT	0..*		additional
UAC	0..1		additional
NTE	0..*		additional
RESPONSE	0..1		additional
PATIENT	0..1		additional
PID	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
ORDER	1..*	Yes	additional
ORC	1..1	Yes	additional
PRT	0..*		additional
TIMING	0..*		additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
ENCODING	0..1		additional
RXE	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
RXR	1..*	Yes	additional
RXC	0..*		additional
TIMING_ENCODED	1..*	Yes	additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional

Original Mode Acknowledgement Choreography for RRE^O12^RRE_O12

Send Immediate Ack: ACK^O12^ACK

Enhanced Mode Acknowledgement Choreography for RRE^O12^RRE_O12

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

When the MSH-15 value of a RRE^O12^RRE_O12 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a RRE^O12^RRE_O12 message is AL or ER or SU, a message SHALL be sent as an application ack.

When the MSH-16 value of a RRE^O12^RRE_O12 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.

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

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: RRE_O12--> <!-- 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 RRE_O12 --> <!-- .. message definition RRE_O12 --> <xsd:complexType name="RRE_O12.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RRE_O12.RESPONSE" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRE_O12" type="RRE_O12.CONTENT" /> <xsd:complexType name="RRE_O12.RESPONSE.CONTENT"> <xsd:sequence> <xsd:element ref="RRE_O12.PATIENT" minOccurs="0" maxOccurs="1" /> <xsd:element ref="RRE_O12.ORDER" minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRE_O12.RESPONSE" type="RRE_O12.RESPONSE.CONTENT" /> <xsd:complexType name="RRE_O12.PATIENT.CONTENT"> <xsd:sequence> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRE_O12.PATIENT" type="RRE_O12.PATIENT.CONTENT" /> <xsd:complexType name="RRE_O12.ORDER.CONTENT"> <xsd:sequence> <xsd:element ref="ORC" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RRE_O12.TIMING" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RRE_O12.ENCODING" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRE_O12.ORDER" type="RRE_O12.ORDER.CONTENT" /> <xsd:complexType name="RRE_O12.TIMING.CONTENT"> <xsd:sequence> <xsd:element ref="TQ1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="TQ2" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRE_O12.TIMING" type="RRE_O12.TIMING.CONTENT" /> <xsd:complexType name="RRE_O12.ENCODING.CONTENT"> <xsd:sequence> <xsd:element ref="RXE" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RRE_O12.TIMING_ENCODED" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXR" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXC" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRE_O12.ENCODING" type="RRE_O12.ENCODING.CONTENT" /> <xsd:complexType name="RRE_O12.TIMING_ENCODED.CONTENT"> <xsd:sequence> <xsd:element ref="TQ1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="TQ2" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRE_O12.TIMING_ENCODED" type="RRE_O12.TIMING_ENCODED.CONTENT" /> </xsd:schema>

Download

RDS - Pharmacy/Treatment Dispense Message (Event O13)

The RDS message may be created by the pharmacy/treatment application for each instance of dispensing a drug or treatment to fill an existing order or orders. In the most common case, the RDS messages would be routed to a Nursing application or to some clinical application, which needs the data about drugs dispensed or treatments given. As a site-specific variant, the original order segments (RXO, RXE and their associated RXR/RXCs) may be sent optionally (for comparison).

The ORC must have the filler order number and the order control code RE. The RXE and associated RXCs may be present if the receiving application needs any of their data. The RXD carries the dispense data for a given issuance of medication: thus it may describe a single dose, a half-day dose, a daily dose, a refill of a prescription, etc. The RXD is not a complete record of an order. Use the RXO and RXE segments if a complete order is needed. It is a record from the pharmacy or treatment supplier to the Nursing application (or other) with drug/treatment dispense and administration instructions.

The FT1 segment is optional and repeating in order to accommodate multiple charge, benefit and pricing situations. Example use cases demonstrating zero, one and two FT1 segments follow:

In the case where the RDS message represents a dispense event that is in process (i.e., has not been received by the patient), the financial transactions associated with the dispense do not yet exist. Until the financial transactions associated with the dispense event have been completed, no FT1 segment may exist in the message.

In the case where the RDS message represents a dispense event that has been received by the patient, and thus all financial transactions have been completed, the RDS message may contain one or more FT1 segments. Examples of single and multiple FT1 segments follow.

Payment for the dispense event completed by a single payor:

MSH|^&~\|Pharm|GenHosp|CIS|GenHosp|2006082911150700||RDS^O13^RDS_O13|...

PID|...

ORC|RE|...

RXD|1|00310-0131-10^LISINOPRIL 10MG TABLET^NDC|200607150830|100|TAB|...

FT1|1|||200607151035||PY|00310-0131-10^LISINOPRIL 10MG TABLET^NDC|||100|125.43&USD|...

Payment for the dispense event involves multiple payment sources:

MSH|^&~\|Pharm|GenHosp|CIS|GenHosp|2006082213000700||RDS^O13^RDS_O13|...

PID|...

ORC|RE|...

RXD|1|00340-0241-10^VERAPAMIL 120MG TABLET^NDC|200607200940|100|TAB|...

FT1|1|||200607211055||CD|00340024110^VERAPAMIL 120MG TABLET ^NDC|||100|55.43&USD|... (amount paid by insurance)

FT1|2|||200607211055||CP|00340024110^VERAPAMIL 120MG TABLET ^NDC|||100|5.00&USD|... (copay paid by patient)

Note: The use of RDS with the trigger of O01 and RRD with the trigger O02 is maintained for backward compatibility as of v 2.4 and is withdrawn as of v 2.7.

Note:    The NTE segment(s) following the PD1 segment are intended to communicate notes and comments relative to the patient.

The NTE segment(s) following the RXO segment are intended to communicate notes and comments relative to the pharmacy/treatment order.

The NTE segment(s) following the RXE segment are intended to communicate notes and comments relative to the encoded order.

The NTE segment(s) following the RXD segment are intended to communicate notes and comments relative to the dispense event.

The NTE segment(s) following the RXC segment are intended to communicate notes and comments relative to the component(s).

The NTE segment following the OBX segment is intended to communicate notes and comments relative to the results.

RDS^O13^RDS_O13: Pharmacy/Treatment Dispense Message

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - RDS_O13

Segment	Cardinality	Must Implement	Status
RDS_O13
MSH	1..1	Yes	additional
ARV	0..*		additional
SFT	0..*		additional
UAC	0..1		additional
NTE	0..*		additional
PATIENT	0..1		additional
PID	1..1	Yes	additional
PD1	1..1	Yes	additional
PRT	0..*		additional
ARV	0..*		B
NTE	0..*		additional
AL1	0..*		additional
PATIENT_VISIT	0..1		additional
PV1	1..1	Yes	additional
PV2	0..1		additional
PRT	0..*		additional
ARV	0..*		B
ORDER	1..*	Yes	additional
ORC	1..1	Yes	additional
PRT	0..*		additional
RXD	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
RXR	1..*	Yes	additional
RXC	0..*		additional
CDO	0..*		additional
FT1	0..*		additional
TIMING	0..*		additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
ORDER_DETAIL	0..1		additional
RXO	1..1	Yes	additional
PRT	0..*		additional
ORDER_DETAIL_SUPPLEMENT	0..1		additional
NTE	1..*	Yes	additional
RXR	1..*	Yes	additional
COMPONENT	0..*		additional
RXC	1..1	Yes	additional
NTE	0..*		additional
ENCODING	0..1		additional
RXE	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
RXR	1..*	Yes	additional
RXC	0..*		additional
TIMING_ENCODED	1..*	Yes	additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
OBSERVATION	0..*		additional
OBX	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional

Original Mode Acknowledgement Choreography for RDS^O13^RDS_O13

Send Application Ack: RRD^O14^RRD_O14

Enhanced Mode Acknowledgement Choreography for RDS^O13^RDS_O13

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

When the MSH-15 value of a RDS^O13^RDS_O13 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a RDS^O13^RDS_O13 message is AL or ER or SU, a RRD^O14^RRD_O14 message SHALL be sent as an application ack.

When the MSH-16 value of a RDS^O13^RDS_O13 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.

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

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: RDS_O13--> <!-- 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 RDS_O13 --> <!-- .. message definition RDS_O13 --> <xsd:complexType name="RDS_O13.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="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RDS_O13.PATIENT" minOccurs="0" maxOccurs="1" /> <xsd:element ref="RDS_O13.ORDER" minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDS_O13" type="RDS_O13.CONTENT" /> <xsd:complexType name="RDS_O13.PATIENT.CONTENT"> <xsd:sequence> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="RDS_O13.ADDITIONAL_DEMOGRAPHICS" minOccurs="0" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="AL1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RDS_O13.PATIENT_VISIT" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDS_O13.PATIENT" type="RDS_O13.PATIENT.CONTENT" /> <xsd:complexType name="RDS_O13.ADDITIONAL_DEMOGRAPHICS.CONTENT"> <xsd:sequence> <xsd:element ref="PD1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDS_O13.ADDITIONAL_DEMOGRAPHICS" type="RDS_O13.ADDITIONAL_DEMOGRAPHICS.CONTENT" /> <xsd:complexType name="RDS_O13.PATIENT_VISIT.CONTENT"> <xsd:sequence> <xsd:element ref="PV1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PV2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDS_O13.PATIENT_VISIT" type="RDS_O13.PATIENT_VISIT.CONTENT" /> <xsd:complexType name="RDS_O13.ORDER.CONTENT"> <xsd:sequence> <xsd:element ref="ORC" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RDS_O13.TIMING" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RDS_O13.ORDER_DETAIL" minOccurs="0" maxOccurs="1" /> <xsd:element ref="RDS_O13.ENCODING" minOccurs="0" maxOccurs="1" /> <xsd:element ref="RXD" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RXR" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXC" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="CDO" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RDS_O13.OBSERVATION" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="FT1" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDS_O13.ORDER" type="RDS_O13.ORDER.CONTENT" /> <xsd:complexType name="RDS_O13.TIMING.CONTENT"> <xsd:sequence> <xsd:element ref="TQ1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="TQ2" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDS_O13.TIMING" type="RDS_O13.TIMING.CONTENT" /> <xsd:complexType name="RDS_O13.ORDER_DETAIL.CONTENT"> <xsd:sequence> <xsd:element ref="RXO" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RDS_O13.ORDER_DETAIL_SUPPLEMENT" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDS_O13.ORDER_DETAIL" type="RDS_O13.ORDER_DETAIL.CONTENT" /> <xsd:complexType name="RDS_O13.ORDER_DETAIL_SUPPLEMENT.CONTENT"> <xsd:sequence> <xsd:element ref="NTE" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXR" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RDS_O13.COMPONENT" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDS_O13.ORDER_DETAIL_SUPPLEMENT" type="RDS_O13.ORDER_DETAIL_SUPPLEMENT.CONTENT" /> <xsd:complexType name="RDS_O13.COMPONENT.CONTENT"> <xsd:sequence> <xsd:element ref="RXC" minOccurs="1" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDS_O13.COMPONENT" type="RDS_O13.COMPONENT.CONTENT" /> <xsd:complexType name="RDS_O13.ENCODING.CONTENT"> <xsd:sequence> <xsd:element ref="RXE" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RDS_O13.TIMING_ENCODED" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXR" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXC" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDS_O13.ENCODING" type="RDS_O13.ENCODING.CONTENT" /> <xsd:complexType name="RDS_O13.TIMING_ENCODED.CONTENT"> <xsd:sequence> <xsd:element ref="TQ1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="TQ2" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDS_O13.TIMING_ENCODED" type="RDS_O13.TIMING_ENCODED.CONTENT" /> <xsd:complexType name="RDS_O13.OBSERVATION.CONTENT"> <xsd:sequence> <xsd:element ref="OBX" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDS_O13.OBSERVATION" type="RDS_O13.OBSERVATION.CONTENT" /> </xsd:schema>

Download

RRD - Pharmacy/Treatment Dispense Acknowledgement Message (Event O14)

There is not supposed to be an Application Level acknowledgement to an Application Level Acknowledgement message. In Enhanced Mode, MSH-16 SHALL always be set to NE (Never).

RGV/RRG - pharmacy/treatment give message (O01/O02)

Attention: The use of RGV with the trigger of O01 and RRG with the trigger O02 is maintained for backward compatibility as of v 2.4 and is withdrawn as of v 2.7. Refer to RGV with trigger O15 and RRG with trigger O16 instead.

RGV - Pharmacy/Treatment Give Message (Event O15)

When the "give" (i.e., administration) information needs to be transmitted from the pharmacy or treatment application to another application, it is done with the RGV message. The RGV message uses the RXG segment to record drug or treatment administration instructions, which is not contained in an RDS, dispense message. The RGV message may carry information about a single scheduled administration on a drug or treatment, or it may carry information about multiple administrations. If the pharmacy or treatment application (or some other application) needs to create an unambiguous MAR report where each administration is matched to a particular give date/time instruction, it may use the RGV message as described in the following way:

For each scheduled administration of the medication, the pharmacy/treatment issues either a single RGV message or a single RGV message with multiple RXG segments, one for each scheduled administration. The actual administrations (transmitted by one or more RAS messages) are matched against the scheduled ones by recording in each RXA segment the Give Sub-ID of the corresponding RXG segment. If more than one administration needs to be matched (as in the case of recording a change or rate of an IV solution) the administering application issues additional RXA segment(s) (corresponding to the same RXG segment). If no matching is needed, the Give Sub-ID of the RXA segments has the value zero (0).

When used for a scheduled administration or for the start of a continuous administration such as an IV fluid, the ORC must have the filler order number and the order control code RE.

When used for an update to a continuous administration which is currently in progress (e.g. change of rate of an IV fluid), the ORC must have the filler order number and the order control code XO. For these updates the value of RXG-1 Give Sub-ID Counter may be used to provide a unique reference (see section 4A.4.6.1).

The RXE and associated RXCs may be present if the receiving application needs any of their data. The RXG carries the scheduled administration data for either a single "give instruction" (single dose) of medication or for multiple "give instructions." The RXG is not a complete record of an order. Use the RXO and RXE segments if a complete order is needed. It is a record from the pharmacy or treatment application to the Nursing application (or other) with drug/treatment administration instructions.

RGV^O15^RGV_O15: Pharmacy/Treatment Give

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - RGV_O15

Segment	Cardinality	Must Implement	Status
RGV_O15
MSH	1..1	Yes	additional
ARV	0..*		additional
SFT	0..*		additional
UAC	0..1		additional
NTE	0..*		additional
PATIENT	0..1		additional
PID	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
AL1	0..*		additional
ARV	0..*		B
PATIENT_VISIT	0..1		additional
PV1	1..1	Yes	additional
PV2	0..1		additional
PRT	0..*		additional
ARV	0..*		B
ORDER	1..*	Yes	additional
ORC	1..1	Yes	additional
PRT	0..*		additional
TIMING	0..*		additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
ORDER_DETAIL	0..1		additional
RXO	1..1	Yes	additional
PRT	0..*		additional
ORDER_DETAIL_SUPPLEMENT	0..1		additional
NTE	1..*	Yes	additional
RXR	1..*	Yes	additional
COMPONENTS	0..*		additional
RXC	1..1	Yes	additional
NTE	0..*		additional
ENCODING	0..1		additional
RXE	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
RXR	1..*	Yes	additional
RXC	0..*		additional
TIMING_ENCODED	1..*	Yes	additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
GIVE	1..*	Yes	additional
RXG	1..1	Yes	additional
PRT	0..*		additional
RXR	1..*	Yes	additional
RXC	0..*		additional
CDO	0..*		additional
TIMING_GIVE	1..*	Yes	additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
OBSERVATION	0..*		additional
OBX	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional

Original Mode Acknowledgement Choreography for RGV^O15^RGV_O15

Send Application Ack: RRG^O16^RRG_O16

Enhanced Mode Acknowledgement Choreography for RGV^O15^RGV_O15

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

When the MSH-15 value of a RGV^O15^RGV_O15 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a RGV^O15^RGV_O15 message is AL or ER or SU, a RRG^O16^RRG_O16 message SHALL be sent as an application ack.

When the MSH-16 value of a RGV^O15^RGV_O15 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.

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

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: RGV_O15--> <!-- 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 RGV_O15 --> <!-- .. message definition RGV_O15 --> <xsd:complexType name="RGV_O15.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="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RGV_O15.PATIENT" minOccurs="0" maxOccurs="1" /> <xsd:element ref="RGV_O15.ORDER" minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RGV_O15" type="RGV_O15.CONTENT" /> <xsd:complexType name="RGV_O15.PATIENT.CONTENT"> <xsd:sequence> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="AL1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RGV_O15.PATIENT_VISIT" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RGV_O15.PATIENT" type="RGV_O15.PATIENT.CONTENT" /> <xsd:complexType name="RGV_O15.PATIENT_VISIT.CONTENT"> <xsd:sequence> <xsd:element ref="PV1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PV2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RGV_O15.PATIENT_VISIT" type="RGV_O15.PATIENT_VISIT.CONTENT" /> <xsd:complexType name="RGV_O15.ORDER.CONTENT"> <xsd:sequence> <xsd:element ref="ORC" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RGV_O15.TIMING" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RGV_O15.ORDER_DETAIL" minOccurs="0" maxOccurs="1" /> <xsd:element ref="RGV_O15.ENCODING" minOccurs="0" maxOccurs="1" /> <xsd:element ref="RGV_O15.GIVE" minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RGV_O15.ORDER" type="RGV_O15.ORDER.CONTENT" /> <xsd:complexType name="RGV_O15.TIMING.CONTENT"> <xsd:sequence> <xsd:element ref="TQ1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="TQ2" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RGV_O15.TIMING" type="RGV_O15.TIMING.CONTENT" /> <xsd:complexType name="RGV_O15.ORDER_DETAIL.CONTENT"> <xsd:sequence> <xsd:element ref="RXO" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RGV_O15.ORDER_DETAIL_SUPPLEMENT" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RGV_O15.ORDER_DETAIL" type="RGV_O15.ORDER_DETAIL.CONTENT" /> <xsd:complexType name="RGV_O15.ORDER_DETAIL_SUPPLEMENT.CONTENT"> <xsd:sequence> <xsd:element ref="NTE" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXR" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RGV_O15.COMPONENTS" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RGV_O15.ORDER_DETAIL_SUPPLEMENT" type="RGV_O15.ORDER_DETAIL_SUPPLEMENT.CONTENT" /> <xsd:complexType name="RGV_O15.COMPONENTS.CONTENT"> <xsd:sequence> <xsd:element ref="RXC" minOccurs="1" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RGV_O15.COMPONENTS" type="RGV_O15.COMPONENTS.CONTENT" /> <xsd:complexType name="RGV_O15.ENCODING.CONTENT"> <xsd:sequence> <xsd:element ref="RXE" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RGV_O15.TIMING_ENCODED" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXR" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXC" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RGV_O15.ENCODING" type="RGV_O15.ENCODING.CONTENT" /> <xsd:complexType name="RGV_O15.TIMING_ENCODED.CONTENT"> <xsd:sequence> <xsd:element ref="TQ1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="TQ2" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RGV_O15.TIMING_ENCODED" type="RGV_O15.TIMING_ENCODED.CONTENT" /> <xsd:complexType name="RGV_O15.GIVE.CONTENT"> <xsd:sequence> <xsd:element ref="RXG" minOccurs="1" maxOccurs="1" /> <xsd:element ref="RGV_O15.TIMING_GIVE" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXR" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXC" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="CDO" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RGV_O15.OBSERVATION" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RGV_O15.GIVE" type="RGV_O15.GIVE.CONTENT" /> <xsd:complexType name="RGV_O15.TIMING_GIVE.CONTENT"> <xsd:sequence> <xsd:element ref="TQ1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="TQ2" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RGV_O15.TIMING_GIVE" type="RGV_O15.TIMING_GIVE.CONTENT" /> <xsd:complexType name="RGV_O15.OBSERVATION.CONTENT"> <xsd:sequence> <xsd:element ref="OBX" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RGV_O15.OBSERVATION" type="RGV_O15.OBSERVATION.CONTENT" /> </xsd:schema>

Download

RRG - Pharmacy/Treatment Give Acknowledgment Message (Event O16)

There is not supposed to be an Application Level acknowledgement to an Application Level Acknowledgement message. In Enhanced Mode, MSH-16 SHALL always be set to NE (Never).

RRG^O16^RRG_O16: Pharmacy/Treatment Give Acknowledgment Message

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - RRG_O16

Segment	Cardinality	Must Implement	Status
RRG_O16
MSH	1..1	Yes	additional
MSA	1..1	Yes	additional
ERR	0..*		additional
SFT	0..*		additional
UAC	0..1		additional
NTE	0..*		additional
RESPONSE	0..1		additional
PATIENT	0..1		additional
PID	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
ORDER	1..*	Yes	additional
ORC	1..1	Yes	additional
PRT	0..*		additional
TIMING	0..*		additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
GIVE	0..1		additional
RXG	1..1	Yes	additional
PRT	0..*		additional
RXR	1..*	Yes	additional
RXC	0..*		additional
TIMING_GIVE	1..*	Yes	additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional

Original Mode Acknowledgement Choreography for RRG^O16^RRG_O16

Send Immediate Ack: ACK^O16^ACK

Enhanced Mode Acknowledgement Choreography for RRG^O16^RRG_O16

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

When the MSH-15 value of a RRG^O16^RRG_O16 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a RRG^O16^RRG_O16 message is AL or ER or SU, a message SHALL be sent as an application ack.

When the MSH-16 value of a RRG^O16^RRG_O16 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.

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

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: RRG_O16--> <!-- 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 RRG_O16 --> <!-- .. message definition RRG_O16 --> <xsd:complexType name="RRG_O16.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RRG_O16.RESPONSE" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRG_O16" type="RRG_O16.CONTENT" /> <xsd:complexType name="RRG_O16.RESPONSE.CONTENT"> <xsd:sequence> <xsd:element ref="RRG_O16.PATIENT" minOccurs="0" maxOccurs="1" /> <xsd:element ref="RRG_O16.ORDER" minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRG_O16.RESPONSE" type="RRG_O16.RESPONSE.CONTENT" /> <xsd:complexType name="RRG_O16.PATIENT.CONTENT"> <xsd:sequence> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRG_O16.PATIENT" type="RRG_O16.PATIENT.CONTENT" /> <xsd:complexType name="RRG_O16.ORDER.CONTENT"> <xsd:sequence> <xsd:element ref="ORC" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RRG_O16.TIMING" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RRG_O16.GIVE" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRG_O16.ORDER" type="RRG_O16.ORDER.CONTENT" /> <xsd:complexType name="RRG_O16.TIMING.CONTENT"> <xsd:sequence> <xsd:element ref="TQ1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="TQ2" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRG_O16.TIMING" type="RRG_O16.TIMING.CONTENT" /> <xsd:complexType name="RRG_O16.GIVE.CONTENT"> <xsd:sequence> <xsd:element ref="RXG" minOccurs="1" maxOccurs="1" /> <xsd:element ref="RRG_O16.TIMING_GIVE" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXR" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXC" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRG_O16.GIVE" type="RRG_O16.GIVE.CONTENT" /> <xsd:complexType name="RRG_O16.TIMING_GIVE.CONTENT"> <xsd:sequence> <xsd:element ref="TQ1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="TQ2" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRG_O16.TIMING_GIVE" type="RRG_O16.TIMING_GIVE.CONTENT" /> </xsd:schema>

Download

RAS/RRA - pharmacy/treatment administration message (O01/O02)

Note: The use of RAS with the trigger of O01 and RRA with the trigger O02 is maintained for backward compatibility as of v2.4 and is withdrawn as of v2.7. Refer to RAS with trigger O17 and RRA with trigger O18 instead.

RAS - Pharmacy/Treatment Administration Message (Event O17)

The RAS message may be created by the administering application (e.g., nursing application) for each instance of administration for an existing order. If the administering application wants to report several administrations of medication/treatment for a given order with a single RAS message, each instance is reported by a separate (repeating) RXA segment. In addition, the administration records for a group of orders may be sent in a single message by creating repeating groups of segments at the ORC level.

In the most common case, the RAS messages would be sent from a nursing application to the pharmacy or treatment application (or to the ordering application or another clinical application), which could use the data to generate the medication administration reports. Multiple RXA segments, each corresponding to a separate administration instance for a given order, may be sent with a single ORC.

RAS^O17^RAS_O17: Pharmacy/Treatment Administration

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - RAS_O17

Segment	Cardinality	Must Implement	Status
RAS_O17
MSH	1..1	Yes	additional
ARV	0..*		additional
SFT	0..*		additional
UAC	0..1		additional
NTE	0..*		additional
PATIENT	0..1		additional
PID	1..1	Yes	additional
PD1	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
ARV	0..*		B
AL1	0..*		additional
PATIENT_VISIT	0..1		additional
PV1	1..1	Yes	additional
PV2	0..1		additional
PRT	0..*		additional
ARV	0..*		B
ORDER	1..*	Yes	additional
ORC	1..1	Yes	additional
PRT	0..*		additional
CTI	0..*		additional
TIMING	0..*		additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
ORDER_DETAIL	0..1		additional
RXO	1..1	Yes	additional
PRT	0..*		additional
ORDER_DETAIL_SUPPLEMENT	0..1		additional
NTE	1..*	Yes	additional
RXR	1..*	Yes	additional
COMPONENTS	0..*		additional
RXC	1..1	Yes	additional
NTE	0..*		additional
ENCODING	0..1		additional
RXE	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
RXR	1..*	Yes	additional
RXC	0..*		additional
CDO	0..*		additional
TIMING_ENCODED	1..*	Yes	additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
ADMINISTRATION	1..*	Yes	additional
RXA	1..*	Yes	additional
PRT	0..*		additional
RXR	1..1	Yes	additional
OBSERVATION	0..*		additional
OBX	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional

Original Mode Acknowledgement Choreography for RAS^O17^RAS_O17

Send Application Ack: RRA^O18^RRA_O18

Enhanced Mode Acknowledgement Choreography for RAS^O17^RAS_O17

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

When the MSH-15 value of a RAS^O17^RAS_O17 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a RAS^O17^RAS_O17 message is AL or ER or SU, a RRA^O18^RRA_O18 message SHALL be sent as an application ack.

When the MSH-16 value of a RAS^O17^RAS_O17 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.

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

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: RAS_O17--> <!-- 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 RAS_O17 --> <!-- .. message definition RAS_O17 --> <xsd:complexType name="RAS_O17.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="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RAS_O17.PATIENT" minOccurs="0" maxOccurs="1" /> <xsd:element ref="RAS_O17.ORDER" minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RAS_O17" type="RAS_O17.CONTENT" /> <xsd:complexType name="RAS_O17.PATIENT.CONTENT"> <xsd:sequence> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="RAS_O17.ADDITIONAL_DEMOGRAPHICS" minOccurs="0" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="AL1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RAS_O17.PATIENT_VISIT" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RAS_O17.PATIENT" type="RAS_O17.PATIENT.CONTENT" /> <xsd:complexType name="RAS_O17.ADDITIONAL_DEMOGRAPHICS.CONTENT"> <xsd:sequence> <xsd:element ref="PD1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RAS_O17.ADDITIONAL_DEMOGRAPHICS" type="RAS_O17.ADDITIONAL_DEMOGRAPHICS.CONTENT" /> <xsd:complexType name="RAS_O17.PATIENT_VISIT.CONTENT"> <xsd:sequence> <xsd:element ref="PV1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PV2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RAS_O17.PATIENT_VISIT" type="RAS_O17.PATIENT_VISIT.CONTENT" /> <xsd:complexType name="RAS_O17.ORDER.CONTENT"> <xsd:sequence> <xsd:element ref="ORC" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RAS_O17.TIMING" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RAS_O17.ORDER_DETAIL" minOccurs="0" maxOccurs="1" /> <xsd:element ref="RAS_O17.ENCODING" minOccurs="0" maxOccurs="1" /> <xsd:element ref="RAS_O17.ADMINISTRATION" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="CTI" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RAS_O17.ORDER" type="RAS_O17.ORDER.CONTENT" /> <xsd:complexType name="RAS_O17.TIMING.CONTENT"> <xsd:sequence> <xsd:element ref="TQ1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="TQ2" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RAS_O17.TIMING" type="RAS_O17.TIMING.CONTENT" /> <xsd:complexType name="RAS_O17.ORDER_DETAIL.CONTENT"> <xsd:sequence> <xsd:element ref="RXO" minOccurs="1" maxOccurs="1" /> <xsd:element ref="RAS_O17.ORDER_DETAIL_SUPPLEMENT" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RAS_O17.ORDER_DETAIL" type="RAS_O17.ORDER_DETAIL.CONTENT" /> <xsd:complexType name="RAS_O17.ORDER_DETAIL_SUPPLEMENT.CONTENT"> <xsd:sequence> <xsd:element ref="NTE" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXR" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RAS_O17.COMPONENTS" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RAS_O17.ORDER_DETAIL_SUPPLEMENT" type="RAS_O17.ORDER_DETAIL_SUPPLEMENT.CONTENT" /> <xsd:complexType name="RAS_O17.COMPONENTS.CONTENT"> <xsd:sequence> <xsd:element ref="RXC" minOccurs="1" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RAS_O17.COMPONENTS" type="RAS_O17.COMPONENTS.CONTENT" /> <xsd:complexType name="RAS_O17.ENCODING.CONTENT"> <xsd:sequence> <xsd:element ref="RXE" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RAS_O17.TIMING_ENCODED" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXR" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXC" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="CDO" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RAS_O17.ENCODING" type="RAS_O17.ENCODING.CONTENT" /> <xsd:complexType name="RAS_O17.TIMING_ENCODED.CONTENT"> <xsd:sequence> <xsd:element ref="TQ1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="TQ2" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RAS_O17.TIMING_ENCODED" type="RAS_O17.TIMING_ENCODED.CONTENT" /> <xsd:complexType name="RAS_O17.ADMINISTRATION.CONTENT"> <xsd:sequence> <xsd:element ref="RXA" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RXR" minOccurs="1" maxOccurs="1" /> <xsd:element ref="RAS_O17.OBSERVATION" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RAS_O17.ADMINISTRATION" type="RAS_O17.ADMINISTRATION.CONTENT" /> <xsd:complexType name="RAS_O17.OBSERVATION.CONTENT"> <xsd:sequence> <xsd:element ref="OBX" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RAS_O17.OBSERVATION" type="RAS_O17.OBSERVATION.CONTENT" /> </xsd:schema>

Download

RRA - Pharmacy/Treatment Administration Acknowledgment Message (Event O18)

There is not supposed to be an Application Level acknowledgement to an Application Level Acknowledgement message. In Enhanced Mode, MSH-16 SHALL always be set to NE (Never).

RRA^O18^RRA_O18: Pharmacy/Treatment Administration Acknowledgment Message

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - RRA_O18

Segment	Cardinality	Must Implement	Status
RRA_O18
MSH	1..1	Yes	additional
MSA	1..1	Yes	additional
ERR	0..*		additional
SFT	0..*		additional
UAC	0..1		additional
NTE	0..*		additional
RESPONSE	0..1		additional
PATIENT	0..1		additional
PID	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
ORDER	1..*	Yes	additional
ORC	1..1	Yes	additional
PRT	0..*		additional
TIMING	0..*		additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
ADMINISTRATION	0..1		additional
RXR	1..1	Yes	additional
TREATMENT	1..*	Yes	additional
RXA	1..1	Yes	additional
PRT	0..*		additional

Original Mode Acknowledgement Choreography for RRA^O18^RRA_O18

Send Immediate Ack: ACK^O18^ACK

Enhanced Mode Acknowledgement Choreography for RRA^O18^RRA_O18

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

When the MSH-15 value of a RRA^O18^RRA_O18 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a RRA^O18^RRA_O18 message is AL or ER or SU, a message SHALL be sent as an application ack.

When the MSH-16 value of a RRA^O18^RRA_O18 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.

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

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: RRA_O18--> <!-- 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 RRA_O18 --> <!-- .. message definition RRA_O18 --> <xsd:complexType name="RRA_O18.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RRA_O18.RESPONSE" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRA_O18" type="RRA_O18.CONTENT" /> <xsd:complexType name="RRA_O18.RESPONSE.CONTENT"> <xsd:sequence> <xsd:element ref="RRA_O18.PATIENT" minOccurs="0" maxOccurs="1" /> <xsd:element ref="RRA_O18.ORDER" minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRA_O18.RESPONSE" type="RRA_O18.RESPONSE.CONTENT" /> <xsd:complexType name="RRA_O18.PATIENT.CONTENT"> <xsd:sequence> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRA_O18.PATIENT" type="RRA_O18.PATIENT.CONTENT" /> <xsd:complexType name="RRA_O18.ORDER.CONTENT"> <xsd:sequence> <xsd:element ref="ORC" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RRA_O18.TIMING" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RRA_O18.ADMINISTRATION" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRA_O18.ORDER" type="RRA_O18.ORDER.CONTENT" /> <xsd:complexType name="RRA_O18.TIMING.CONTENT"> <xsd:sequence> <xsd:element ref="TQ1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="TQ2" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRA_O18.TIMING" type="RRA_O18.TIMING.CONTENT" /> <xsd:complexType name="RRA_O18.ADMINISTRATION.CONTENT"> <xsd:sequence> <xsd:element ref="RRA_O18.TREATMENT" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXR" minOccurs="1" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRA_O18.ADMINISTRATION" type="RRA_O18.ADMINISTRATION.CONTENT" /> <xsd:complexType name="RRA_O18.TREATMENT.CONTENT"> <xsd:sequence> <xsd:element ref="RXA" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRA_O18.TREATMENT" type="RRA_O18.TREATMENT.CONTENT" /> </xsd:schema>

Download

RDE - Pharmacy/Treatment Refill Authorization Request Message (Event O25)

The RDE/RRE is used to communicate a refill authorization request originating with the pharmacy. This message replicates the standard RDE message with a different trigger event code to indicate the specific use case of a refill authorization request.

RDE^O25^RDE_O11: Pharmacy/Treatment Refill Authorization Request

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - RDE_O11

Segment	Cardinality	Must Implement	Status
RDE_O11
MSH	1..1	Yes	additional
ARV	0..*		additional
SFT	0..*		additional
UAC	0..1		additional
NTE	0..*		additional
PATIENT	0..1		additional
PID	1..1	Yes	additional
PD1	0..1		additional
PRT	0..*		additional
NTE	0..*		additional
ARV	0..*		B
GT1	0..1		additional
AL1	0..*		additional
PATIENT_VISIT	0..1		additional
PV1	1..1	Yes	additional
PV2	0..1		additional
PRT	0..*		additional
ARV	0..*		B
INSURANCE	0..*		additional
IN1	1..1	Yes	additional
IN2	0..1		additional
IN3	0..1		additional
ORDER	1..*	Yes	additional
ORC	1..1	Yes	additional
PRT	0..*		additional
RXE	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
RXR	1..*	Yes	additional
RXC	0..*		additional
CDO	0..*		additional
FT1	0..*		additional
BLG	0..1		additional
CTI	0..*		additional
TIMING	0..*		additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
ORDER_DETAIL	0..1		additional
RXO	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
RXR	1..*	Yes	additional
COMPONENT	0..*		additional
RXC	1..1	Yes	additional
NTE	0..*		additional
TIMING_ENCODED	1..*	Yes	additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
PHARMACY_TREATMENT_INFUSION_ORDER	0..*		additional
RXV	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
TIMING_ENCODED	1..*	Yes	additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
OBSERVATION	0..*		additional
OBX	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional

Original Mode Acknowledgement Choreography for RDE^O25^RDE_O11

Send Application Ack: RRE^O26^RRE_O12

Enhanced Mode Acknowledgement Choreography for RDE^O25^RDE_O11

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

When the MSH-15 value of a RDE^O25^RDE_O11 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a RDE^O25^RDE_O11 message is AL or ER or SU, a RRE^O26^RRE_O12 message SHALL be sent as an application ack.

When the MSH-16 value of a RDE^O25^RDE_O11 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.

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

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: RDE_O11--> <!-- 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 RDE_O11 --> <!-- .. message definition RDE_O11 --> <xsd:complexType name="RDE_O11.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="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RDE_O11.PATIENT" minOccurs="0" maxOccurs="1" /> <xsd:element ref="RDE_O11.ORDER" minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDE_O11" type="RDE_O11.CONTENT" /> <xsd:complexType name="RDE_O11.PATIENT.CONTENT"> <xsd:sequence> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PD1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RDE_O11.PATIENT_VISIT" minOccurs="0" maxOccurs="1" /> <xsd:element ref="RDE_O11.INSURANCE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="GT1" minOccurs="0" maxOccurs="1" /> <xsd:element ref="AL1" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDE_O11.PATIENT" type="RDE_O11.PATIENT.CONTENT" /> <xsd:complexType name="RDE_O11.PATIENT_VISIT.CONTENT"> <xsd:sequence> <xsd:element ref="PV1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PV2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDE_O11.PATIENT_VISIT" type="RDE_O11.PATIENT_VISIT.CONTENT" /> <xsd:complexType name="RDE_O11.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="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDE_O11.INSURANCE" type="RDE_O11.INSURANCE.CONTENT" /> <xsd:complexType name="RDE_O11.ORDER.CONTENT"> <xsd:sequence> <xsd:element ref="ORC" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RDE_O11.TIMING" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RDE_O11.ORDER_DETAIL" minOccurs="0" maxOccurs="1" /> <xsd:element ref="RXE" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RDE_O11.TIMING_ENCODED" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RDE_O11.PHARMACY_TREATMENT_INFUSION_ORDER" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RXR" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXC" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="CDO" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RDE_O11.OBSERVATION" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="FT1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="BLG" minOccurs="0" maxOccurs="1" /> <xsd:element ref="CTI" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDE_O11.ORDER" type="RDE_O11.ORDER.CONTENT" /> <xsd:complexType name="RDE_O11.TIMING.CONTENT"> <xsd:sequence> <xsd:element ref="TQ1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="TQ2" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDE_O11.TIMING" type="RDE_O11.TIMING.CONTENT" /> <xsd:complexType name="RDE_O11.ORDER_DETAIL.CONTENT"> <xsd:sequence> <xsd:element ref="RXO" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RXR" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RDE_O11.COMPONENT" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDE_O11.ORDER_DETAIL" type="RDE_O11.ORDER_DETAIL.CONTENT" /> <xsd:complexType name="RDE_O11.COMPONENT.CONTENT"> <xsd:sequence> <xsd:element ref="RXC" minOccurs="1" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDE_O11.COMPONENT" type="RDE_O11.COMPONENT.CONTENT" /> <xsd:complexType name="RDE_O11.TIMING_ENCODED.CONTENT"> <xsd:sequence> <xsd:element ref="TQ1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="TQ2" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDE_O11.TIMING_ENCODED" type="RDE_O11.TIMING_ENCODED.CONTENT" /> <xsd:complexType name="RDE_O11.PHARMACY_TREATMENT_INFUSION_ORDER.CONTENT"> <xsd:sequence> <xsd:element ref="RXV" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RDE_O11.TIMING_ENCODED" minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDE_O11.PHARMACY_TREATMENT_INFUSION_ORDER" type="RDE_O11.PHARMACY_TREATMENT_INFUSION_ORDER.CONTENT" /> <xsd:complexType name="RDE_O11.OBSERVATION.CONTENT"> <xsd:sequence> <xsd:element ref="OBX" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RDE_O11.OBSERVATION" type="RDE_O11.OBSERVATION.CONTENT" /> </xsd:schema>

Download

RRE - Pharmacy/Treatment Refill Authorization Request Acknowledgment (Event O26)

There is not supposed to be an Application Level acknowledgement to an Application Level Acknowledgement message. In Enhanced Mode, MSH-16 SHALL always be set to NE (Never).

RRE^O26^RRE_O12: Pharmacy/Treatment Refill Authorization Request Acknowledgment Message

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - RRE_O12

Segment	Cardinality	Must Implement	Status
RRE_O12
MSH	1..1	Yes	additional
MSA	1..1	Yes	additional
ERR	0..*		additional
SFT	0..*		additional
UAC	0..1		additional
NTE	0..*		additional
RESPONSE	0..1		additional
PATIENT	0..1		additional
PID	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
ORDER	1..*	Yes	additional
ORC	1..1	Yes	additional
PRT	0..*		additional
TIMING	0..*		additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
ENCODING	0..1		additional
RXE	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
RXR	1..*	Yes	additional
RXC	0..*		additional
TIMING_ENCODED	1..*	Yes	additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional

Original Mode Acknowledgement Choreography for RRE^O26^RRE_O12

Send Immediate Ack: ACK^O26^ACK

Enhanced Mode Acknowledgement Choreography for RRE^O26^RRE_O12

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

When the MSH-15 value of a RRE^O26^RRE_O12 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a RRE^O26^RRE_O12 message is AL or ER or SU, a message SHALL be sent as an application ack.

When the MSH-16 value of a RRE^O26^RRE_O12 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.

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

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: RRE_O12--> <!-- 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 RRE_O12 --> <!-- .. message definition RRE_O12 --> <xsd:complexType name="RRE_O12.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RRE_O12.RESPONSE" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRE_O12" type="RRE_O12.CONTENT" /> <xsd:complexType name="RRE_O12.RESPONSE.CONTENT"> <xsd:sequence> <xsd:element ref="RRE_O12.PATIENT" minOccurs="0" maxOccurs="1" /> <xsd:element ref="RRE_O12.ORDER" minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRE_O12.RESPONSE" type="RRE_O12.RESPONSE.CONTENT" /> <xsd:complexType name="RRE_O12.PATIENT.CONTENT"> <xsd:sequence> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRE_O12.PATIENT" type="RRE_O12.PATIENT.CONTENT" /> <xsd:complexType name="RRE_O12.ORDER.CONTENT"> <xsd:sequence> <xsd:element ref="ORC" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RRE_O12.TIMING" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RRE_O12.ENCODING" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRE_O12.ORDER" type="RRE_O12.ORDER.CONTENT" /> <xsd:complexType name="RRE_O12.TIMING.CONTENT"> <xsd:sequence> <xsd:element ref="TQ1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="TQ2" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRE_O12.TIMING" type="RRE_O12.TIMING.CONTENT" /> <xsd:complexType name="RRE_O12.ENCODING.CONTENT"> <xsd:sequence> <xsd:element ref="RXE" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RRE_O12.TIMING_ENCODED" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXR" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXC" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRE_O12.ENCODING" type="RRE_O12.ENCODING.CONTENT" /> <xsd:complexType name="RRE_O12.TIMING_ENCODED.CONTENT"> <xsd:sequence> <xsd:element ref="TQ1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="TQ2" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RRE_O12.TIMING_ENCODED" type="RRE_O12.TIMING_ENCODED.CONTENT" /> </xsd:schema>

Download

ROR - Pharmacy/Treatment Order Response

Attention: This query/response pair was retained for backward compatibility only as of v2.4 and withdrawn as of v2.7. Please refer to Chapter 5 for detailed coverage of query/response methodology to be employed in Versions 2.4 and later.

RAR - Pharmacy/Treatment Administration Information

Attention:This query/response pair was retained for backward compatibility only as of v2.4 and withdrawn as of v2.7. Please refer to Chapter 5 for detailed coverage of query/response methodology to be employed in Versions 2.4 and later.

RDR - Pharmacy/Treatment Dispense Information

Attention: This query/response pair was retained for backward compatibility only as of v2.4 and withdrawn as of v2.7. Please refer to Chapter 5 for detailed coverage of query/response methodology to be employed in Versions 2.4 and later.

RER - Pharmacy/Treatment Encoded Order

Attention: This query/response pair was retained for backward compatibility only as of v2.4 and withdrawn as of v2.7. Please refer to Chapter 5 for detailed coverage of query/response methodology to be employed in Versions 2.4 and later.

RGR - Pharmacy/Treatment Dose Information

Attention: This query/response pair was retained for backward compatibility only as of v2.4 and withdrawn as of v2.7. Please refer to Chapter 5 for detailed coverage of query/response methodology to be employed in Versions 2.4 and later.

Pharmacy Query/Response Message Pair

Conformance Statement

Query Statement ID (Query ID=Q31):	Q31
Type:	Query
Query Name:	Dispense History
Query Trigger (= MSH-9):	QBP^Q31^QBP_Q11
Query Mode:	Both
Response Trigger (= MSH-9):	RSP^K31^RSP_K31
Query Characteristics:	May specify patient, medication, a date range, and how the response is to be sorted.
Purpose:	To retrieve patient pharmacy dispense history information from the Server.
Response Characteristics:	Sorted by Medication Dispensed unless otherwise specified in SortControl.
Based on Segment Pattern:	RDS_O01

QPD Input Parameter Specification

Field Seq (Query ID=Q31)

Name

Key/ Search

Sort

LEN

TYPE

Opt

Rep

Match Op

TBL

Segment Field Name

Service Identifier Code

Element Name

1

MessageQueryName

60

CWE

R

2

QueryTag

32

ST

R

PatientList

S

Y

20

CX

O

PID.3

PID-3: Patient Identifier List

MedicationDispensed

S

Y

100

CWE

O

=

RXD.2

RXD-2: Dispense/Give Code

DispenseDate.LL

S

Y

24

DTM

O

> =

RXD.3

RXD-3: Date/Time Dispensed

DispenseDate.UL

S

Y

24

DTM

O

< =

RXD.3

RXD-3: Date/Time Dispensed

QPD Input Parameter Field Description and Commentary

Input Parameter (Query ID=Q31)	Comp. Name	DT	Description
MessageQueryName		CWE	Must be valued Q31^Dispense History^HL7nnnn.
QueryTag		ST	Unique to each query message instance.
PatientList		CX	The combination of values for PatientList.ID, and PatientList.AssigningAuthority, are intended to identify a unique entry on the PATIENT_MASTER table. The PatientList.IdentifierTypeCode is useful for further filtering or to supply uniqueness in the event that the assigning authority may have more than one coding system. (The PATIENT_MASTER table contains a constraint that prevents multiple patients from being identified by the same combination of field values.) This PATIENT_MASTER entry will be searched against on the PHARMACY_DISPENSE_TRANSACTION table to retrieve the rows fulfilling the query conditions. If this field is not valued, all values for this field are considered to be a match. If one PID.3 is specified, only 1 segment pattern will be returned.
	ID	ID	If this field, PID.3.1, is not valued, all values for this field are considered to be a match.
	Assigning Authority	HD	If this field, PID.3.4, is not valued, all values for this field are considered to be a match.
	Identifier type code	IS	If this field, PID.3.5, is not valued, all values for this field are considered to be a match.
MedicationDispensed		CWE	If this field is not valued, all values for this field are considered to be a match.
DispenseDate.LL		DTM	This is the earliest value to be returned for Date/Time Dispensed. If this field is not valued, all values for this field are considered to be a match.
DispenseDate.UL		DTM	This is the latest value to be returned for Date/Time Dispensed. If this field is not valued, all values for this field are considered to be a match.

QBP^Q31^QBP_Q11: Query Grammar: QBP Message

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - QBP_Q11

Segment	Cardinality	Must Implement	Status
QBP_Q11
MSH	1..1	Yes	additional
ARV	0..*		additional
SFT	0..*		additional
UAC	0..1		additional
QPD	1..1	Yes	additional
QBP	0..1		additional
...	0..1		additional
RCP	1..1	Yes	additional
DSC	0..1		additional

Original Mode Acknowledgement Choreography for QBP^Q31^QBP_Q11

Send Application Ack: RSP^K31^RSP_K31

Enhanced Mode Acknowledgement Choreography for QBP^Q31^QBP_Q11

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

When the MSH-15 value of a QBP^Q31^QBP_Q11 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a QBP^Q31^QBP_Q11 message is AL or ER or SU, a RSP^K31^RSP_K31 message SHALL be sent as an application ack.

When the MSH-16 value of a QBP^Q31^QBP_Q11 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.

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

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: QBP_Q11--> <!-- 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 QBP_Q11 --> <!-- .. message definition QBP_Q11 --> <xsd:complexType name="QBP_Q11.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="QPD" minOccurs="1" maxOccurs="1" /> <xsd:element ref="QBP_Q11.QBP" minOccurs="0" maxOccurs="1" /> <xsd:element ref="RCP" minOccurs="1" maxOccurs="1" /> <xsd:element ref="DSC" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="QBP_Q11" type="QBP_Q11.CONTENT" /> <xsd:complexType name="QBP_Q11.QBP.CONTENT"> <xsd:sequence> <xsd:element ref="anyHL7Segment" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="QBP_Q11.QBP" type="QBP_Q11.QBP.CONTENT" /> </xsd:schema>

Download

RSP^K31^RSP_K31: Response Grammar: Pharmacy Dispense Message

• Message Structure
• Acknowlegment Choreography
• v2.xml XSD

HL7 MessageStructure Table - RSP_K31

Segment	Cardinality	Must Implement	Status
RSP_K31
MSH	1..1	Yes	additional
MSA	1..1	Yes	additional
ERR	0..*		additional
SFT	0..*		additional
UAC	0..1		additional
QAK	1..1	Yes	additional
QPD	1..1	Yes	additional
RCP	1..1	Yes	additional
RESPONSE	1..*	Yes	additional
PATIENT	0..1		additional
PID	1..1	Yes	additional
PD1	0..1		additional
PRT	0..*		additional
NTE	0..*		additional
ARV	0..*		B
AL1	0..*		additional
PATIENT_VISIT	0..1		additional
PV1	1..1	Yes	additional
PV2	0..1		additional
PRT	0..*		additional
ARV	0..*		B
ORDER	1..*	Yes	additional
ORC	1..1	Yes	additional
PRT	0..*		additional
RXD	1..1	Yes	additional
PRT	0..*		additional
RXR	1..*	Yes	additional
RXC	0..*		additional
CDO	0..*		additional
TIMING	0..*		additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
ORDER_DETAIL	0..1		additional
RXO	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
RXR	1..*	Yes	additional
COMPONENTS	0..*		additional
RXC	1..1	Yes	additional
NTE	0..*		additional
ENCODING	0..1		additional
RXE	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
RXR	1..*	Yes	additional
RXC	0..*		additional
TIMING_ENCODED	1..*	Yes	additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
OBSERVATION	0..*		additional
OBX	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
DSC	0..1		additional

Original Mode Acknowledgement Choreography for RSP^K31^RSP_K31

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for RSP^K31^RSP_K31

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

When the MSH-15 value of a RSP^K31^RSP_K31 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a RSP^K31^RSP_K31 message is AL or ER or SU, a message SHALL be sent as an application ack.

When the MSH-16 value of a RSP^K31^RSP_K31 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.

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

<?xml version="1.0"?> <!-- v2.xml Message Definitions for Version 2.8.2 - here: RSP_K31--> <!-- 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 RSP_K31 --> <!-- .. message definition RSP_K31 --> <xsd:complexType name="RSP_K31.CONTENT"> <xsd:sequence> <xsd:element ref="MSH" minOccurs="1" maxOccurs="1" /> <xsd:element ref="MSA" minOccurs="1" maxOccurs="1" /> <xsd:element ref="ERR" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="SFT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="UAC" minOccurs="0" maxOccurs="1" /> <xsd:element ref="QAK" minOccurs="1" maxOccurs="1" /> <xsd:element ref="QPD" minOccurs="1" maxOccurs="1" /> <xsd:element ref="RCP" minOccurs="1" maxOccurs="1" /> <xsd:element ref="RSP_K31.RESPONSE" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="DSC" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RSP_K31" type="RSP_K31.CONTENT" /> <xsd:complexType name="RSP_K31.RESPONSE.CONTENT"> <xsd:sequence> <xsd:element ref="RSP_K31.PATIENT" minOccurs="0" maxOccurs="1" /> <xsd:element ref="RSP_K31.ORDER" minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RSP_K31.RESPONSE" type="RSP_K31.RESPONSE.CONTENT" /> <xsd:complexType name="RSP_K31.PATIENT.CONTENT"> <xsd:sequence> <xsd:element ref="PID" minOccurs="1" maxOccurs="1" /> <xsd:element ref="RSP_K31.ADDITIONAL_DEMOGRAPHICS" minOccurs="0" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="AL1" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RSP_K31.PATIENT_VISIT" minOccurs="0" maxOccurs="1" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RSP_K31.PATIENT" type="RSP_K31.PATIENT.CONTENT" /> <xsd:complexType name="RSP_K31.ADDITIONAL_DEMOGRAPHICS.CONTENT"> <xsd:sequence> <xsd:element ref="PD1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RSP_K31.ADDITIONAL_DEMOGRAPHICS" type="RSP_K31.ADDITIONAL_DEMOGRAPHICS.CONTENT" /> <xsd:complexType name="RSP_K31.PATIENT_VISIT.CONTENT"> <xsd:sequence> <xsd:element ref="PV1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PV2" minOccurs="0" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="ARV" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RSP_K31.PATIENT_VISIT" type="RSP_K31.PATIENT_VISIT.CONTENT" /> <xsd:complexType name="RSP_K31.ORDER.CONTENT"> <xsd:sequence> <xsd:element ref="ORC" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RSP_K31.TIMING" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RSP_K31.ORDER_DETAIL" minOccurs="0" maxOccurs="1" /> <xsd:element ref="RSP_K31.ENCODING" minOccurs="0" maxOccurs="1" /> <xsd:element ref="RXD" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RXR" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXC" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="CDO" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RSP_K31.OBSERVATION" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RSP_K31.ORDER" type="RSP_K31.ORDER.CONTENT" /> <xsd:complexType name="RSP_K31.TIMING.CONTENT"> <xsd:sequence> <xsd:element ref="TQ1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="TQ2" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RSP_K31.TIMING" type="RSP_K31.TIMING.CONTENT" /> <xsd:complexType name="RSP_K31.ORDER_DETAIL.CONTENT"> <xsd:sequence> <xsd:element ref="RXO" minOccurs="1" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RXR" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RSP_K31.COMPONENTS" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RSP_K31.ORDER_DETAIL" type="RSP_K31.ORDER_DETAIL.CONTENT" /> <xsd:complexType name="RSP_K31.COMPONENTS.CONTENT"> <xsd:sequence> <xsd:element ref="RXC" minOccurs="1" maxOccurs="1" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RSP_K31.COMPONENTS" type="RSP_K31.COMPONENTS.CONTENT" /> <xsd:complexType name="RSP_K31.ENCODING.CONTENT"> <xsd:sequence> <xsd:element ref="RXE" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="RSP_K31.TIMING_ENCODED" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXR" minOccurs="1" maxOccurs="unbounded" /> <xsd:element ref="RXC" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RSP_K31.ENCODING" type="RSP_K31.ENCODING.CONTENT" /> <xsd:complexType name="RSP_K31.TIMING_ENCODED.CONTENT"> <xsd:sequence> <xsd:element ref="TQ1" minOccurs="1" maxOccurs="1" /> <xsd:element ref="TQ2" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RSP_K31.TIMING_ENCODED" type="RSP_K31.TIMING_ENCODED.CONTENT" /> <xsd:complexType name="RSP_K31.OBSERVATION.CONTENT"> <xsd:sequence> <xsd:element ref="OBX" minOccurs="1" maxOccurs="1" /> <xsd:element ref="PRT" minOccurs="0" maxOccurs="unbounded" /> <xsd:element ref="NTE" minOccurs="0" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> <xsd:element name="RSP_K31.OBSERVATION" type="RSP_K31.OBSERVATION.CONTENT" /> </xsd:schema>

Download

Example

Example: The user wishes to know all the medications dispensed for the patient whose medical record number is "555444222111" for the period beginning 5/31/2005 and ending 5/31/2006. The following QBP message is generated.

MSH|^&~\|PCR|Gen Hosp|Pharm||200611201400-0800||QBP^Q31^QBP_Q11|ACK9901|P|2.8|

QPD|Q31^Dispense History^HL70471|Q001|555444222111^^^MPI^MR||20050531|20060531|

RCP|I|999^RD|

The pharmacy system identifies medical record number "555444222111" as belonging to Adam Everyman and locates 4 prescription dispenses for the period beginning 5/31/2005 and ending 5/31/2006 and returns the following RSP message:

MSH|^&~\|Pharm|Gen hosp|PCR||200611201400-0800||RSP^K31^RSP_K31|8858|P|2.8|

MSA|AA|ACK9901|

QAK|Q001|OK|Q31^Dispense History^HL70471|4|

QPD|Q31^Dispense History^HL70471|Q001|444-33-3333^^^MPI^MR||20050531|20060531|

PID|||444-33-3333^^^MPI^MR||Everyman^Adam||19600614|M||C|2222 Home Street ^^Anytown^US^12345||^^^^^555^5552004|

ORC|RE||89968665||||||200505121345-0700|||444-44-4444^HIPPOCRATES^HAROLD^^^^MD||^^^^^555^5551003|

RXE|1^BID^^20050529|00378112001^Verapamil Hydrochloride 120 mg TAB^NDC |120||mgm|

RXD|1|00378112001^Verapamil Hydrochloride 120 mg TAB^NDC |200505291115-0700|100|||1331665|3|

RXR|PO|

ORC|RE||89968665||||||200505291030-0700|||444-44-4444^HIPPOCRATES^HAROLD^^^^MD||^^^^^555^5551003|

RXE|1^^D100^^20070731^^^TAKE 1 TABLET DAILY --GENERIC FOR CALAN SR|00182196901^VERAPAMIL HCL ER TAB 180MG ER^NDC |100||180MG|TABLET SA|||G|||0|BC3126631^CHU^Y^L||213220929|0|0|19980821|

RXD|1|00182196901^VERAPAMIL HCL ER TAB 180MG ER^NDC |20050821|100|||213220929|0|TAKE 1 TABLET DAILY --GENERIC FOR CALAN SR|

RXR|PO|

ORC|RE||235134037||||||200509221330-0700|||444-44-4444^HIPPOCRATES^HAROLD^^^^MD||^^^^^555^5551003|

RXD|1|00172409660^BACLOFEN 10MG TABS^NDC|200509221415-0700|10|||235134037|5|AS DIRECTED|

RXR|PO|

ORC|RE||235134030||||||200510121030-0700|||222-33-4444^PUMP^PATRICK^^^^MD ||^^^^^555^5551027|

RXD|1|00054384163^THEOPHYLLINE 80MG/15ML SOLN^NDC|200510121145-0700|10|||235134030|5|AS DIRECTED|

RXR|PO|

RDE - Pharmacy/Treatment Dispense Request Message (Event O49)

This message communicates the request to dispense items. It may be sent as a consequence of an existing order. It may not follow the order immediately: The pharmacist receives clinical orders continuously, but may decide that the orders for dispense are sent periodically. This illustrates that there is a new event.

This message is also not required to contain the order in its entirety: for example if one RDE^O11 contains 3 medications order there are 3 dispensing locations, the pharmacist issues one RDE^O49 for each medication. Any supply aspects are handled through these new types of message, while the clinical order can be segregated from such supply constraints.

The order to dispense refers to the “clinical” order, the original RDE^O25 (or OMP^O09) by means of a parent-child hierarchy, where ORC-8 of the OXX message refers to the ORC-2 of the RDE^025 order.

Note:

The RXCs which follow the RXO may not be fully encoded, but those that follow the RXE must be fully encoded.

The NTE segment(s) following the PD1 segment are intended to communicate notes and comments relative to the patient.

The NTE segment(s) following the RXO segment are intended to communicate notes and comments relative to the pharmacy/treatment order.

The NTE segment(s) following the RXE segment are intended to communicate notes and comments relative to the encoded order.

The NTE segment(s) following the RXC segment are intended to communicate notes and comments relative to the component(s).

The NTE segment following the OBX segment is intended to communicate notes and comments relative to the results.

RDE^O49^RDE_O49: Pharmacy/Treatment Dispense Request Message

• Message Structure
• Acknowlegment Choreography

HL7 MessageStructure Table - RDE_O49

Segment	Cardinality	Must Implement	Status
RDE_O49
MSH	1..1	Yes	additional
SFT	0..*		additional
UAC	0..1		additional
NTE	0..*		additional
PATIENT	0..1		additional
PID	1..1	Yes	additional
PD1	0..1		additional
PRT	0..*		additional
NTE	0..*		additional
GT1	0..1		additional
AL1	0..*		additional
PATIENT_VISIT	0..1		additional
PV1	1..1	Yes	additional
PV2	0..1		additional
PRT	0..*		additional
INSURANCE	0..*		additional
IN1	1..1	Yes	additional
IN2	0..1		additional
IN3	0..1		additional
ORDER	1..*	Yes	additional
ORC	1..1	Yes	additional
PRT	0..*		additional
PRT	0..*		Deprecated
RXE	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
RXR	1..*	Yes	additional
RXC	0..*		additional
FT1	0..*		additional
BLG	0..1		additional
CTI	0..*		additional
TIMING	0..*		additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
ORDER_DETAIL	0..1		additional
RXO	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
RXR	1..*	Yes	additional
COMPONENT	0..*		additional
RXC	1..1	Yes	additional
NTE	0..*		additional
TIMING_ENCODED	1..*	Yes	additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
OBSERVATION	0..*		additional
OBX	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional

Original Mode Acknowledgement Choreography for RDE^O49^RDE_O49

Send Application Ack: RRE^O50^RRE_O50

Enhanced Mode Acknowledgement Choreography for RDE^O49^RDE_O49

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

When the MSH-15 value of a RDE^O49^RDE_O49 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a RDE^O49^RDE_O49 message is AL or ER or SU, a RRE^O50^RRE_O50 message SHALL be sent as an application ack.

When the MSH-16 value of a RDE^O49^RDE_O49 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.

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

RRE - Pharmacy/Treatment Encoded Order Acknowledgment (Event O50)

There is not supposed to be an Application Level acknowledgement to an Application Level Acknowledgement message. In Enhanced Mode, MSH-16 SHALL always be set to NE (Never).

RRE^O50^RRE_O50: Pharmacy/Treatment Encoded Order Acknowledgment Message

• Message Structure
• Acknowlegment Choreography

HL7 MessageStructure Table - RRE_O50

Segment	Cardinality	Must Implement	Status
RRE_O50
MSH	1..1	Yes	additional
MSA	1..1	Yes	additional
ERR	0..*		additional
SFT	0..*		additional
UAC	0..1		additional
NTE	0..*		additional
RESPONSE	0..1		additional
PATIENT	0..1		additional
PID	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
ORDER	1..*	Yes	additional
ORC	1..1	Yes	additional
PRT	0..*		additional
PRT	0..*		Deprecated
TIMING	0..*		additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
ENCODING	0..1		additional
RXE	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
RXR	1..*	Yes	additional
RXC	0..*		additional
TIMING_ENCODED	1..*	Yes	additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional

Original Mode Acknowledgement Choreography for RRE^O50^RRE_O50

Send Immediate Ack: ACK^O50^ACK

Enhanced Mode Acknowledgement Choreography for RRE^O50^RRE_O50

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

When the MSH-15 value of a RRE^O50^RRE_O50 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a RRE^O50^RRE_O50 message is AL or ER or SU, a message SHALL be sent as an application ack.

When the MSH-16 value of a RRE^O50^RRE_O50 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.

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

RCV - Pharmacy/Treatment Dispense Message (Event O59)

The RCV message may be created to communicate the reception of items. This message supports reception of items to fill an existing order or orders, or to stock refills. In the most common case, the RCV messages would be routed to the dispensing system that issued the RDS message. The RDS message informs of the items that have been sent, while the RCV informs about the effectively received items (thus supporting any change in quantities, status,e tc., derived from transport or from a mismatch between the actually sent items and the content of the RDS).

In typical cases, the RCV^O59 message is an “echo” of one RDS^O13, but this is not forcibly so: Since the shipment and reception are asynchronous events, and considering variants in delivery, it is expected that one RCV^OYY message is issued for each confirmation of a reception, independently of whether there was one shipment or several shipments.

The RXD segment carries the dispense data for a given reception of the received items.

The FT1 segment is optional and repeating in order to accommodate multiple charge, benefit and pricing situations. When a message of type RCV is used, the FT1 may be included in the RCV message. If the RCV^O59 message is not used by the implementation, then the RDS may contain the FT1 segment.

Note:    The NTE segment(s) following the PD1 segment are intended to communicate notes and comments relative to the patient.

The NTE segment(s) following the RXO segment are intended to communicate notes and comments relative to the pharmacy/treatment order.

The NTE segment(s) following the RXE segment are intended to communicate notes and comments relative to the encoded order.

The NTE segment(s) following the RXD segment are intended to communicate notes and comments relative to the dispense event.

The NTE segment(s) following the RXC segment are intended to communicate notes and comments relative to the component(s).

The NTE segment following the OBX segment is intended to communicate notes and comments relative to the results.

RCV^O59^RCV_O59: Pharmacy/Treatment Dispense Message

• Message Structure
• Acknowlegment Choreography

HL7 MessageStructure Table - RCV_O59

Segment	Cardinality	Must Implement	Status
RCV_O59
MSH	1..1	Yes	additional
SFT	0..*		additional
UAC	0..1		additional
NTE	0..*		additional
PATIENT	0..1		additional
PID	1..1	Yes	additional
PD1	0..1		additional
PRT	0..*		additional
NTE	0..*		additional
AL1	0..*		additional
PATIENT_VISIT	0..1		additional
PV1	1..1	Yes	additional
PV2	0..1		additional
PRT	0..*		additional
ORDER	1..*	Yes	additional
ORC	1..1	Yes	additional
PRT	0..*		additional
RXD	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
RXR	1..*	Yes	additional
RXC	0..*		additional
FT1	0..*		additional
TIMING	0..*		additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
ORDER_DETAIL	0..1		additional
RXO	1..1	Yes	additional
ORDER_DETAIL_SUPPLEMENT	0..1		additional
NTE	1..*	Yes	additional
RXR	1..*	Yes	additional
COMPONENT	0..*		additional
RXC	1..1	Yes	additional
NTE	0..*		additional
ENCODING	0..1		additional
RXE	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional
RXR	1..*	Yes	additional
RXC	0..*		additional
TIMING_ENCODED	1..*	Yes	additional
TQ1	1..1	Yes	additional
TQ2	0..*		additional
OBSERVATION	0..*		additional
OBX	1..1	Yes	additional
PRT	0..*		additional
NTE	0..*		additional

Original Mode Acknowledgement Choreography for RCV^O59^RCV_O59

Send Application Ack: RRD^O14^RRD_O14

Enhanced Mode Acknowledgement Choreography for RCV^O59^RCV_O59

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

When the MSH-15 value of a RCV^O59^RCV_O59 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a RCV^O59^RCV_O59 message is AL or ER or SU, a RRD^O14^RRD_O14 message SHALL be sent as an application ack.

When the MSH-16 value of a RCV^O59^RCV_O59 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.

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