Incoming Procedural Supply Usage Interface Technical Specification

Incoming Procedural Supply
Usage Interface Technical

Specification
Version: August 2023
Last Updated: August 04, 2023
For additional interface technical specifications, or the most current version of this document, visit https://open.epic.com.
Do not distribute this document.
To access the table of contents, use the bookmarks feature within your PDF reader.
Technical Specification Introduction
Shared Content:
This content is available to download from open.epic. Vendors can get the most up-to-date information by
downloading the technical specification from https://open.epic.com.
This technical specification documents the subset of an industry messaging standard that an Epic interface supports in
the released software version. It might not support the entire standard specification, depending on functional needs.
Message Specifications
The interface is used to update supply usage information in procedural logs.
DFT^P03 Supply Financial Transaction
This message event is sent from an external system where supply usage is being documented (such as a cabinet
dispensing system) to update supply usage documentation in the procedural case. These messages are not treated as
charges and do not update Resolute directly. Charges can be dropped within the application based on the supply
usage documented in the procedural log.
Message Format for Event Type DFT^P03
DFT^P03 Supply Financial Transaction Chapter
MSH Message Header 2
PID Patient Identification 3
[PV1] Visit Identification 3
FT1 Financial Transaction 6
[ZPA] Additional Supply/Implant Usage Information
[NTE] Notes and Comments 2
ACK General Acknowledgment Chapter
MSH Message Header 2

ACK General Acknowledgment Chapter
MSA Message Acknowledgment 2
[ERR] Error Information 2
Notes on Format of DFT^P03

The ZPA segment is an optional Z-segment that contains information about the inventory location from which the
supply was taken. If the interface is being used to file implant information, the ZPA segment contains information
related to the implant.
Sample Messages
DFT^P03 Supply Financial Transaction
Format Example
MSH|^~\&|SUPPLYSYSTEM|EMH|EPIC|EMH|20090127075803||DFT^P03|0000000006|P|2.5|||||||
PID|||E660^^^^EPI||JOHNSON^JOAN||19670314|F||||||||||11138475|
444-33-2424|||||||||||||||||||
PV1|||||||||||||||||||4983324||||||||||||||||||||||||||||||||
FT1|1|||20090409104611||V|SUT3^MODEL SUT VICRYL 3-0 CT1 J046|||4||||||||||TUAN^Tuan|||
145|||||||
ZPA|||ORSR|||||||||||||||
FT1|2|||20090409104611||V|DRAPE35X23^MODEL DRAPE IOBAN 35X23|||2||||||||||TUAN^Tuan|||
145||||||
ZPA|||ORSR|||||||||||||||
FT1|3|||20090409104611||V|GLOVES^MODEL GLOVE SURG INDICATOR 8-1/2 PF|||2||||||||||
TUAN^Tuan|||145|||||
ZPA|||ORSR|||||||||||||||
FT1|4|||20090409104611||V|SPONGE^MODEL SPONGE,MIRASORB 4X4 4 PLY|||3||||||||||TUAN^Tuan|||
145||||||
ZPA|||ORSR|||||||||||||||
FT1|5|||20090409104611||R|GOWN^MODEL GOWN,SURGICAL LARGE|||1||||||||||TUAN^Tuan|||145||||||
ZPA|||ORSR|||||||||||||||
FT1|6|||20090409104611||W|DRESSING^MODEL DRESSING STERISTRIP 4-4|||2||||||||||TUAN^Tuan|||
145||||||
ZPA|||ORSR|||||||||||||||
NTE|||Dropped on floor||
suggestion
Supported Segments and Fields
Fields in gray are not supported by this interface.
Message Types: IN - DFT SUPPLY USAGE DATA

MSH - Message Header
Element Name Type Usage Notes
2 - Encoding ST Required Value is typically: ^~\&
Characters
3 - Sending — — Format: Free text
Application
4 - Sending Facility HD Optional Pharmacy external ID
Format: Free text
5 - Receiving HD Optional Format: Free text

Application
6 - Receiving Facility HD Optional Free text
7 - Date/Time of DTM Optional Format: Standard HL7 date/time format

Message
8 - Security ST Optional —
9 - Message Type MSG Required Format: <Message type>^<Trigger event>
Example: ORM^O01
10 - Message Control ST Optional Value to be returned in MSA-2 in the Acknowledgment message

ID
11 - Processing ID PT Required Values:
• D: Debugging
• P: Production
• T: Training
12 - Version ID VID Required HL7 version number. For example, 2.5.
13 - Sequence NM Optional Optional field used in sequence number protocol. By default, Epic does
Number not use sequence number protocol.
14 - Continuation ST Optional In conjunction with the HL7 DSC segment, this field is used to identify
Pointer continuations of messages. It allows large messages to be broken into
multiple smaller messages, which is necessary under certain
implementation limitations.
MSH-14 contains the identifier matching the value sent in the DSC
segment in a previous message, identifying the current message as a
continuation of the previous.
15 - Accept ID Optional This field identifies the conditions under which Accept Acknowledgments
Acknowledgment must be returned in response to a message. This field is required for
Type enhanced acknowledgment mode. If null, acknowledgments are sent in
original acknowledgment mode.
Values:
• AL: Always
• ER: Error/reject conditions only
• NE: Never
• SU: Successful completion only
16 - Application ID Optional —
Acknowledgment
Type
17 - Country Code ID Optional —
18 - Character Set ID Optional —
19 - Not Supported — — —
21 - Message Profile — — —
Id
22 - Sending XON Optional —
Responsible
Organization
23 - Receiving XON Optional —
Responsible
Organization
PID - Patient Identification

Segment-Level Summary

2 - Patient ID — — —
3 - Patient Identifier CX Required Format: <ID>^^^<SA>^<Assigning Authority>
List
4 - Alternate Patient CX Optional —
ID
5 - Patient Name XPN Required Used for validation purposes only.
7 - Date/Time of Birth DTM Optional Used for validation purposes only.
8 - Sex IS Optional Used for validation purposes only.
11 - Patient Address XAD Optional Format: <Street 1>^<Street 2/House Number>^<City>^<State>^<ZIP
code>^<Country>^<Address Type>^^<County>^^^^<Start
Date>^<End Date>
or
&<Street 1>&<House Number>^<Street 2>^<City>^<State>^<ZIP
code>^<Country>^<Address Type>^^<County>^<District>^^^<Start
Date>^<End Date>
13 - Phone Number – XTN Optional Format: [nnn](nnn)nnn-nnnn^<Telecommunication use
Home code>^<Telecommunication equipment type>^<E-mail
address>^<Country code>^<Area/city code>^<Local
number>^<Extension>^<Any text>^<Extension prefix>^<Speed
dial code>^<Unformatted telephone number>
18 - Patient Account CX Optional This is the visit number that is used to locate an encounter. The value is
Number not stored.
19 - Patient ST Optional Used for validation purposes only.

Identification
Format: Numeric with or without dashes
National Identifier –
Patient Note: The national identifier can also be received in PID-3.
PV1 - Patient Visit


19 - Visit Number CX Optional This is the visit number that is used to locate the encounter. The value is
not stored.
FT1 - Supply Financial Transaction


4 - Transaction Date DTM Required —
6 - Transaction Type IS Required Value indicating the usage action for this supply. External values should
indicate one of the supply actions below.
• Used
• Returned
• Wasted
• Wasted - Not Used
7 - Transaction Code CWE Required The identifier for the supply whose usage documentation is being
updated.
10 - Transaction NM Optional The quantity used, returned, or wasted
Quantity
20 - Performed By XCN Optional The provider who used the supply
Code
23 - Filler Order EI Optional The identifier of the pick list for which usage should be updated
Number
ZPA - Additional Supply Usage Information


3 - Inventory CWE Optional The inventory location from which the supply or implant was pulled.
Location
21 - Lot Number ST Optional Lot number of supply. Used when supply identifier from materials
management system is not available.
22 - Serial Number ST Optional Serial number of supply. Used when supply identifier from materials
management system is not available.
23 - Expiration Date DTM Optional Supply's expiration date.
24 - Is Tissue CWE Optional Values correspond to Y or N to indicate whether this implant is a tissue
25 - External Implant EI Optional Implant documentation system's identifier for the implant. Required if
ID filing information from the Implant Action field (ZPA-39).
Format: <Implant ID>^<Assigning Authority>
26 - Supplier Catalog ST Optional Vendor's catalog number for the implant

Number
27 - Manufacturer ST Optional Manufacturer's catalog number for the implant or supply
Catalog Number
28 - Supplier ST Optional Vendor identifier
29 - Manufacturer ST Optional Manufacturer identifier
30 - Implant Type CWE Optional Type of implant
31 - Is Implant CWE Optional This field is used only if the interface is creating a new supply (SUP) record
or if your system treats a one-time SUP record as an implant.
Value corresponds to Y or N to indicate whether the external system is
sending information about an implant. Required to file implant
information. If not set, information is treated as supply usage.
32 - Item Description ST Optional Description of implant. Also stored as implant title in IMP.
33 - Implanted By ST Optional Provider that documented the implant in the external system. Typically
this is the surgeon performing the procedure.
Format: <ID>^^^^^^^^<Assigning authority>^^^^<ID type>
34 - Body Side CWE Optional Body laterality
35 - Body Site CWE Optional Location of implant in body
36 - Tissue ST Optional Free-text tissue preparation comments

Preparation
37 - Instant DTM Optional Instant of implantation or instant explanted.
Implanted
38 - Size ST Optional Size of implant
39 - Implant Action CWE Optional Implant action (e.g. Implanted / Explanted). The External Implant ID field
(ZPA-25) is required to file information in this field.
40 - Reason Wasted ST Optional The reason a supply or implant was wasted in your external system. The
interface supports receiving only one reason wasted per supply or
implant.
Format: <reason>
41 - Implant Model — — —
Number
42 - Supply Item Type — — —
43 - Device Identifier — Optional The unique identifier for the device.
44 - Device Identifier — Optional —

Type
45 - SMDA? CWE Optional —
46 - Implant DT Optional —
Manufacture Date
47 - Implant Date DT Optional —
Received
48 - Implant Prepped CWE Optional The providers the implant was prepared by. Only the first three pieces of
By this field are used for each repetition.
NTE - Notes and Comments


3 - Comment FT Optional Comment about supply usage
ZTS - Tissue Segment

1 - Tissue Preparation CWE Optional —
Action
2 - Tissue Type CWE Optional —
3 - Tissue Prep Start DTM Optional —
4 - Tissue Prep End DTM Optional —
5 - Tissue Prep Staff CWE Optional Staff associated with tissue preparation where only the first three pieces
are used.
6 - Tissue NM Optional —
Temperature at
Implantation
7 - Tissue Present CWE Optional —
with Ice
8 - Tissue Time of DTM Optional —
Acceptance
9 - Tissue Received CWE Optional —
By
10 - Tissue Storage NM Optional —
Temperature
11 - Tissue Storage DTM Optional —
End Time
12 - Tissue Donor ID ST Optional —
13 - Tissue CWE Optional —
Autologous
14 - Tissue Package CWE Optional —
Storage Environment
15 - Tissue Package CWE Optional —
Storage Location
16 - Tissue Inspection CWE Optional —
Result
17 - Tissue Bank CWE Optional —
18 - Tissue Distinct ST Optional —
Identification Code
19 - Tissue DIC Flag ST Optional —
Characters
20 - Tissue Tracking ST Optional —
Barcode ID
21 - Tissue ST Optional —
Preparation
Instructions
22 - Skin Substitute? CWE Optional —
23 - Skin Substitute CWE Optional —
Usage
24 - Skin Substitute NM Optional —
Area Used
Area Wasted
Total Area
ZPS - Prep Solution Segment


1 - Tissue Prep CWE Optional —
Solution
2 - Tissue Prep ST Optional —
Solution Lot #
3 - Tissue Prep DT Optional —
Solution Expiration
Date
4 - Tissue Prep NM Optional —
Solution Soaking
Duration
Solution
Manufacturer
Solution Serial #
Solution Modifier
8 - Tissue Prep TM Optional —
Solution Start Time
9 - Tissue Prep TM Optional —
Solution End Time
10 - Tissue Prep NM Optional —
Solution Rinse
Duration
Solution Comments
© 2023 Epic Systems Corporation. All rights reserved. PROPRIETARY INFORMATION - This item and its contents may not
be accessed, used, modified, reproduced, performed, displayed, distributed or disclosed unless and only to the extent
expressly authorized by an agreement with Epic. This item is a Commercial Item, as that term is defined at 48 C.F.R. Sec.
2.101. It contains trade secrets and commercial information that are confidential, privileged and exempt from disclosure
under the Freedom of Information Act and prohibited from disclosure under the Trade Secrets Act. After Visit Summary,
Analyst, App Orchard, ASAP, Beacon, Beaker, BedTime, Bones, Break-the-Glass, Caboodle, Cadence, Canto, Care
Everywhere, Charge Router, Chronicles, Clarity, Cogito ergo sum, Cohort, Colleague, Community Connect, Cupid, Epic,
EpicCare, EpicCare Link, Epicenter, Epic Earth, EpicLink, EpicWeb, Garden Plot, Good Better Best, Grand Central, Haiku,
Happy Together, Healthy Planet, Hyperspace, Kaleidoscope, Kit, Limerick, Lucy, Lumens, MyChart, OpTime, OutReach,
Patients Like Mine, Phoenix, Powered by Epic, Prelude, Radar, Radiant, Resolute, Revenue Guardian, Rover, Share
Everywhere, SmartForms, Sonnet, Stork, System Pulse, Tapestry, Trove, Welcome, Willow, Wisdom, and With the Patient at
Heart are registered trademarks, trademarks, or service marks of Epic Systems Corporation in the United States of America
and/or other countries. Other company, product, and service names referenced herein may be trademarks or service marks
of their respective owners. Patents Notice: www.epic.com/patents.

Incoming Procedural Supply Usage Interface Technical Specification

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Incoming Procedural Supply Usage Interface Technical Specification

Uploaded by

Copyright:

Available Formats

Incoming Procedural Supply

Usage Interface Technical

Last Updated: August 04, 2023

MSH Message Header 2

PID Patient Identification 3

[PV1] Visit Identification 3

FT1 Financial Transaction 6

[ZPA] Additional Supply/Implant Usage Information

[NTE] Notes and Comments 2

ACK General Acknowledgment Chapter

MSH Message Header 2

MSA Message Acknowledgment 2

[ERR] Error Information 2

Notes on Format of DFT^P03

Message Types: IN - DFT SUPPLY USAGE DATA

5 - Receiving HD Optional Format: Free text

7 - Date/Time of DTM Optional Format: Standard HL7 date/time format

10 - Message Control ST Optional Value to be returned in MSA-2 in the Acknowledgment message

12 - Version ID VID Required HL7 version number. For example, 2.5.

PID - Patient Identification

Element Name Type Usage Notes

8 - Sex IS Optional Used for validation purposes only.

19 - Patient ST Optional Used for validation purposes only.

PV1 - Patient Visit

Element Name Type Usage Notes

FT1 - Supply Financial Transaction

Element Name Type Usage Notes

ZPA - Additional Supply Usage Information

Element Name Type Usage Notes

23 - Expiration Date DTM Optional Supply's expiration date.

26 - Supplier Catalog ST Optional Vendor's catalog number for the implant

29 - Manufacturer ST Optional Manufacturer identifier

30 - Implant Type CWE Optional Type of implant

34 - Body Side CWE Optional Body laterality

35 - Body Site CWE Optional Location of implant in body

36 - Tissue ST Optional Free-text tissue preparation comments

44 - Device Identifier — Optional —

NTE - Notes and Comments

Element Name Type Usage Notes

ZTS - Tissue Segment

ZPS - Prep Solution Segment

Element Name Type Usage Notes

You might also like