Canonical Guide
Prescription Monitoring Program (PMP) Medication History
______________________________________________
Revised: 07/17/2014
Version 1.0
Document Name
OHP-HIE Canonical Guide –PMP Medication History
Table of Contents
1. DOCUMENT CHANGE HISTORY ........................................................................................................................... 3
2. INTRODUCTION........................................................................................................................................................ 3
3. PROCESS FLOW......................................................................................................................................................... 6
4. FILE NAMING CONVENTIONS ............................................................................................................................... 9
5. TRANSACTION STRUCTURE ................................................................................................................................. 9
6. TRANSACTION SAMPLES ..................................................................................................................................... 29
7. ACKNOWLEDGEMENT AND ERROR HANDLING PROCESSES................................................................... 33
Last Updated: 07/17/2014 version 1.0
Page - 2 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
1. DOCUMENT CHANGE HISTORY
Version
0.01
0.02
0.03
Issue Date
07/12/2013
07/18/2013
07/26/2013
0.04
08/30/2013
0.05
09/12/2013
0.06
9/23/2013
1.0
7/17/14
DOCUMENT NAME: Canonical Guide Modified By
Comments/Reason
Sue Merk
First draft of PMP Medication History
Tony Shaver
Xml samples and descriptions
Tony Shaver,
Updated transaction structure, inserted
Rhonda May
business logic diagram and steps for hub
transformation, edited document format.
Rhonda May
 Add Error Handling information
 Separate PMIX SOAP from NCPDP
transaction in transaction structure table
 Make corrections and update information
in transaction table
 Update business logic diagram
 Added assumptions section
 Inserted actual transaction samples from
testing scenarios
 Inserted sample of ResMPE error xml
Rhonda May
Inserted textual edits requested by Chris
Baumgartner at DOH
Rhonda May
Edited document process diagrams and
removed reference to “synchronous”
transaction
Rhonda May, Kelly  Updated medication history response
Smith, Sue Merk
transaction structure and sample file
 Updated overview section
 Added section on transaction security
2. INTRODUCTION
2.1. Overview
The Washington State Department of Health (DOH) operates a clinical data repository of dispensed
medications, known as the Prescription Monitoring Program or PMP. That repository represents a
medication history of controlled substance (Schedule II - V) prescriptions filled in licensed pharmacies
or dispensed from licensed practitioners under Washington State law. Access to that data is provided
via the Health Information Exchange (HIE) to licensed practitioners with a valid, current registration in
the online Washington State PMP system, making a secure query from a health information system
connected to the HIE.
The response provided from the PMP database via the HIE is a real-time transaction based on the
authentication of the requestor’s license in the Washington State online PMP system and a match of
the patient record requested. The request and response utilize the NCPDP Script standard for
medication history. All transactions brokered by the OHP HIE will utilize the SCRIPT Standard
Implementation Guide v2Ø13Ø12. The DOH vendor for the PMP repository may broker queries to the
Last Updated: 07/17/2014 version 1.0
Page - 3 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
national exchange or other state PMP vendors using the NIEM protocol. All transactions traded
through the OHP HIE will be translated by the DOH vendor to NCPDP standards.
The OHP HIE will wrap all messages in the NIEM standard wrapper before submitting them to the DOH
vendor. Responses from the DOH vendor will have the NIEM wrapper removed before sending the
standard NCPDP transaction response to the requesting party. All wrapper handling is done
programmatically by the HIE engine using metadata from the NCPDP transaction submitted by the
requester.
The S&I Framework PDMP & Health IT Integration workgroup is currently accepting comments and
input on the national standard for interoperability for the PDMP transaction. The NCPDP RxHistory is
one of several standards that has been discussed and is being considered. Once the S&I Framework
workgroup establishes a final standard, this transaction may be adjusted to comply with the standard
and potentially offered as a web service for consumption directly from a standards-compliant
requesting system. In the event the transaction changes, this document will be updated to reflect the
changes, a copy posted to the OHP HIE website and shared with all current trading partners interested
in the Prescription Monitoring Program transaction.
2.2. Scope
This canonical guide defines the query/response transactions for Medication History to/from the
Washington State Department of Health Prescription Monitoring Program (PMP) repository. The initial
scope of this transaction is for licensed healthcare providers authorized by statute, accessing patient
medication history from the Washington State DOH PMP repository only. Transformation services are
available for individual organizations needing translation or mapping based on an additional service fee
for the custom work. DOH plans to offer exchanges to other states in phase 2 of the implementation.
This guide is unique to OneHealthPort.
2.3. Terms and Acronyms
Term/Acronym
NCPDP
NIEM Protocol
PMIX
PMP
HIE
DOH
EDIE
SCRIPT
HID
Description
National Council for Prescription Drug Programs - a not-forprofit, ANSI-accredited, standards development organization
National Information Exchange Model. This is an interagency
initiative developed to provide the foundation and building blocks for
national-level interoperable information sharing and data exchange,
as a joint venture between the U.S. Department of Homeland
Security (DHS) and the U.S. Department of Justice (DOJ) with
outreach to other Government departments and agencies.
Prescription Monitoring Information Exchange Architecture –
enabling interstate exchange of PMP data
Prescription Monitoring Program
Health information exchange
Refers to the State of Washington Department of Health
Emergency Department Information Exchange
The NCPDP standard used for medication history queries and
responses
Health Information Designs, LLC
Last Updated: 07/17/2014 version 1.0
Page - 4 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
2.4. Assumptions



Requestors of medication history from the DOH PMP repository have registered in the
Washington State online PMP at http://www.wapmp.org/practitioner/pharmacist/.
Any organization planning to automate the queries can request to use the license of a Medical
Director and must contact the Department of Health PMP program director for education and
information about the responsibilities for that practitioner, before implementation.
All transactions between the HIE and requesting systems will utilize the Activator or an approved
AS2 connection for the secure transport of the transaction.
Last Updated: 07/17/2014 version 1.0
Page - 5 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
3. PROCESS FLOW
3.1. High Level Process – query from Trading Partner via HIE
Last Updated: 07/17/2014 version 1.0
Page - 6 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
3.2. High Level Process – Query from Trading Partner via aggregator (example: EDIE)
3.3. Business Logic for Message Handling
Last Updated: 07/17/2014 version 1.0
Page - 7 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
The numbered steps below correspond to the numbers shown in the diagram above.
1. A request for information from the PMP is initiated by a licensed requestor sending an NCPDP
SCRIPT:RxHistoryRequest message wrapped in an NCPDP transport request envelope to the
OneHealthPort HIE.
2. The HIE extracts routing information from the transport request envelope, creates a new PMIX
SOAP envelope with that routing information, then wraps the original NCPDP
SCRIPT:RxHistoryRequest message plus transport wrapper with the new PMIX SOAP request
envelope.
3. The HIE sends that encapsulated message to the PMP.
4. The PMP responds to the HIE with an NCPDP SCRIPT:RxHistoryResponse message with response
transport wrapped in a PMIX SOAP response envelope.
5. The HIE removes the PMIX SOAP response envelope, then routes the response based on the
transport layer including both the transport layer and the SCRIPT:RxHistoryResponse.
6. The HIE sends that message back to the requestor.
3.4. Message Handling Visual Aid
The OHP HIE is an intermediary between requesting practices, hospitals, pharmacies or other licensed
healthcare professionals requesting a patient medication history from the clinical repository. The
Washington State Prescription Monitoring Program (PMP) is hosted by the Department of Health’s
contracted vendor HID. HID houses all data and authenticates all requests by checking to see if the
license of the requestor is associated with an active account.
Last Updated: 07/17/2014 version 1.0
Page - 8 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
Source: NCPDP Script Standard: Flow for a RxHistoryRequest with a Status or Error response through an
intermediary. (Simplified version)
4. FILE NAMING CONVENTIONS
4.1. Special Naming Convention
There are no special or unique file naming conventions associated with the medication history
request that are required for appropriate message handling.
Whatever naming convention is used by the request submitter will be seen in the response, preceded
by “PMP”.
5. TRANSACTION STRUCTURE
5.1. XML Transaction Structure
The NCPDP SCRIPT standard version 2031.012 is the initial required format. The requestor will supply
the NCPDP Transport wrapper according to standard as well as the populated query. The response will
be formatted to reflect the NCPDP transport wrapper and standard response format.
Last Updated: 07/17/2014 version 1.0
Page - 9 -
5.1.1. Transaction Representation
5.1.1.1. In the table below, the NCPDP Script Medication History Request and Response are represented, including the transport
header and body.
Data element
Description/Business Logic
Req = R
Opt = O
Cond = C
XML element
Data Type
Field
Size
NCPDP
Request
Transport
Layer
XML
declaration
XML
declaration
n/a
XML element
n/a
Standard XML declaration.
R
R
Header
Wrapper for the entire
message. Includes XML
namespace declarations.
Wrapper for the transport
header.
<?xml version="1.0" encoding="UTF-8"?>
<transport:MessageStructuresVersion="String"
ECLVersion="String" DatatypesVersion="String"
TransactionDomain="SCRIPT" TransactionVersion="String"
TransportVersion="String"
xsi:schemaLocation="http://www.ncpdp.org/schema/Tran
sport transport.xsd"
xmlns:transport="http://www.ncpdp.org/schema/Transpo
rt"
xmlns:datatypes="http://www.ncpdp.org/schema/datatyp
es"
xmlns:SCRIPT="http://www.ncpdp.org/schema/SCRIPT"
xmlns:structures="http://www.ncpdp.org/schema/structu
res" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">
R
<transport:Header></transport:Header>
XML element
n/a
To
Indicates the intended
message recipient. Must be:
WA-OHP Must contain a
Qualifier attribute:
ZZZ - Mutually defined
R
<transport:To Qualifier="ZZZ">
WA-OHP
</transport:To>
Text
64
Message
Document Name
OHP-HIE Canonical Guide –PMP Medication History
Data element
From
Message ID
Sent time
Security
Username
Password
Sender
Secondary
identification
Description/Business Logic
Indicates the sender of the
message. Use the HIE routing
ID assigned by OHP for
response to be routed back
to requesting HIE member
organization, for example:
7uycso00.Must contain a
Qualifier attribute:
ZZZ - Mutually defined
A unique reference identifier
for the transmission,
generated from the sender of
the request and the sender of
the response. Echoed back in
the response.
The time and date of the
transmission. In the format
CCYY-MM-DDThh:mm:ss.
Wrapper for security
information. Not used by
OHP.
User name. Not used by OHP.
Password digest. Must
contain the attribute
Type="PasswordDigest". Not
used by OHP.
Wrapper for sender
secondary identification.
Used as a secondary
identification of the recipient.
Must be a valid WA State
DOH license number, and
preregistered in the WA
State PMP program e.g.
PH00012345.
Last Updated: 07/17/2014 version 1.0
Req = R
Opt = O
Cond = C
R
XML element
<transport:From Qualifier="ZZZ">
7uycso00
</transport:From>
Data Type
Field
Size
Text
64
Text
35
DateTime
19
XML element
Text
n/a
35
R
<transport:MessageID>aa7d79f98a1a4fc0bbbca33ad24cf3
70</transport:MessageID>
<transport:SentTime>
2013-07-23T12:15:37
</transport:SentTime>
R
O
<transport:Security></transport:Security>
<transport:Username></transport:Username>
O
<transport:Password
Type="PasswordDigest"></transport:Password>
R
<transport:Sender></transport:Sender>
XML element
n/a
R
<transport:SecondaryIdentification>
PH00012345
</transport:SecondaryIdentification>
Text
35
R
35
Page - 11 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
Data element
Sender
software
Sender
software
developer
Sender
software
product
Sender
software
version
release
Description/Business Logic
Wraps sender software
information.
The text field that identifies
the entity responsible for the
software that generated the
transaction. The developer
may be a software vendor or,
if the software was
developed “in-house”, the
developer is the entity
actually sending the
transaction (e.g., a chain).
The value transmitted is
determined by the Sender
Software Developer. This is a
required non-blank field in
NCPDP specification. NA is
acceptable.
The text field that identifies
the software developer’s
product, as determined by
the software developer. This
is a required non-blank field
in NCPDP specification. NA
is acceptable.
The text field that identifies
the version and release of the
software product, as
determined by the software
developer. This is not to be
used to block transactions.
This is a required non-blank
field in NCPDP specification.
NA is acceptable.
Last Updated: 07/17/2014 version 1.0
Req = R
Opt = O
Cond = C
XML element
Data Type
Field
Size
R
<transport:SenderSoftware></transport:SenderSoftware>
XML element
n/a
R
<transport:SenderSoftwareDeveloper></transport:Sender
SoftwareDeveloper>
Text
35
R
<transport:SenderSoftwareProduct></transport:SenderSof
twareProduct>
Text
35
R
<transport:SenderSoftwareVersionRelease></transport:Se
nderSoftwareVersionRelease>
Text
50
Page - 12 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
Data element
Description/Business Logic
Req = R
Opt = O
Cond = C
XML element
Data Type
Field
Size
NCPDP
Request
Body
Benefits
coordination
Wraps consent information
Y - Patient gave consent for
prescriber to receive the
medication history from any
prescriber.
N - Patient consent not given.
P - Patient gave consent for
prescriber to only receive the
medication history this
prescriber prescribed.
X - Parental/Guardian
consent on behalf of a minor
for prescriber to receive the
medication history from any
prescriber.
Z - Parental/Guardian
consent on behalf of a minor
for prescriber to only receive
the medication history this
prescriber prescribed.
R
<SCRIPT:BenefitsCoordination></SCRIPT:BenefitsCoordina
tion>
R
<structures:Consent></structures:Consent>
Text
3
Wraps patient information
R
<SCRIPT:Patient></SCRIPT:Patient>
XML element
n/a
R
<structures:Identification></structures:Identification>
XML element
n/a
Social security
number
Wraps patient identification
Patient social security
number NOTE: If SSN is not
known, remove Patient
Identification and SSN xml
tags from request xml file.
O
<datatypes:SocialSecurity></datatypes:SocialSecurity>
Number
35
Patient name
Last name
Wraps patient name
Patient last name
R
R
<structures:Name></structures:Name>
<datatypes:LastName></datatypes:LastName>
XML element
Text
n/a
35
Consent
Patient
section
Patient
identification
Last Updated: 07/17/2014 version 1.0
XML element
n/a
Page - 13 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
Data element
Description/Business Logic
Req = R
Opt = O
Cond = C
XML element
Data Type
Field
Size
First name
Gender
Patient first name
Patient gender
R
R
<datatypes:FirstName></datatypes:FirstName>
<structures:Gender></structures:Gender>
Text
Text
35
1
Date of birth
Wraps patient date of birth
Patient date of birth, without
time. Format=CCYY-MM-DD
(CC=Century YY=Year
MM=Month DD=Day)
Wraps patient address
R
<structures:DateOfBirth></structures:DateOfBirth>
XML element
n/a
R
R
<datatypes:Date></datatypes:Date>
<structures:Address></structures:Address>
Date without
time
XML element
10
n/a
R
<datatypes:AddressLine1></datatypes:AddressLine1>
Text
40
C
R
R
<datatypes:AddressLine2></datatypes:AddressLine2>
<datatypes:City></datatypes:City>
<datatypes:State></datatypes:State>
Text
Text
Text
40
35
2
R
<datatypes:ZipCode></datatypes:ZipCode>
Text
9
Request date
Start date
End date
First line of patient's address
Second line of patient's
address. Use only if address
line 1 exists.
City of patient address
State of patient address
Zip code of patient address. 5
or 9 digits
Wraps date range to include
in the PMP request
Wraps start date
Wraps end date
R
R
R
<SCRIPT:RequestedDates></SCRIPT:RequestedDates>
<datatypes:StartDate></datatypes:StartDate>
<datatypes:EndDate></datatypes:EndDate>
XML element
XML element
XML element
n/a
n/a
n/a
XML
declaration
Standard XML declaration.
R
<?xml version="1.0" encoding="UTF-8"?>
XML
declaration
n/a
Date
Address
Address line 1
Address line 2
City
State
Zip code
NCPDP
Response
Transport
Layer
Last Updated: 07/17/2014 version 1.0
Page - 14 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
Data element
Description/Business Logic
Header
Wrapper for the entire
message. Includes XML
namespace declarations.
Wrapper for the transport
header.
To
Indicates the intended
message recipient. Must be:
WA-OHP Must contain a
Qualifier attribute:
ZZZ - Mutually defined
Message
From
Message ID
Req = R
Opt = O
Cond = C
R
XML element
n/a
R
<transport:Header></transport:Header>
XML element
n/a
R
<transport:To Qualifier="ZZZ">
WA-OHP
</transport:To>
Text
35
<transport:From Qualifier="ZZZ">
7uycso00
</transport:From>
Text
35
<transport:MessageID>
aa7d79f98a1a4fc0bbbca33ad24cf370
</transport:MessageID>
Text
35
Indicates the sender of the
message. Must be: HIE
routing ID assigned by OHP
for response to be routed
back to requesting HIE
member organization. For
example: 7uycso00. Must
contain a Qualifier attribute:
ZZZ - Mutually defined
R
A unique reference identifier
for the transmission,
generated from the sender of
the request and the sender of R
Last Updated: 07/17/2014 version 1.0
Data Type
Field
Size
XML element
<transport:MessageStructuresVersion="String"
ECLVersion="String" DatatypesVersion="String"
TransactionDomain="SCRIPT" TransactionVersion="String"
TransportVersion="String"
xsi:schemaLocation="http://www.ncpdp.org/schema/Tran
sport transport.xsd"
xmlns:transport="http://www.ncpdp.org/schema/Transpo
rt"
xmlns:datatypes="http://www.ncpdp.org/schema/datatyp
es"
xmlns:SCRIPT="http://www.ncpdp.org/schema/SCRIPT"
xmlns:structures="http://www.ncpdp.org/schema/structu
res" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">
Page - 15 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
Data element
Sent time
Security
Username
Password
Type
Create Time
Sender
Secondary
identification
Sender
software
Sender
software
developer
Description/Business Logic
the response. Echoed back in
the response.
The time and date of the
transmission. In the format
CCYY-MM-DDThh:mm:ss.
Wrapper for security
information.
User name wrapper.
Password digest. Must
contain the attribute
Type="PasswordDigest". Not
used by OHP.
The time and date created. In
the format CCYY-MMDDThh:mm:ss.
Wrapper for sender
secondary identification.
Used as a secondary
identification of the recipient.
Must be a valid WA State
DOH license number, and
preregistered in the WA
State PMP program. E.G.:
PH00012345.
Wraps sender software
information.
The text field that identifies
the entity responsible for the
software that generated the
transaction. The developer
may be a software vendor or,
if the software was
developed “in-house”, the
developer is the entity
Last Updated: 07/17/2014 version 1.0
Req = R
Opt = O
Cond = C
XML element
Data Type
Field
Size
R
<transport:SentTime>
2013-07-23T12:15:37
</transport:SentTime>
DateTime
19
R
O
<transport:Security></transport:Security>
<transport:UsernameToken></transport:UsernameToken>
XML element
Text
n/a
35
O
<transport:Password
Type="PasswordDigest"></transport:Password>
Text
35
R
<transport:Created></transport:Created>
DateTime
19
R
<transport:Sender></transport:Sender>
XML element
n/a
R
<transport:SecondaryIdentification>
PH00012345
</transport:SecondaryIdentification>
Text
35
R
<transport:SenderSoftware></transport:SenderSoftware>
XML element
n/a
R
<transport:SenderSoftwareDeveloper></transport:Sender
SoftwareDeveloper>
Text
35
Page - 16 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
Data element
Sender
software
product
Sender
software
version
release
NCPDP
Response
Body
Description/Business Logic
actually sending the
transaction (e.g., a chain).
The value transmitted is
determined by the Sender
Software Developer. This is a
required non-blank field in
NCPDP specification. NA is
acceptable.
The text field that identifies
the software developer’s
product, as determined by
the software developer. This
is a required non-blank field
in NCPDP specification. NA
is acceptable.
The text field that identifies
the version and release of the
software product, as
determined by the software
developer. This is not to be
used to block transactions.
This is a required non-blank
field in NCPDP specification.
NA is acceptable.
Response type Wraps response data
Transport
Body
Transport Rx
History
Response
Response
Approved
Wraps body of Response
Wraps body of Response
Approval/Denied
Wraps SCRIPT request status
Indicates approval and wraps
reference number. Only
Last Updated: 07/17/2014 version 1.0
Req = R
Opt = O
Cond = C
XML element
Data Type
Field
Size
R
<transport:SenderSoftwareProduct></transport:SenderSof
twareProduct>
Text
35
R
<transport:SenderSoftwareVersionRelease></transport:Se
nderSoftwareVersionRelease>
Text
50
R
<ResponseTypexmlns="http://www.pmix.gov"></Respons
eType>
XML element
n/a
R
<transport:Body></transport:Body>
R
R
<transport:RxHistoryResponse></transport:RxHistoryResp
onse
<SCRIPT:Response></SCRIPT:Response>
XML element
n/a
C
<SCRIPT:Approved></SCRIPT:Approved>
XML element
n/a
Page - 17 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
Data element
Denied
Reference
number
Benefits
coordination
Consent
Patient
section
Patient
identification
Description/Business Logic
occurs if RxHistoryRequest
was approved.
Indicates denial and wraps
reference number. Only
occurs if RxHistoryRequest
was denied.
Request reference number.
Echoed back from the
RxHistoryRequest.
Req = R
Opt = O
Cond = C
XML element
Data Type
Field
Size
C
<SCRIPT:Denied></SCRIPT:Denied>
XML element
n/a
R
Number
35
XML element
n/a
Wraps consent information
Y - Patient gave consent for
prescriber to receive the
medication history from any
prescriber.
N - Patient consent not given.
P - Patient gave consent for
prescriber to only receive the
medication history this
prescriber prescribed.
X - Parental/Guardian
consent on behalf of a minor
for prescriber to receive the
medication history from any
prescriber.
Z - Parental/Guardian
consent on behalf of a minor
for prescriber to only receive
the medication history this
prescriber prescribed.
R
<SCRIPT:ReferenceNumber></SCRIPT:ReferenceNumber>
<SCRIPT:BenefitsCoordination></SCRIPT:BenefitsCoordina
tion>
R
<structures:Consent></structures:Consent>
Text
3
Wraps patient information
R
<SCRIPT:Patient></SCRIPT:Patient>
XML element
n/a
Wraps patient identification
R
<structures:Identification></structures:Identification>
XML element
n/a
Last Updated: 07/17/2014 version 1.0
Page - 18 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
Data element
Req = R
Opt = O
Cond = C
Social security
number
C
<datatypes:SocialSecurity></datatypes:SocialSecurity>
Number
35
Patient name
Last name
Wraps patient name
Patient last name
R
R
<structures:Name></structures:Name>
<datatypes:LastName></datatypes:LastName>
XML element
Text
n/a
35
First name
Gender
Patient first name
Patient gender
R
R
<datatypes:FirstName></datatypes:FirstName>
<structures:Gender></structures:Gender>
Text
Text
35
1
Date of birth
R
<structures:DateOfBirth></structures:DateOfBirth>
XML element
n/a
Date
Wraps patient date of birth
Patient date of birth, without
time. Format=CCYY-MM-DD
(CC=Century YY=Year
MM=Month DD=Day)
R
<datatypes:Date></datatypes:Date>
Date without
time
10
Address
Wraps patient address
R
<structures:Address></structures:Address>
XML element
n/a
Address line 1
R
<datatypes:AddressLine1></datatypes:AddressLine1>
Text
40
Address line 2
First line of patient's address
Second line of patient's
address. Use only if address
line 1 exists.
C
<datatypes:AddressLine2></datatypes:AddressLine2>
Text
40
City
City of patient address
R
<datatypes:City></datatypes:City>
Text
35
State
State of patient address
R
<datatypes:State></datatypes:State>
Text
2
Last Updated: 07/17/2014 version 1.0
XML element
Data Type
Field
Size
Description/Business Logic
Patient social security
number. Will be present only
if sent with the
RxHistoryRequest. NOTE: If
SSN is not known, remove
Patient Identification and
SSN xml tags from request
xml file.
Page - 19 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
Data element
Zip Code
Medication
dispensed1
Drug
description
Drug coding
Product code
Drug code
Drug code
qualifier
Drug quantity
Quantity
value
Description/Business Logic
Req = R
Opt = O
Cond = C
XML element
Zip Code of patient address
Wraps the information for
one medication dispensed.
May occur up to 300 times.
R
Description of the drug
Wraps drug coding
information
Wraps drug coding
information
Drug code; type of code is
qualified by the drug code
qualifier. Typically an NDC
code, which is why the field
size is 10.
ND - NDC
-UP - UPC
-MF - MFG
-RX - RXNORM
-RT - National Drug File
Reference Terminology (NDFRT)
-NH - Health Related Item
(HRI)
-IR - Unique Ingredient
Identifier (UNII)
Wraps drug quantity
information
The numeric quantity of drug
prescribed.
C
<SCRIPT:MedicationDispensed></SCRIPT:MedicationDispe
nsed>
<structures:DrugDescription></structures:DrugDescription
>
C
Last Updated: 07/17/2014 version 1.0
C
Data Type
<datatypes:ZipCode></datatypes:ZipCode>
Field
Size
9
XML element
n/a
Text
105
<structures:DrugCoded></structures:DrugCoded>
XML element
n/a
C
<datatypes:ProductCode></datatypes:ProductCode>
XML element
n/a
C
<datatypes:Code></datatypes:Code>
Number
10
C
<datatypes:Qualifier></datatypes:Qualifier>
Text
2
C
<structures:Quantity></structures:Quantity>
XML element
n/a
C
<datatypes:Value></datatypes:Value>
Number
11
Page - 20 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
Data element
Req = R
Opt = O
Cond = C
Quantity unit
of measure
Days supply
Days supply
C
<structures:DaysSupply></structures:DaysSupply>
Number
3
Written date
C
<structures:WrittenDate></structures:WrittenDate>
Date without
time
10
Date
This wraps the date written
Written date of prescription
without the time.
Format=YYYY MM DD
C
<datatypes:Date></datatypes:Date>
Last fill date
This wraps the last fill date
C
<structures:LastFillDate></structures:LastFillDate>
Date without
time
10
Date
Last fill date of the
prescription without the
time. Format= YYYY MM DD
C
<datatypes:Date></datatypes:Date>
Quantity
qualifier
Last Updated: 07/17/2014 version 1.0
XML element
Data Type
Field
Size
Description/Business Logic
38 - Original Quantity
40 - Remaining Quantity
87 - Quantity Received
-QS - Quantity sufficient as
determined by the dispensing
pharmacy. Quantity to be
based on established
dispensing protocols
between the prescriber and
pharmacy/pharmacist.
CF - Compound Final
Quantity
Unit of measure code for the
given quantity value. See
http://evs.nci.nih.gov/ftp1/N
CPDP/About.html for full list
of codes. Note that the max
field size of 21 is simply the
longest entry in the NCPDP
QuantityUnitOfMeasure
Terminology list.
C
<datatypes:CodeListQualifier></datatypes:CodeListQualifi
er>
Text
3
C
<datatypes:QuantityUnitOfMeasure></datatypes:Quantity
UnitOfMeasure>
Text
35
Page - 21 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
Data element
Substitutions
Refills
#Remaining
Pharmacy2
Identification
NCPDPID
DEA Number
Description/Business Logic
0 - No Product Selection
Indicated
1 - Substitution Not Allowed
by Prescriber
2 -Substitution Allowed
3 - Substitution AllowedPharmacist Selected Product
Dispensed
4 - Substitution AllowedGeneric Drug Not in Stock
5 - Substitution AllowedBrand Drug Dispensed as a
Generic
6 - Override
7 - Substitution Not AllowedBrand Drug Mandated by Law
8 - Substitution AllowedGeneric Drug Not Available in
Marketplace
9 - Substitution Allowed By
Prescriber but Plan Requests
Brand - Patient's Plan
Requested Brand
# of refills remaining
Wraps Pharmacy Information
(may repeat 300 times
depending on # of
pharmacies).
Wraps Pharmacy
Identification Information
Pharmacy NCPDP
Identification Number
Pharmacy DEA Identification
Number
Last Updated: 07/17/2014 version 1.0
Req = R
Opt = O
Cond = C
C
XML element
R
<structures:Substitutions></structures:Substitutions>
<structures:RefillsRemaining></structures:RefillsRemainin
g>
R
<structures:Pharmacy></structures:Pharmacy>
R
<structures:Identification></structures:Identification>
R
<datatypes:NCPDPID></datatypes:NCPDPID>
R
<datatypes:DEANumber></datatypes:DEANumber>
Data Type
Number
Page - 22 -
Field
Size
3
Document Name
OHP-HIE Canonical Guide –PMP Medication History
Data element
Description/Business Logic
Req = R
Opt = O
Cond = C
XML element
NPI Number
Mutually
Defined
Business
Name
Pharmacy NPI Number
R
Pharmacy's Rx Number
R
<datatypes:NPI></datatypes:NPI>
<datatypes:MutuallyDefined></datatypes:MutuallyDefine
d>
Name of Pharmacy
R
<structures:BusinessName></structures:BusinessName>
Address
Wraps Address of Pharmacy
R
<structures:Address></structures:Address>
Address Line 1
Address of Pharmacy
Continuation of Pharmacy
Address. (Only to be used if
needed)
R
<datatypes:AddressLine1></datatypes:AddressLine1>
C
<datatypes:AddressLine2></datatypes:AddressLine2>
City of Pharmacy
State of Pharmacy. (2 letter
State
abbreviation)
Zip Code of Pharmacy. (5
Zip Code
numbers or 5 +4 numbers)
Communicatio Wraps Pharmacy Telephone
n Numbers
Numbers
Primary
Wraps Primary Telephone
Telephone
Number of Pharmacy
Primary Telephone Number
Number
of Pharmacy
Wraps Prescriber's
Information(may repeat 300
times depending on # of
Prescriber3
pharmacies).
Wraps Identification
Identification numbers of Prescriber
R
<datatypes:City></datatypes:City>
R
<datatypes:State></datatypes:State>
R
R
<datatypes:ZipCode></datatypes:ZipCode>
<structures:CommunicationNumbers></structures:Comm
unicationNumbers>
<datatypes:PrimaryTelephone></datatypes:PrimaryTeleph
one>
R
<datatypes:Number></datatypes:Number>
R
<structures:Prescriber></structures:Prescriber>
R
<structures:Identification></structures:Identification>
DEA Number
DEA Number of Prescriber
R
<datatypes:DEANumber></datatypes:DEANumber
NPI
NPI Number of Prescriber
R
<datatypes:NPI></datatypes:NPI>
Address Line 2
City
Last Updated: 07/17/2014 version 1.0
R
Data Type
Page - 23 -
Field
Size
Document Name
OHP-HIE Canonical Guide –PMP Medication History
Data element
Prescriber
License
Number
License number of Prescriber
R
<datatypes:MutallyDefined></datatypes:MutuallyDefined
>
Name
Wraps Name of Prescriber
R
<structures:Name></structures:Name>
Last Name
Last name of Prescriber
R
<datatypes:LastName></datatypes:LastName>
First Name
First name of Prescriber
R
<datatypes:FirstName></datatypes:Firstname>
Address
Wraps Address of Prescriber
R
<structures:Address></structures:Address>
Address Line 1
Address of Prescriber
Address of Prescriber (Only
needed if Prescriber has 2
address lines).
R
<datatypes:AddressLine1></datatypes:AddressLine1>
C
<datatypes:AddressLine2></datatypes:AddressLine2>
City of Prescriber
State of Prescriber (Listed by
2 letter Abbreviation).
R
<datatypes:City></datatypes:City>
R
<datatypes:State></datatypes:State>
R
<datatypes:ZipCode></datatypes:ZipCode>
History
Source4
Zip Code of Prescriber
Wraps source of where
information was received
from (may repeat 300 times
depending on # of
pharmacies).
R
<structures:HistorySource></structures:HistorySource>
Source
Wraps source Information
R
<datatypes:Source></datatypes:Source>
Reference
R
<datatypes:Reference></datatypes:Reference>
DEA Number
Source
Qualifier
Wraps source DEA Number
DEA of source of information
received
Qualifying Code of Source
(currently set to P2)
R
<datatypes:DEANumber></datatypes:DEANumber>
R
<datatypes:SourceQualifier></datatypes:SourceQualifier>
Source
Reference Rx Number of
R
<datatypes:SourceReference></datatypes:SourceReferenc
Address Line 2
City
State
Zip Code
Description/Business Logic
Req = R
Opt = O
Cond = C
Last Updated: 07/17/2014 version 1.0
XML element
Data Type
Page - 24 -
Field
Size
Document Name
OHP-HIE Canonical Guide –PMP Medication History
Data element
Reference
Description/Business Logic
Source
Req = R
Opt = O
Cond = C
XML element
Data Type
Field
Size
e>
Fill Number according to
Fill Number
Source
R
<datatypes:FillNumber></datatypes:FillNumber>
Wraps date range to include
Request date
in the PMP request
R
<SCRIPT:RequestedDates></SCRIPT:RequestedDates>
XML element
Start date
Wraps start date
R
<datatypes:StartDate></datatypes:StartDate>
XML element
Start date, without time.
Format=CCYY-MM-DD
(CC=Century YY=Year
Date without
Date
MM=Month DD=Day)
R
<datatypes:Date></datatypes:Date>
time
End date
Wraps end date
R
<datatypes:EndDate></datatypes:EndDate>
XML element
End date, without time.
Format=CCYY-MM-DD
(CC=Century YY=Year
Date without
Date
MM=Month DD=Day)
R
<datatypes:Date></datatypes:Date>
time
Information with Superscripts: 1,2,3, and 4may repeat up to 300 times depending on various services via pharmacies, prescribers, and sources used by
subject of search.
n/a
n/a
10
n/a
10
5.1.1.2. In the table below, the PMIX SOAP envelopes for Medication History Request and Response are represented. The SOAP
envelope will be added by the HIE and wrap the entire NCPDP message for the request sent to the PMP. The PMIX SOAP
envelope and medication history response will be received from the PMP at the HIE where the PMIX SOAP envelope will be
stripped in the transformation that occurs to send an NCPDP medication history response. The PMIX SOAP envelope formats are
shown for informational purposes. Trading partners will not send or receive PMIX SOAP envelopes.
Data element
Request
PMIX
SOAP
Envelope
XML version
SOAP
envelope
Description/Business Logic
Standard xml version
statement
XML element to wrap the
document, with namespace
declarations
Last Updated: 07/17/2014 version 1.0
Req = R
Opt = O
Cond = C
R
R
XML element
Data Type
Field
Size
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelopexmlns:soapenv="http://www.w3.org/2
003/05/soap-envelope"
xmlns:pmix="http://www.pmix.gov"
XML element
n/a
XML element
n/a
Page - 25 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
Data element
SOAP header
SOAP action
Request time
Requestor
metadata
Requestor
Requestor
role
Routing data
Disclosing
state
Request ID
Requesting
state
Message ID
Description/Business Logic
XML element to wrap the
header section
Defines the action as a
prescription drug history
request
Time of the request, UTC, in
the format YYYYMMDDThh:mm:ssZ R
Tag that wraps the requestor
metadata
WA ST DOH License number
of the practitioner making
the request in the Request
Example: PH00012345
Role of the requestor, for
example, "pharmacist"
Wraps routing data
The state disclosing the PMP
info. Will always be "WAHIE"
HIE routing ID for response to
be routed back to the
requesting HIE member
organization
The state requesting the PMP
info. Will always be "WAOHP"
MessageID will be assigned
by the sender as their way of
tracking and matching a
request and a response. This
is an urn field. Sample:
urn:uuid:aa7d79f9-8a1a4fc0-bbbc-a33ad24cf370
Last Updated: 07/17/2014 version 1.0
Req = R
Opt = O
Cond = C
XML element
xmlns:a="http://www.w3.org/2005/08/addressing"></soa
penv:Envelope>
Data Type
Field
Size
XML element
n/a
R
<soapenv:Header></soapenv:Header>
<a:Action
soapenv:mustUnderstand="1">http://www.pmix.gov/pmp
/ProvidePrescriptionDrugHistory</a:Action>
XML element
n/a
R
<pmix:RequestTime></pmix:RequestTime>
Datetime
25
R
<pmix:MetaData></pmix:MetaData>
XML element
n/a
R
<pmix:Requestor></pmix:Requestor>
Text
15
R
<pmix:RequestorRole></pmix:RequestorRole>
Text
50
R
<pmix:RoutingData></pmix:RoutingData>
XML element
n/a
R
<pmix:DisclosingState></pmix:DisclosingState>
Text
2
R
<pmix:RequestID></pmix:RequestID>
Text
8
R
<pmix:RequestingState></pmix:RequestingState>
Text
6
R
<a:MessageID></a:MessageID>
Text
100
R
Page - 26 -
Document Name
Response
PMIX
SOAP
envelope
OHP-HIE Canonical Guide –PMP Medication History
Data element
Description/Business Logic
Req = R
Opt = O
Cond = C
SOAP body
Wraps the message body
R
<soapenv:Body></soapenv:Body>
XML element
n/a
XML version
Standard xml version
statement
R
<?xml version="1.0" encoding="UTF-8"?>
XML element
n/a
R
<soapenv:Envelopexmlns:soapenv="http://www.w3.org/2
003/05/soap-envelope"
xmlns:pmix="http://www.pmix.gov"
xmlns:a="http://www.w3.org/2005/08/addressing"></soa
penv:Envelope>
XML element
n/a
R
<soapenv:Header></soapenv:Header>
XML element
n/a
R
R
<a:Action
soapenv:mustUnderstand="1">http://www.pmix.gov/pmp
/ProvidePrescriptionDrugHistory</a:Action>
<pmix:RoutingData></pmix:RoutingData>
XML element
XML element
n/a
n/a
R
<pmix:DisclosingState></pmix:DisclosingState>
Text
2
R
<pmix:RequestID></pmix:RequestID>
Text
8
R
<pmix:RequestingState></pmix:RequestingState>
Text
6
R
<a:RelatesTo></a:RelatesTo>
Text
100
SOAP
envelope
SOAP header
SOAP action
Routing data
Disclosing
state
Request ID
Requesting
state
Relates to
XML element to wrap the
document, with namespace
declarations
XML element to wrap the
header section
Defines the action as a
prescription drug history
request
Wraps routing data
The state disclosing the PMP
info. Will always be "WAHIE"
HIE routing ID for response to
be routed back to the
requesting HIE member
organization
The state requesting the PMP
info. Will always be "WAHIE”
in phase 1 of this project"
RelatesTo echoes back the
MessageID that was assigned
by the sender as their way of
tracking and matching a
request and a response. This
is an urn field. Sample:
urn:uuid:aa7d79f9-8a1a4fc0-bbbc-a33ad24cf370
Last Updated: 07/17/2014 version 1.0
XML element
Data Type
Field
Size
Page - 27 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
Data element
SOAP body
Description/Business Logic
Wraps the message body
Last Updated: 07/17/2014 version 1.0
Req = R
Opt = O
Cond = C
R
XML element
<soapenv:Body></soapenv:Body>
Data Type
XML element
Page - 28 -
Field
Size
n/a
6. TRANSACTION SAMPLES
6.1. Request Soap Sample(used by HIE when sending to PMP)
The request soap sample is added at the HIE hub when an NCPDP RxHistory Request is received. An example
of the soap wrapper follows:
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelopexmlns:soapenv="http://www.w3.org/2003/05/soap-envelope"
xmlns:pmix="http://www.pmix.gov" xmlns:a="http://www.w3.org/2005/08/addressing">
<soapenv:Header>
<a:Action
soapenv:mustUnderstand="1">http://www.pmix.gov/pmp/ProvidePrescriptionDrugHistory</a:Action>
<a:Tosoapenv:mustUnderstand="1">urn://wahie/</a:To>
<a:MessageID>ganeshact|ci1377550644773.1394@axwayvm097_te|PMIX_TestFile.xml</a:MessageID>
<pmix:RequestTime>Mon Aug 26 13:57:26 PDT 2013</pmix:RequestTime>
<pmix:MetaData>
<pmix:Requestor>DH1235555</pmix:Requestor>
<pmix:RequestorRole>OHP</pmix:RequestorRole>
<pmix:RoutingData>
<pmix:DisclosingState>WAHIE</pmix:DisclosingState>
<pmix:RequestID>1112828</pmix:RequestID>
<pmix:RequestingState>WA-OHP</pmix:RequestingState>
</pmix:RoutingData>
</pmix:MetaData>
</soapenv:Header>
<soapenv:Body>
6.2. Request Body– xml Sample (Includes transport header and body)
<?xml version="1.0" encoding="UTF-8"?>
<transport:MessageStructuresVersion="String" ECLVersion="String" DatatypesVersion="String"
TransactionDomain="SCRIPT" TransactionVersion="String" TransportVersion="String"
xsi:schemaLocation="http://www.ncpdp.org/schema/Transport transport.xsd"
xmlns:transport="http://www.ncpdp.org/schema/Transport"
xmlns:datatypes="http://www.ncpdp.org/schema/datatypes"
xmlns:SCRIPT="http://www.ncpdp.org/schema/SCRIPT"
xmlns:structures="http://www.ncpdp.org/schema/structures" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">
<transport:Header>
<transport:To Qualifier="ZZZ">WA-OHP</transport:To>
<transport:From Qualifier="C">7uycso03</transport:From>
<transport:MessageID>abfbeb2c57094e31957cc0dd3fabad61</transport:MessageID>
<transport:SentTime>2013-08-09T08:13:22</transport:SentTime>
<transport:Security>
<transport:UsernameToken>
<transport:Password Type="PasswordDigest"/>
<transport:Created>2013-08-09T08:13:22</transport:Created>
Document Name
OHP-HIE Canonical Guide –PMP Medication History
</transport:UsernameToken>
<transport:Sender>
<transport:SecondaryIdentification>DH1235555</transport:SecondaryIdentification>
</transport:Sender>
</transport:Security>
<transport:SenderSoftware>
<transport:SenderSoftwareDeveloper>N/A</transport:SenderSoftwareDeveloper>
<transport:SenderSoftwareProduct>N/A</transport:SenderSoftwareProduct>
<transport:SenderSoftwareVersionRelease>N/A</transport:SenderSoftwareVersionRelease>
</transport:SenderSoftware>
</transport:Header>
<transport:Body>
<transport:RxHistoryRequest>
<SCRIPT:BenefitsCoordination>
<structures:Consent>N</structures:Consent>
</SCRIPT:BenefitsCoordination>
<SCRIPT:Patient>
<structures:Identification>
<datatypes:SocialSecurity>123-12-1230</datatypes:SocialSecurity>
</structures:Identification>
<structures:Name>
<datatypes:LastName>Doe</datatypes:LastName>
<datatypes:FirstName>John</datatypes:FirstName>
</structures:Name>
<structures:Gender>M</structures:Gender>
<structures:DateOfBirth>
<datatypes:Date>1946-05-04</datatypes:Date>
</structures:DateOfBirth>
<structures:Address>
<datatypes:AddressLine1>123 Main St</datatypes:AddressLine1>
<datatypes:City>Auburn</datatypes:City>
<datatypes:State>AL</datatypes:State>
<datatypes:ZipCode>36830</datatypes:ZipCode>
</structures:Address>
</SCRIPT:Patient>
<SCRIPT:RequestedDates>
<datatypes:StartDate>
<datatypes:Date>2012-02-01</datatypes:Date>
</datatypes:StartDate>
<datatypes:EndDate>
<datatypes:Date>2012-03-31</datatypes:Date>
</datatypes:EndDate>
</SCRIPT:RequestedDates>
</transport:RxHistoryRequest>
</transport:Body>
</transport:Message>
6.3. Response– xml Sample(Includes transport header and body)
<?xml version="1.0" encoding="UTF-8"?>
<transport:Message TransportVersion="String" TransactionVersion="String" TransactionDomain="SCRIPT"
DatatypesVersion="String" ECLVersion="String" StructuresVersion="String"
Last Updated: 07/17/2014 version 1.0
Page - 30 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
xmlns:specialized="http://www.ncpdp.org/schema/specialized"
xmlns:structures="http://www.ncpdp.org/schema/structures" xmlns:ecl="http://www.ncpdp.org/schema/ecl"
xmlns:datatypes="http://www.ncpdp.org/schema/datatypes"
xmlns:SCRIPT="http://www.ncpdp.org/schema/SCRIPT" xmlns:transport="http://www.ncpdp.org/schema/Transport"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<transport:Header>
<transport:To Qualifier="ZZZ">WA-OHP</transport:To>
<transport:From Qualifier="C">7uycso03</transport:From>
<transport:MessageID>abfbeb2c57094e31957cc0dd3fabad61</transport:MessageID>
<transport:SentTime>2014-02-04T07:12:48-06:00</transport:SentTime>
<transport:Security>
<transport:UsernameToken>
<transport:Password Type="PasswordDigest"/>
<transport:Created>2013-08-26T14:45:00+00:00</transport:Created>
</transport:UsernameToken>
<transport:Sender>
<transport:SecondaryIdentification>RN88778899</transport:SecondaryIdentification>
</transport:Sender>
</transport:Security>
<transport:SenderSoftware>
<transport:SenderSoftwareDeveloper>N/A</transport:SenderSoftwareDeveloper>
<transport:SenderSoftwareProduct>N/A</transport:SenderSoftwareProduct>
<transport:SenderSoftwareVersionRelease>N/A</transport:SenderSoftwareVersionRelease>
</transport:SenderSoftware>
</transport:Header>
<transport:Body>
<transport:RxHistoryResponse>
<SCRIPT:Response>
<SCRIPT:Approved>
<SCRIPT:ReferenceNumber>7uycso03</SCRIPT:ReferenceNumber>
</SCRIPT:Approved>
</SCRIPT:Response>
<SCRIPT:BenefitsCoordination>
<structures:Consent>N</structures:Consent>
</SCRIPT:BenefitsCoordination>
<SCRIPT:Patient>
<structures:Name>
<datatypes:LastName>Murphy</datatypes:LastName>
<datatypes:FirstName>George</datatypes:FirstName>
</structures:Name>
<structures:Gender>M</structures:Gender>
<structures:DateOfBirth>
<datatypes:Date>1980-02-16</datatypes:Date>
</structures:DateOfBirth>
<structures:Address>
<datatypes:AddressLine1>123 10th St</datatypes:AddressLine1>
<datatypes:City>Auburn</datatypes:City>
<datatypes:State>AL</datatypes:State>
<datatypes:ZipCode>36830</datatypes:ZipCode>
</structures:Address>
</SCRIPT:Patient>
<SCRIPT:MedicationDispensed>
<structures:DrugDescription>HYDROCODON-ACETAMINOPHN 10-500</structures:DrugDescription>
Last Updated: 07/17/2014 version 1.0
Page - 31 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
<structures:DrugCoded>
<datatypes:ProductCode>
<datatypes:Code>00406036301</datatypes:Code>
<datatypes:Qualifier>ND</datatypes:Qualifier>
</datatypes:ProductCode>
</structures:DrugCoded>
<structures:Quantity>
<datatypes:Value>30</datatypes:Value>
<datatypes:CodeListQualifier>87</datatypes:CodeListQualifier>
<datatypes:QuantityUnitOfMeasure>
<datatypes:Code>Unspecified</datatypes:Code>
</datatypes:QuantityUnitOfMeasure>
</structures:Quantity>
<structures:DaysSupply>5</structures:DaysSupply>
<structures:WrittenDate>
<datatypes:Date>2012-01-17</datatypes:Date>
</structures:WrittenDate>
<structures:LastFillDate>
<datatypes:Date>2012-01-17</datatypes:Date>
</structures:LastFillDate>
<structures:Substitutions>0</structures:Substitutions>
<structures:RefillsRemaining>0</structures:RefillsRemaining>
<structures:Pharmacy>
<structures:Identification>
<datatypes:NCPDPID>0</datatypes:NCPDPID>
<datatypes:DEANumber>0148923</datatypes:DEANumber>
<datatypes:NPI>0</datatypes:NPI>
<datatypes:MutuallyDefined>0148923</datatypes:MutuallyDefined>
</structures:Identification>
<structures:BusinessName>ABC PHARMACY</structures:BusinessName>
<structures:Address>
<datatypes:AddressLine1>4371 SOUTH ST</datatypes:AddressLine1>
<datatypes:City>MONTGOMERY</datatypes:City>
<datatypes:State>AL</datatypes:State>
<datatypes:ZipCode>36601</datatypes:ZipCode>
</structures:Address>
<structures:CommunicationNumbers>
<datatypes:PrimaryTelephone>
<datatypes:Number>0</datatypes:Number>
</datatypes:PrimaryTelephone>
</structures:CommunicationNumbers>
</structures:Pharmacy>
<structures:Prescriber>
<structures:Identification>
<datatypes:DEANumber>BA9999999</datatypes:DEANumber>
<datatypes:NPI>0</datatypes:NPI>
<datatypes:MutuallyDefined>BA9999999</datatypes:MutuallyDefined>
</structures:Identification>
<structures:Name>
<datatypes:LastName>PAIN, NO</datatypes:LastName>
<datatypes:FirstName>?</datatypes:FirstName>
</structures:Name>
<structures:Address>
Last Updated: 07/17/2014 version 1.0
Page - 32 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
<datatypes:AddressLine1>240 PILL LANE</datatypes:AddressLine1>
<datatypes:City>PRATTVILLE</datatypes:City>
<datatypes:State>AL</datatypes:State>
<datatypes:ZipCode>36066</datatypes:ZipCode>
</structures:Address>
</structures:Prescriber>
<structures:HistorySource>
<datatypes:Source>
<datatypes:Reference>
<datatypes:DEANumber>0148923</datatypes:DEANumber>
</datatypes:Reference>
<datatypes:SourceQualifier>P2</datatypes:SourceQualifier>
</datatypes:Source>
<datatypes:SourceReference>1122335</datatypes:SourceReference>
<datatypes:FillNumber>0</datatypes:FillNumber>
</structures:HistorySource>
</SCRIPT:MedicationDispensed>
<SCRIPT:RequestedDates>
<datatypes:StartDate>
<datatypes:Date>2012-01-01</datatypes:Date>
</datatypes:StartDate>
<datatypes:EndDate>
<datatypes:Date>2012-01-31</datatypes:Date>
</datatypes:EndDate>
</SCRIPT:RequestedDates>
</transport:RxHistoryResponse>
</transport:Body>
</transport:Message>
7. ACKNOWLEDGEMENT AND ERROR HANDLING PROCESSES
7.1. Acknowledgement
The medication history response will in effect be the acknowledgement for this transaction.
7.2. Sample Error Message for missing required fields in Medication History Request
Entities submitting a Medication History request with required fields missing from the transport
header or body will receive an error message from the OHP-HIE. The message returned will be a
“Response Message Processing Error” or ResMPE. A sample ResMPE xml follows:
<?xml version="1.0" encoding="ISO-8859-1"?>
<ErrorResponse status="Failure">
<Product>HIE Integrator Engine</Product>
<Date>2013-08-30 10:02:15</Date>
<SenderID>ganeshact</SenderID>
<CoreID>ci1377882134954.172943@axway-vm097_te</CoreID>
<DocumentName>PMIX_TestFile - WithErrors.xml</DocumentName>
<DocumentType>PMP_Request</DocumentType>
Last Updated: 07/17/2014 version 1.0
Page - 33 -
Document Name
OHP-HIE Canonical Guide –PMP Medication History
<Message>[XML - 0]: Too few occurrences of
element='Message[1]/Header[1]/Security[1]/Sender[1]/SecondaryIdentification'. Found = 0. Min = 1.
Document line 15 position 4.</Message>
</ErrorResponse>
7.3. Sample Error Messages from PMP
The xml sample below demonstrates the medication history response that will be received when the
information requested is not found in the PMP repository. It could be that the patient is not found or that there
is no medication history in the timeframe listed in the medications history query.
<?xml version="1.0" encoding="UTF-8"?>
<transport:Messagexmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:transport="http://www.ncpdp.org/schema/Transport"
xmlns:SCRIPT="http://www.ncpdp.org/schema/SCRIPT"
xmlns:datatypes="http://www.ncpdp.org/schema/datatypes" xmlns:ecl="http://www.ncpdp.org/schema/ecl"
xmlns:structures="http://www.ncpdp.org/schema/structures"
xmlns:specialized="http://www.ncpdp.org/schema/specialized" StructuresVersion="String" ECLVersion="String"
DatatypesVersion="String" TransactionDomain="SCRIPT" TransactionVersion="String"
TransportVersion="String">
<transport:Header>
<transport:To Qualifier="ZZZ">WA-OHP</transport:To>
<transport:From Qualifier="C">7uycso03</transport:From>
<transport:MessageID>abfbeb2c57094e31957cc0dd3fabad61</transport:MessageID>
<transport:SentTime>2013-08-27T16:13:47-05:00</transport:SentTime>
<transport:Security>
<transport:UsernameToken>
<transport:Password Type="PasswordDigest"></transport:Password>
<transport:Created>2013-08-09T08:13:22+00:00</transport:Created>
</transport:UsernameToken>
<transport:Sender>
<transport:SecondaryIdentification>DH1235555</transport:SecondaryIdentification>
</transport:Sender>
</transport:Security>
<transport:SenderSoftware>
<transport:SenderSoftwareDeveloper>N/A</transport:SenderSoftwareDeveloper>
<transport:SenderSoftwareProduct>N/A</transport:SenderSoftwareProduct>
<transport:SenderSoftwareVersionRelease>N/A</transport:SenderSoftwareVersionRelease>
</transport:SenderSoftware>
</transport:Header>
<transport:Body>
<transport:Error>
<transport:Code>900</transport:Code>
<transport:DescriptionCode>1000</transport:DescriptionCode>
<transport:Description>NotFound</transport:Description>
</transport:Error>
</transport:Body>
</transport:Message>
Last Updated: 07/17/2014 version 1.0
Page - 34 -