Rx Event API

PioneerRx has the ability to turn on a Real Time Prescription Universal API service. This service will transmit in real-time or near real-time details about a prescription and related data based on specific events within the system. These events are customizable and one or more can be selected to transmit to a third party setup to receive the data.

Change Log

Version	Date	Change	Comments
2	11/16/2016	Initial Document Version for V 2	Version 2 is an entirely new API. If upgrading from Version 1, please review the entire specificiation.
2	07/14/2017	Added note to Claim section	Claim data is contingent on level of service for the configured device

Forward Compatibility

This specification describes the current level of functionality, however, new data elements will be added overtime. External Systems should be able to handle the addition of new data elements to the XML or JSON formats without impacting previous functionality. Only if the system wished to capture and use the new fields would modifications be needed. PioneerRx will announce new features to this specification as needed, but reserves the right to add to it at anytime without notifications to all vendors.

Backward Compatibility

PioneerRx will attempt to keep backward compatibility with all revisions prior to Version 2, however, in the event that a breaking change is required, we will attempt to communicate this change all known vendors with an estimated timeline for release. However, PioneerRx does reserve the right to change this format at any time in the event of situation that requires immediate breaking changes (for example legal or regulatory impacts).

Note, that Version 1 of the “Universal API” that PioneerRx may have communicated to select vendors is obsolete and has been replaced with this feed. Version 2 is not backward compatible with Version 1. Vendors should migrate code to Version 2 as soon as it is possible to avoid any future interruptions.

Requirements from Vendors

Each Vendor must provide a web service endpoint that messages can be transmitted to.
This service will also respond with a specfic form of response to confirm it has received the message.

This API will detail all the necessary information needed to program to this interface.

PioneerRx Software Configuration

PioneerRx Software has a workarea for configuring Devices of all kinds. The Rx Event API is configured like a device in the software.

The configuration details basic information such as type and name as well as connection related information.

To access this area, users with the appropriate permissions in PioneerRx, need to go to their Location tab in PioneerRx.
Next, they will go to the My Location to open up Location Options.
From here, they will go to the Rx Options tab, and then the Device Options tab.
On this interface, they can add, edit, or delete devices.
When adding or editing, they will be presented with a screen such as the following:

Below we describe the fields and their purpose:

Field	Description
Device Type	The Type of this device, for this API select Pioneer Universal 2
Device Name	A string to represent the inteface, typically you will see the vendor’s name and/or product in this field. This is just informational.
Description	An optional description of the device for informational purposes.
URL	The URL for the listener service. This should be an HTTPS service that listens for the messages as described in this API
Username	Username if wishing to use Basic Authentication
Password	Password if wishing to use Basic Authentication
Send Timeout	The number of seconds before a timeout error occurs when sending
Receive Timeout	The number of seconds before a timeout error occurs when receiving
Message Delay	An optional number of seconds to delay the transmission of messages artifically
Failure Delay	Not applicable for this service
This device is active	A checkbox activating this device, must be checked for service to sending
Start Date	Optional start date to being the service
Device User ID	The user in PioneerRx that this will run as (typically a service user)
Interface Version	An optional parameter specifying the interface version to use
Event Timeout	A timeout for the events to be transmitted
Use for retail	Option to apply this to retail as well as rx
Exclude Medication Sync	Option to not include rx data that is part of medication synchronization

Communication

The API will use HTTPS Web Services to communicate between the 2 systems.

This communication will occur locally at the pharmacy to a designated endpoint setup.
This endpoint may be inside the Pharmacy network, or external. If external, the third party must work with the pharmacy to ensure that any needed firewalls are setup to allow appropriate communication.

Security

Transmission Security

Transmission Security will use SSL (TLS) protocols for any service communicating externally from the pharmacy. SSL TLS 1.2 or higher is required. As security needs change over time, higher levels of SSL may be required in the future.

Authentication

Required Authentication to your service should be supplied using Basic Authentication.

In the configuration of the service, a pharmacy can supply a single Username and Password, as shown below.

These credentials will be transmitted as a Basic Auth Header (see example) Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l

For more information on Basic Authentication, see Wikipedia

Transmission Details

Web service calls will be provided for this API.

Standard POST HTTP method will be used to transmit the data to the external system, and are documented with each call below.

Data will be transmitted using JSON or XML.

Content-Type Header

JSON Content Type:

Content-Type: application/json

XML Content Type:

Content-Type: application/xml

The Content-Type Header will always be transmitted. The content-type will be selected based on the settings in PioneerRx.

Data Naming Conventions

<LookupType>...</LookupType>

{"LookupType":...}

Data will follow the names in the specs below using TitleCase as a convention.

Data Order

Within any complex type in either JSON or XML, the order of Fields should not matter. They could change over time or due to transmission and processing changes. The only exception to this is Lists, all lists are ordered lists.

Data Types

Data Type Format	Description	Examples
String(X)	A text string containing any UTF-8 valid character. X represents the max length, if applicable and if missing means unlimited. The length is variable however, so it may contain less than the max length as appropriate.	String - “Hello” String(2) - “He” String(15) - “Hello”
Int	Integer Value - 4 bytes (-2,147,483,648 to 2,147,483,647)	1 -1 0 1234567
Guid	A unique identifier, commonly referred to as GUID or UUID depending on the platform.	4418B788-D634-49BE-B598-75E80643A654
Decimal(P,S)	A decimal number. P stands for the fixed precision, S stands for the fixed scale. Values are padded to the right only. Left 0’s will not be used. Standard Rounding is used if needed.	Examples for value: 12.345 Decimal(10,3) = 12.345 Decimal(10,2) = 12.35 Decimal(10,1) = 12.3 Decimal(10,4) = 12.3450
Money	A value representing money amounts. This is an 8 byte SQL Server Money value, it will be output much like a Decimal, but has the following limits: -922,337,203,685,477.5808 to 922,337,203,685,477.5807	10.00 12.3456
Date	A Date value. This does not include any time information. Format: yyyy-mm-dd	2016-07-29
DateTime	A Data and Time value. Format: yyyy-mm-ddThh:mi:ss.mmmZ (ISO 8601 standard with TimeZone)	2016-07-29T14:31:45.667Z 2016-07-29T14:31:45.667+06:00
List	An Ordered List (aka Array) of complex object types, see the object type for its definition
Enum(type)	The Value will be one of a set of values. See the “Values/Description” column for the allowed values. Note, new enum values may be added and any client should be able to handle additions. The (type) will specify the actual type used for the enumeration

Null or Missing Data

You should be able to support JSON or XML nullability as is standard.

The following can be interpreted as NULL:

JSON

• Missing JSON object - when a field (aka object) is missing, it should be assumed to be nullability
• Explicit null - e.g. "field”:nil, can also be interpreted as null

XML

• Missing XML object - when a field (aka object) is missing, it should be assumed to be nullability
• Missing Data - e.g. <Field></Field>, can also be interpreted as null
• Explicit null - e.g. <Field xsi:nil=“true”/>, can also be interpreted as null

Case Sensitivity

Note that the case of XML and JSON field names are case sensitive. The casing used in this document is what you should expect to be transmitted. We expect responses to be in the proper case as shown as well.

Events

There are a number of events in the PioneerRx Software System that can be configured to trigger an event message as part of this API.

To configure the events to send, from the Edit a Device screen in PioneerRx, go to the Filtering option, shown below. There are a number of filters, Events being the primary filter:

The table below details these events and their meaning within the PioneerRx Software.

Event ID	Event Name	Description
1	On Hold	Rx was placed on Hold
2	Removed From Inventory	Inventory Levels have been Adjusted to remove the dispense quantity
3	Accept Reversal	A Claim Reversal was accepted by Third Party
4	Rejected Reversal	A Claim Reversal was rejected by Third Party
5	Put Back In Inventory	Inventory Levels have been Adjusted to return the amount (e.g. Patient did not pickup and returned to stock)
6	Complete Rx	An Rx Fill was completely filled
7	Saved Changed	A change to the Rx or Fill was saved (this event will generate a lot of messages)
8	Put In Will Call Bin	A Fill has been put in a Will Call bin, waiting for pickup, delivery, etc
9	Edit On Removed From Inventory	An Rx or Fill has been edited after already removed from inventory
10	Status Change	Triggered on each Workflow Status Change
11	Print Label	The Label for a Fill has been printed
12	Manual Send	A manually triggered action by employees at the pharmacy
13	Waiting for Fill	A Fill is waiting for Fill (typically waiting for the Fill Station if Pharmacy utilizes that station)
14	Canceled	A Fill has been cancelled
15	IVR Notify	Occurs when item has been placed into Will Call
16	Edit On/After Waiting for Fill	A Fill has been edited while Waiting For Fill or later in the workflow
17	Inventory Changed On/After Waiting for Fill	Inventory Levels have changed while Waiting for Fill or later in the workflow
18	Discontinue Rx	An Rx has been discontinued
19	Delete Rx	An Rx has been deleted
20	Transfer Rx	An Rx has been transferred to another pharmacy (this includes store transfer between chain stores)
21	Waiting For Print	A Fill is waiting for print (in the Print Queue)
22	Inventory Changed On/After Waiting for Print	Inventory Levels have changed while Waiting for Print or later in the workflow
23	Checked	A Fill has been checked after filled
24	Waiting For Central Fill	A Fill is waiting for Central Fill
25	Inventory Changed On/After Waiting for Central Fill	Inventory Levels have changed while Waiting for Central Fill or later in the workflow
26	Canceled Central Fill	A Central Fill has been Canceled

Message

{"MessageHeader":{...},"Body":{...}}

<XML>
  <MessageHeader>
    ...
  </MessageHeader>
  <Body>
    ...
  </Body>
</XML>

The Message will consist of a Message Header and a Body. The header will include basic information related to the transmission, whereas the Body will contain the data elements. Each is described below:

Message Header

{  
   "MessageHeader":{  
      "Version":2.0,
      "MessageID":"ba1b666b-dab5-43b2-8626-7c4b5a686c85",
      "SentOnUTC":"2016-10-03T15:55:22.511816Z",
      "Workstation":"WorkstationName",
      "InitiatingEventID":"2",
      "InitiatingEventText":"RemovedFromInventory"
   }
}

<MessageHeader>
  <Version>2.0</Version>
  <MessageID>ba1b666b-dab5-43b2-8626-7c4b5a686c85</MessageID>
  <SentOnUTC>2016-10-03T15:55:22.511816Z</SentOnUTC>
  <Workstation>WorkstationName</Workstation>
  <InitiatingEventID>2</InitiatingEventID>
  <InitiatingEventText>RemovedFromInventory</InitiatingEventText>
</MessageHeader>

Field	DataType	Always Present	Values / Description
Version	Decimal	Yes	The current version of the message.
MessageID	Guid	Yes	A Unique ID for this specific message, each message will have its own ID
SentOnUTC	DateTime	Yes	The DateTime in UTC from the PioneerRx Pharmacy’s Server that the message was transmitted
Workstation	String	No	The Name of the Workstation (PC Name) that sent the message
InitiatingEventID	Enum(Int)	No	The ID for the event that triggered the message
InitiatingEventText	String	No	The Text name for the event that triggered the message

Body

{
  "Pharmacy":{...},
  "Employees":[...],
  "Prescribers":[...],
  "Patient":{...},
  "AnimalOwner":{...},
  "Facility":{...},
  "Rx":{...},
  "Claims":{...}
}

<Body>
  <Pharmacy>...</Pharmacy>
  <Employees>
    <Employee>...</Employee>
    ...
  </Employees>
  <Prescribers>
    <Prescriber>...</Prescriber>
    ...
  </Prescribers>
  <Patient>...</Patient>
  <AnimalOwner>...</AnimalOwner>
  <Facility>...</Facility>
  <Rx>...</Rx>
  <Claims>
    <Claim>...</Claim>
    ...
  </Claims>
</Body>

The Body is made up of several Entities. Each with its own data elements. We will refer to each Entity as a DataType, see the table corresponding to that entity below for more information.

Field	DataType	Always Present	Values / Description
Pharmacy	Pharmacy	Yes	The Pharmacy Data Object detailing information about the pharmacy
Employees	Employee List	Yes	A List of Employee Data Objects that are related to this Rx or Event
Prescribers	Prescriber List	Yes	A List of Prescriber Data Objects that are related to the Rx
Patient	Patient	Yes	The Patient Data Object for this Rx
AnimalOwner	AnimalOwner	No	The Animal Owner Object (if applicable) for this Patient and Rx
Facility	Facility	No	The Facility Data Object (if applicable) for this Patient and Rx
Rx	Rx	Yes	The Rx Data Object for this Rx
Claims	Claim List	No	The Claim Data Object for this Rx

General Data Objects

The following Data Objects are used by multiple data objects below. Reference them when reviewing them as appropriate.

Address

{
  "SequenceNumber":1,
  "AddressLine":"123 Main St",
  "City":"Small Town",
  "StateCode":"LA",
  "ZipCode":"12345-7890",
  "Type":"Primary"
}

<Address>
  <SequenceNumber>1</SequenceNumber>
  <AddressLine>123 Main St</AddressLine>
  <City>Small Town</City>
  <StateCode>LA</StateCode>
  <ZipCode>12345-7890</ZipCode>
  <Type>Primary</Type>
</Address>

Field	DataType	Always Present	Values / Description
SequenceNumber	Int	Yes	A Reference Number used in areas of the spec to refer to specific objects
AddressLine	String	No	The first line of an Address Street
City	String	No	The City
StateCode	String	No	The United State’s State Code (State Abbreviation) or territory
ZipCode	String	No	The 10 Digit Zip Code
Type	String	No	A type of Address, e.g. Primary, Mailing, Delivery, Other, etc.

Phone Number

{
  "SequenceNumber":1,
  "AreaCode":"318",
  "Number":"5551234",
  "Extension":"123",
  "Type":"Primary"
}

<PhoneNumber>
  <SequenceNumber>1</SequenceNumber>
  <AreaCode>318</AreaCode>
  <Number>5551234</Number>
  <Extension>123</Extension>
  <Type>Primary</Type>
</PhoneNumber>

Field	DataType	Always Present	Values / Description
SequenceNumber	Int	Yes	A Reference Number used in areas of the spec to refer to specific objects
AreaCode	Int	No	The 3 Digit Area Code for U.S. Phone Numbers
Number	Int	No	The 7 Digit Phone Number
Extension	Int	No	The Extension or Suffix Dial String if applicable
Type	String	No	A type of Phone Number, e.g. Primary, Primary Fax, Notify, Other, etc.

Name

{
  "FirstName":"John",
  "LastName":"Doe",
  "MiddleName":"David",
  "Suffix":"III",
  "Prefix":"Mr.",
  "Initials":"JDD"
}

<Name>
  <FirstName>John</FirstName>
  <LastName>Doe</LastName>
  <MiddleName>David</MiddleName>
  <Suffix>III</Suffix>
  <Prefix>Mr.</Prefix>
  <Initials>JDD</Initials>
</Name>

Field	DataType	Always Present	Values / Description
FirstName	String	No	A person’s First (aka Given) Name
LastName	String	No	A person’s Last Name (aka Surname or Family Name)
MiddleName	String	No	A person’s full Middle Name or Names
Suffix	String	No	A person’s suffix, e.g. Jr., II, III, PhD, etc.
Prefix	String	No	A person’s prefix, e.g. Mr., Mrs., Ms., Dr., etc.
Initials	String	No	A person’s initials

Pharmacy

{
  "Identification":{...},
  "PharmacyName":"PioneerRx Pharmacy",
  "StoreNumber":"134",
  "Addresses":[...],
  "PhoneNumbers":[...],
  "PrimaryPhoneSequenceNumber":1,
  "PrimaryFaxSequenceNumber":2,
  "Email":"someone@test.com",
  "WebAddress":"http://www.test.com",
  "PharmacistInChargePioneerRxID":"2f53ec7c-b691-4002-b8f1-4443a5b04d84"
}

<Pharmacy>
  <Identification>...</Identification>
  <PharmacyName>PioneerRx Pharmacy</PharmacyName>
  <StoreNumber>134</StoreNumber>
  <Addresses>
    <Address>...</Address>
    ...
  </Addresses>
  <PhoneNumbers>
    <PhoneNumber>...</PhoneNumber>
    ...
  </PhoneNumbers>
  <PrimaryPhoneSequenceNumber>1</PrimaryPhoneSequenceNumber>
  <PrimaryFaxSequenceNumber>2</PrimaryFaxSequenceNumber>
  <Email>someone@test.com</Email>
  <WebAddress>http://www.test.com</WebAddress>
  <PharmacistInChargePioneerRxID>2f53ec7c-b691-4002-b8f1-4443a5b04d84</PharmacistInChargePioneerRxID>
</Pharmacy>

Field	DataType	Always Present	Values / Description
Identification	Pharmacy Identification	Yes	A Data Object that gives various IDs that represent the Pharmacy
PharmacyName	String	Yes	The name given to a pharmacy
StoreNumber	String	No	The store number applied to an individual store by the pharmacy, normally only used in multi-store pharmacies
Addresses	Address List	No	The Addresses for the pharmacy
PhoneNumbers	Phone Number List	No	The Phone Numbers for the pharmacy
PrimaryPhoneSequenceNumber	Int	No	The sequence number for the primary phone number for the pharmacy
PrimaryFaxSequenceNumber	Int	No	The sequence number for the primary fax number for the pharmacy
Email	String	No	The email address for the pharmacy
WebAddress	String	No	The website address for the pharmacy
PharmacistInChargePioneerRxID	Guid	No	The PioneerRx ID (GUID) for the pharmacist in charge, found in the Employees list

Pharmacy Identification

{
  "PharmacyPioneerRxID":"5e428323-00e5-4e11-991f-d7511e3b3c32",
  "NCPDP":"123456",
  "NPI":"1234567890",
  "DEA":"AB1234567",
  "DPS":"1234567",
  "FederalTaxID":"123456789",
  "StateLicenseNumber":"12345678"
}

<Identification>
  <PharmacyPioneerRxID>5e428323-00e5-4e11-991f-d7511e3b3c32</PharmacyPioneerRxID>
  <NCPDP>123456</NCPDP>
  <NPI>1234567890</NPI>
  <DEA>AB1234567</DEA>
  <DPS>1234567</DPS>
  <FederalTaxID>123456789</FederalTaxID>
  <StateLicenseNumber>12345678</StateLicenseNumber>
</Identification>

Field	DataType	Always Present	Values / Description
PharmacyPioneerRxID	Guid	Yes	The Internal Pharmacy PioneerRx ID
NCPDP	String	No	The NCPDP Provider ID (aka NABP)
NPI	String	No	The National Provider Identifier
DEA	String	No	The U.S. Drug Enforcement Administration Number
DPS	String	No	The Department of Public Safety Number
FederalTaxID	String	No	The U.S. IRS Federal Tax Identifier
StateLicenseNumber	String	No	The Pharmacy’s Primary State License Number

Employee

{
  "Identification":{...},
  "EmployeeTypeID":"4ad485cd-41e2-4250-b674-bca7f471873d",
  "EmployeeTypeText":"Pharmacist",
  "ChangedOnUTCDateTime":"2016-07-29T14:31:45.667Z",
  "Name":{...}
}

<Employee>
  <Identification>...</Identification>
  <EmployeeTypeID>4ad485cd-41e2-4250-b674-bca7f471873d</EmployeeTypeID>
  <EmployeeTypeText>Pharmacist</EmployeeTypeText>
  <ChangedOnUTCDateTime>2016-07-29T14:31:45.667Z</ChangedOnUTCDateTime>
  <Name>...</Name>
</Employee>

Field	DataType	Always Present	Values / Description
Identification	Employee Identification	Yes	A Data Object that gives various IDs that represent the Employee
EmployeeTypeID	Enum(Guid)	Yes	Employee Type ID (See Table Below)
EmployeeTypeText	String	Yes	Employee Type Text
ChangedOnUTCDateTime	DateTime	Yes	The DateTime (in UTC) of the last time this data object was edited
Name	Name	Yes	The Employee’s Name

Employee Type ID

Employee Type ID	Description
563EC574-C0F3-4CE9-9E17-19EAF832ECFF	Pharmacy Tech Candidate
D8A4E296-0BCD-49E1-AC85-4D8C05E913BA	Pharmacist Intern
30A0F283-1AFA-41D2-B964-B54A874DF618	Licensed Pharmacy Tech
4AD485CD-41E2-4250-B674-BCA7F471873D	Pharmacist
12200BE5-0C58-4A38-9550-CDA2EA6D4E84	Employee

Employee Identification

{
  "EmployeeID":"1234",
  "EmployeePioneerRxID":"1be3e933-b447-4955-9de6-14bdd89d5a6d",
  "NPI":"1234567890",
  "License":"12345678"
}

<Identification>
  <EmployeeID>1234</EmployeeID>
  <EmployeePioneerRxID>1be3e933-b447-4955-9de6-14bdd89d5a6d</EmployeePioneerRxID>
  <NPI>1234567890</NPI>
  <License>12345678</License>
</Identification>

Field	DataType	Always Present	Values / Description
EmployeeID	String	Yes	The Employee ID (aka Employee Number) the pharmacy has assigned the employee
EmployeePioneerRxID	Guid	Yes	The Internal PioneerRx ID
NPI	String	No	The National Provider Identifier
License	String	No	The employee’s license number

Prescriber

{
  "Identification":{...},
  "Name":{...},
  "Addresses":[...],
  "PhoneNumbers":[...],
  "PrimaryPhoneSequenceNumber":1,
  "Email":"prescriberemail@PioneerRx.com",
  "PrescriberTypeID":"d139410d-1df9-4f25-afff-f6f35f4e4c30",
  "PrescriberTypeText":"M.D.",
  "ClassificationID":"9e7f7022-2425-4df8-b3f7-2f29287b2e05",
  "ClassificationText":"Anesthesiology",
  "PrimarySpecializationID":"66bd3a96-3493-4762-886d-3a726f14bcc6",
  "PrimarySpecializationText":"Addiction Medicine",
  "IsSupervisor":"true",
  "Comments":[...],
  "MarketerEmployeePioneerRxID":"adfcdd4d-6b9f-469e-a037-fdf9d564deed",
  "ChangedOnUTCDateTime":"2016-07-29T14:31:45.667Z"
}

<Prescriber>
  <Identification>...</Identification>
  <Name>...</Name>
  <Addresses>
    <Address>...</Address>
  </Addresses>
  <PhoneNumbers>
    <PhoneNumber>...</PhoneNumber>
  </PhoneNumbers>
  <Email>prescriberemail@PioneerRx.com</Email>
  <PrescriberTypeID>d139410d-1df9-4f25-afff-f6f35f4e4c30</PrescriberTypeID>
  <PrescriberTypeText>M.D.</PrescriberTypeText>
  <ClassificationID>9e7f7022-2425-4df8-b3f7-2f29287b2e05</ClassificationID>
  <ClassificationText>Anesthesiology</ClassificationText>
  <PrimarySpecializationID>66bd3a96-3493-4762-886d-3a726f14bcc6</PrimarySpecializationID>
  <PrimarySpecializationText>Addiction Medicine</PrimarySpecializationText>
  <IsSupervisor>true</IsSupervisor>
  <Comments>...</Comments>
  <MarketerEmployeePioneerRxID>adfcdd4d-6b9f-469e-a037-fdf9d564deed</MarketerEmployeePioneerRxID>
  <ChangedOnUTCDateTime>2016-07-29T14:31:45.667Z</ChangedOnUTCDateTime>
</Prescriber>

Field	DataType	Always Present	Values / Description
Identification	Prescriber Identification	Yes	A Data Object that gives various IDs that represent the Prescriber
Name	Name	No	Prescriber’s Name
Addresses	Address List	No	A List of Addresses for the Prescriber
PhoneNumbers	Phone Number List	No	A List of Phone Numbers for the Prescriber
PrimaryPhoneSequenceNumber	Int	No	The sequence number for the primary phone number for the prescriber
Email	String	No	Prescriber’s email address
PrescriberTypeID	Guid	No	Prescriber’s Type ID (See table below) Note that new types may be added over time
PrescriberTypeText	String	No	Prescriber’s Type Text
ClassificationID	Guid	No	Prescriber’s Classification ID
ClassificationText	String	No	Prescriber’s Classification Text
PrimarySpecializationID	Guid	No	Prescriber’s Specialization ID
PrimarySpecializationText	String	No	Prescriber’s Specialization Text
IsSupervisor	Int	No	A flag to show if a Prescriber is the Supervisor
Comments	Prescriber Comments	No	Internal Pharmacy Comments about the Prescriber
MarketerEmployeePioneerRxID	Guid	No	The PioneerRx Marketer ID
ChangedOnUTC	DateTime	Yes	The DateTime (in UTC) of the last time this data object was edited

Prescriber TypeID

Prescriber Type ID	Description
0F9D48E2-D0F3-4E19-882C-0307B7B50D05	OD
48D83337-52C0-4FA5-8A7F-21F3F46A2DB3	D.O.
282A05C9-A88E-42FB-9280-354C48DD0BC7	D.D.S.
4870DA30-578E-4F17-8C09-4065A916DB50	F.N.P.
695DFEE6-9B3F-4081-B79C-480330803F1A	CPP
04C34E27-197A-49B3-9437-488455CD085B	N.D.
A9C4379C-BCA2-490E-8667-4A24BC5BD946	P.A.
CEE81234-BBB2-4055-9BFA-56C7AC5BDCFC	RPh
9176C1C6-A0B4-4B4B-AAB5-5BDEEC208550	APRN
09F50514-6F3B-4750-A0DC-82E7B9857E06	DC APC
8D56A4DE-171E-43B3-9A56-92BF38348798	CRNA
15B0D7D5-0CE9-4F22-8E0B-9921E0806802	PharmD
4D6DC006-B023-4E50-BF9F-AE8AE8547A93	WHNP
A12DDDDE-F21C-469C-B3C2-BFDEF2DC176B	PhD
87A9FC9E-30FC-4AAA-8E41-C17EE0B87E10	ARNP
051A1005-3690-486B-AD92-C9FE2ACD0799	DPM
81145CFA-E7D3-4339-95DA-CEE0C533610A	CNP
56830F16-848D-48A4-AA84-E359AE862AB4	N.P.
4AF52909-C267-44FD-BA05-E3A78A32273F	CDH
F612E886-0F96-433D-8E27-EB7F6E130F91	D.M.D.
A54976C3-A068-4EC5-99BC-EF4F82FFFBBC	D.V.M.
D139410D-1DF9-4F25-AFFF-F6F35F4E4C30	M.D.
CA7B735E-6AAD-44AC-962F-FB1D66BA1011	CNM

Prescriber Identification

{
  "PrescriberPioneerRxID":"94043A8D-D09A-439C-A09A-ABC46E06FD66",
  "NPI":"1234567890",
  "DEA":"AB1234567",
  "DPS":"1234567",
  "StateLicense":"12345567",
  "SerialNumberPerson":12345
}

<Identification>
  <PrescriberPioneerRxID>94043A8D-D09A-439C-A09A-ABC46E06FD66</PrescriberPioneerRxID>
  <NPI>1234567890</NPI>
  <DEA>AB1234567</DEA>
  <DPS>1234567</DPS>
  <StateLicense>12345567</StateLicense>
  <SerialNumberPerson>12345</SerialNumberPerson>
</Identification>

Field	DataType	Always Present	Values / Description
PrescriberPioneerRxID	Guid	Yes	The internal PioneerRx Prescriber ID
NPI	String	No	Prescriber’s National Provider Identification
DEA	String	No	Prescriber’s U.S. Drug Enforcement Administration Number
DPS	String	No	Prescriber’s Department of Public Safety Number
StateLicense	String	No	Prescriber’s State License Number
SerialNumberPerson	Int	No	Prescriber’s PioneerRx supplied Serial Number.

Prescriber Comments

{
  "Informational":"Comments about Prescriber that are non-critical",
  "Critical":"Critical Comments that are presented with more emphasis in the software",
  "PointOfSale":"Comments that show at the PioneerRx POS to the POS Clerk"
}

<Comments>
  <Informational>Comments about Prescriber that are non-critical</Informational>
  <Critical>Critical Comments that are presented with more emphasis in the software</Critical>
  <PointOfSale>Comments that show at the PioneerRx POS to the POS Clerk</PointOfSale>
</Comments>

Field	DataType	Always Present	Values / Description
Informational	String	No	Prescriber’s Informational Comments
Critical	String	No	Prescriber’s Critical Comments
PointOfSale	String	No	Prescriber’s Point Of Sale Comments

Patient

{
  "Identification":{...},
  "Name":{...},
  "Addresses":[...],
  "PhoneNumbers":[...],
  "PrimaryPhoneSequenceNumber":1,
  "RxNotifyPhoneSequenceNumber":1,
  "RxNotifyProviderTypeID":4,
  "RxNotifyProviderTypeText":"Sprint",
  "RxNotifyTypeID":3,
  "RxNotifyTypeText":"Text",
  "EZOpenRequested":0,
  "HasPatientReceivedNopp":1,
  "HeightInches":72,
  "WeightOunces":2400,
  "IsAnimal":0,
  "HipaaStatusTypeID":2,
  "HipaaStatusTypeText":"Signed",
  "Email":"test@test.com",
  "Gender":"M",
  "LanguageText":"English",
  "LanguageCode":"en",
  "LanguageTypeID":1,
  "DateOfBirth":"1983-04-19",
  "AutoFillModeTypeID":2,
  "AutoFillModeTypeText":"Auto Renew",
  "DeliveryMethodTypeID":"1",
  "DeliveryMethodText":"UPS",
  "PatientPrimaryPrescriberPioneerRxID":"94043A8D-D09A-439C-A09A-ABC46E06FD66",
  "HealthCoachEmployeePioneerRxID":"985BC7B5-A96E-4AA2-A760-E816605EA33E",
  "SyncStatusTypeID":2,
  "SyncStatusTypeText":"Enrolled",
  "SyncDate":"2016-11-04",
  "CallDate":"2016-12-01",
  "NextPickupDate":"2016-12-04",
  "SyncDays" : "28",
  "MedicationSynchronizationContactMethodID": "0",
  "MedicationSynchronizationContactMethodText" : "None",
  "Comments":{...},
  "Categories":[...],
  "PrimaryCategory":"Diabetic",
  "Allergies":[...],
  "OtherMedications":[...],
  "ChangedOnUTC":"2016-07-29T14:31:45.667Z",
  "PatientRiskScore":"77",
  "PatientMultidose":"0",
  "PatientPioneerRxID":"58828136-8d3f-4307-bca2-89b1d9ae9bb9",
  "AlertTypeID":"3",
  "AlertTypeText":"Custom",
  "AlertCustomText":"Custom Text Here",
  "AllergyAlertTypeID":"0",
  "AllergyAlertTypeText":"ASK FOR ALLERGIES?",
  "CreatedOnUTCDateTime":"2012-03-07T10:21:08.627Z",
  "DeliveryMethodComment":"Delivery Method Comment",
  "DeliveryZoneID":"8f521846-9835-4df1-bcfb-acf1eeed8e07",
  "DeliveryZoneText":"Zone 0",
  "DeliveryPaymentTypeEnum":"2",
  "DeliveryPaymentTypeText":"Credit Card"
  "PrimaryCategory":"240B Eligible"
}

<Patient>
  <Identification>...</Identification>
  <Name>...</Name>
  <Addresses>
    <Address>...</Address>
  </Addresses>
  <PhoneNumbers>
    <PhoneNumber>...</PhoneNumber>
  </PhoneNumbers>
  <PrimaryPhoneSequenceNumber>1</PrimaryPhoneSequenceNumber>
  <RxNotifyPhoneSequenceNumber>1</RxNotifyPhoneSequenceNumber>
  <RxNotifyProviderTypeID>4</RxNotifyProviderTypeID>
  <RxNotifyProviderTypeText>Sprint</RxNotifyProviderTypeText>
  <RxNotifyTypeID>3</RxNotifyTypeID>
  <RxNotifyTypeText>Text</RxNotifyTypeText>
  <EZOpenRequested>0</EZOpenRequested>
  <HasPatientReceivedNopp>1</HasPatientReceivedNopp>
  <HeightInches>72</HeightInches>
  <WeightOunces>2400</WeightOunces>
  <IsAnimal>0</IsAnimal>
  <HipaaStatusTypeID>2</HipaaStatusTypeID>
  <HipaaStatusTypeText>Signed</HipaaStatusTypeText>
  <Email>test@test.com</Email>
  <Gender>M</Gender>
  <LanguageTypeID>1</LanguageTypeID>
  <LanguageText>English</LanguageText>
  <LanguageCode>en</LanguageCode>
  <DateOfBirth>1983-04-19</DateOfBirth>
  <AutoFillModeTypeID>2</AutoFillModeTypeID>
  <AutoFillModeTypeText>Auto Renew</AutoFillModeTypeText>
  <DeliveryMethodTypeID>1<DeliveryMethodTypeID>
  <DeliveryMethodText>UPS</DeliveryMethodText>
  <PatientPrimaryPrescriberPioneerRxID>94043A8D-D09A-439C-A09A-ABC46E06FD66</PatientPrimaryPrescriberPioneerRxID>
  <HealthCoachEmployeePioneerRxID>985BC7B5-A96E-4AA2-A760-E816605EA33E</HealthCoachEmployeePioneerRxID>
  <SyncStatusTypeID>2</SyncStatusTypeID>
  <SyncStatusTypeText>Enrolled</SyncStatusTypeText>
  <SyncDate>2016-11-04</SyncDate>
  <CallDate>2016-12-01</CallDate>
  <NextPickupDate>2016-12-04</NextPickupDate>
  <SyncDays>28</SyncsDays>
  <MedicationSynchronizationContactMethodID>8</MedicationSynchronizationContactMethodID>
  <MedicationSynchronizationContactMethodText>Escript</MedicationSynchronizationContactMethodText>
  <Comments>...</Comments>
  <Categories>
    <Category>...</Category>
  </Categories>
  <PrimaryCategory>Diabetic</PrimaryCategory>
  <Allergies>
    <Allergy>...</Allergy>
  </Allergies>
  <OtherMedications>
    <Medication>...</Medication>
  </OtherMedications>
  <ChangedOnUTC>2016-07-29T14:31:45.667Z</ChangedOnUTC>
  <PatientRiskScore>77</PatientRiskScore>
  <PatientMultidose>0</PatientMultidose>
  <PatientPioneerRxID>58828136-8d3f-4307-bca2-89b1d9ae9bb9</PatientPioneerRxID>
  <AlertTypeID>3</AlertTypeID>
  <AlertTypeText>Custom</AlertTypeText>
  <AlertCustomText>Custom Text Here</AlertCustomText>
  <AllergyAlertTypeID>0</AllergyAlertTypeID>
  <AllergyAlertTypeText>ASK FOR ALLERGIES?</AllergyAlertTypeText>
  <CreatedOnUTCDateTime>2012-03-07T10:21:08.627Z</CreatedOnUTCDateTime>
  <DeliveryMethodComment>Delivery Method Comment</DeliveryMethodComment>
  <DeliveryZoneID>8f521846-9835-4df1-bcfb-acf1eeed8e07</DeliveryZoneID>
  <DeliveryZoneText>Zone 0</DeliveryZoneText>
  <DeliveryPaymentTypeEnum>2</DeliveryPaymentTypeEnum>
  <DeliveryPaymentTypeText>Credit Card</DeliveryPaymentTypeText>
  <PrimaryCategory>340B Eligible</PrimaryCategory
</Patient>

Field	DataType	Always Present	Values / Description
Identification	Patient Identification	Yes	A Data Object that gives various IDs that represent the Patient.
Name	Name	Yes	Patient’s Name
Addresses	Address List	No	A List of Addresses for the Patient
PhoneNumbers	Phone Number List	No	A List of Phone Numbers for the Patient
PrimaryPhoneSequenceNumber	Int	No	The sequence number for the primary phone number for the Patient
RxNotifyPhoneSequenceNumber	Int	No	The sequence number for the notify phone number for the Patient
RxNotifyProviderTypeID	Enum(Int)	No	The provider type for Rx Notify SMS Messages (Carriers) (See table below)
RxNotifyProviderTypeText	String	No	The text description for the RxNotifyProviderTypeID
RxNotifyTypeID	Enum(Int)	No	A type to show what the preference of the patient is with regards to notifications (See table below)
RxNotifyTypeText	String	No	The text description for the RxNotifyTypeID
EZOpenRequested	Int	Yes	A flag to show if a Patient prefers Easy Open Bottles (0 = No, 1 = Yes)
HasPatientReceivedNopp	Int	Yes	A flag to show if a Patient has Received an NOPP (0 = No, 1 = Yes)
HeightInches	Int	No	Patient’s Height in Inches
WeightOunces	Int	No	Patient’s Weight in Ounces
IsAnimal	Int	No	A flag to show if a Patient is an Animal (0 = No, 1 = Yes)
HipaaStatusTypeID	Int	No	Patient’s HIPAA Status Type ID 1-Good Faith Effort 2-Signed 3-Print and Sign
HipaaStatusTypeText	String	No	Patient’s HIPAA Status Type Text
Email	String	No	Patient’s Email Address
Gender	String	No	Patient’s Gender (M = Male, F = Female)
LanguageText	String	No	Patient’s Prefered Language Text, this is the human readable version of LanguageCode below
LanguageCode	String	No	Patient’s Prefered Language Code en-English sp-Spanish 3
LanguageTypeID	Int	No	Patient’s Prefered Language Code 1-English 2-Spanish 3 + are dynamic and set by the pharmacy
DateOfBirth	Date	No	Patient’s Date of Birth
AutoFillModeTypeID	Int	No	Patient’s Auto Fill Mode Type ID 0-Ask Patient? 1-Auto Fill 2-Auto Renew 3-Not Used 10-Declined
AutoFillModeTypeText	String	No	Patient’s Auto Fill Mode Type Text
DeliveryMethodTypeID	Enum	Patient’s Prefered Delivery Method ID (See Table Below)
DeliveryMethodText	String	No	A text description for the DeliverMethodTypeID
PatientPrimaryPrescriberPioneerRxID	Guid	No	The Patient’s Primary Prescriber Internal PioneerRx ID
HealthCoachEmployeePioneerRxID	Guid	No	The Patient’s Health Coach Employee Internal PioneerRx ID
SyncStatusTypeID	Int	No	Patient’s Sync Status Type ID 0-Not Enrolled 1-Recommended 2-Enrolled 3-Declined 4-Not Recommended
SyncStatusTypeText	String	No	Patient’s Sync Status Type Text
SyncDate	Date	No	Sync Pickup Date
CallDate	Date	No	Next Sync Call Date
NextPickupDate	Date	No	Next Sync Pickup Date
SyncDays	Int	No	Sync Days
MedicationSynchronizationContactMethodTypeID	Int	No	Patient’s Medication Synchronization Contact Method ID 0-None 1-Phone 2-Text
MedicationSynchronizationContactMethodTypeText	String	No	Patient’s Medication Synchronization Contact Method Type Text
Comments	Patient Comments	No	Internal Pharmacy Comments about the Patient
Categories	Category	No	List of Patient’s Categories
PrimaryCategory	String	No	Patient’s Primary Category
Allergies	Allergy	No	A List of Patient Allergies
OtherMedications	Medication	No	A List of Patient Medications
ChangedOnUTC	DateTime	Yes	The DateTime (in UTC) of the last time this data object was edited
PatientRiskScore	String	No	The PioneerRx Patient Risk Score
PatientMultidose	Int	Yes	Patient’s Multidose Flag
PatientPioneerRxID	Guid	No	The PioneerRx ID of the Patient
AlertTypeID	Int	No	The Alert Type ID for a Patient (See Table Below)
AlertTypeText	String	No	Alert Type Text for a Patient
AlertCustomText	String	No	Custom Alert Text for a Patient
AllergyAlertTypeID	Int	No	Allergy Alert Type ID for a Patient
AllergyAlertTypeText	String	No	Allergy Alert Type Text for a Patient
CreatedOnUTCDateTime	DateTime	Yes	The DateTime (in UTC) of the time the patient was added.
DeliveryMethodComment	String	No	The Delivery Method Comment
DeliveryZoneID	Guid	No	The Delivery Zone ID
DeliveryZoneText	String	No	The Delivery Zone Text
DeliveryPaymentTypeEnum	Int	No	The Delivery Payment Type Enum
DeliveryPaymentTypeText	String	No	The Delivery Payment Type Text
PrimaryCategory	String	No	The Patient’s Primary Category

AnimalOwner

{
  "Identification":{...},
  "Name":{...},
  "Addresses":[...],
  "PhoneNumbers":[...],
  "PrimaryPhoneSequenceNumber":1,
  "RxNotifyPhoneSequenceNumber":1,
  "RxNotifyProviderTypeID":4,
  "RxNotifyProviderTypeText":"Sprint",
  "RxNotifyTypeID":3,
  "RxNotifyTypeText":"Text",
  "EZOpenRequested":0,
  "HasAnimalOwnerReceivedNopp":1,
  "HeightInches":72,
  "WeightOunces":2400,
  "IsAnimal":0,
  "HipaaStatusTypeID":2,
  "HipaaStatusTypeText":"Signed",
  "Email":"test@test.com",
  "Gender":"M",
  "LanguageText":"English",
  "LanguageCode":"en",
  "LanguageTypeID":1,
  "DateOfBirth":"1983-04-19",
  "AutoFillModeTypeID":2,
  "AutoFillModeTypeText":"Auto Renew",
  "DeliveryMethodTypeID":"1",
  "DeliveryMethodText":"UPS",
  "AnimalOwnerPrimaryPrescriberPioneerRxID":"94043A8D-D09A-439C-A09A-ABC46E06FD66",
  "HealthCoachEmployeePioneerRxID":"985BC7B5-A96E-4AA2-A760-E816605EA33E",
  "SyncStatusTypeID":2,
  "SyncStatusTypeText":"Enrolled",
  "SyncDate":"2016-11-04",
  "CallDate":"2016-12-01",
  "NextPickupDate":"2016-12-04",
  "Comments":{...},
  "Categories":[...],
  "PrimaryCategory":"Diabetic",
  "Allergies":[...],
  "OtherMedications":[...],
  "ChangedOnUTC":"2016-07-29T14:31:45.667Z",
  "AnimalOwnerRiskScore":"77",
  "AnimalOwnerMultidose":"0",
  "AnimalOwnerPioneerRxID":"58828136-8d3f-4307-bca2-89b1d9ae9bb9",
  "AlertTypeID":"3",
  "AlertTypeText":"Custom",
  "AlertCustomText":"Custom Text Here",
  "AllergyAlertTypeID":"0",
  "AllergyAlertTypeText":"ASK FOR ALLERGIES?",
  "CreatedOnUTCDateTime":"2012-03-07T10:21:08.627Z",
  "DeliveryMethodComment":"Delivery Method Comment"


}

<AnimalOwner>
  <Identification>...</Identification>
  <Name>...</Name>
  <Addresses>
    <Address>...</Address>
  </Addresses>
  <PhoneNumbers>
    <PhoneNumber>...</PhoneNumber>
  </PhoneNumbers>
  <PrimaryPhoneSequenceNumber>1</PrimaryPhoneSequenceNumber>
  <RxNotifyPhoneSequenceNumber>1</RxNotifyPhoneSequenceNumber>
  <RxNotifyProviderTypeID>4</RxNotifyProviderTypeID>
  <RxNotifyProviderTypeText>Sprint</RxNotifyProviderTypeText>
  <RxNotifyTypeID>3</RxNotifyTypeID>
  <RxNotifyTypeText>Text</RxNotifyTypeText>
  <EZOpenRequested>0</EZOpenRequested>
  <HasAnimalOwnerReceivedNopp>1</HasAnimalOwnerReceivedNopp>
  <HeightInches>72</HeightInches>
  <WeightOunces>2400</WeightOunces>
  <IsAnimal>0</IsAnimal>
  <HipaaStatusTypeID>2</HipaaStatusTypeID>
  <HipaaStatusTypeText>Signed</HipaaStatusTypeText>
  <Email>test@test.com</Email>
  <Gender>M</Gender>
  <LanguageTypeID>1</LanguageTypeID>
  <LanguageText>English</LanguageText>
  <LanguageCode>en</LanguageCode>
  <DateOfBirth>1983-04-19</DateOfBirth>
  <AutoFillModeTypeID>2</AutoFillModeTypeID>
  <AutoFillModeTypeText>Auto Renew</AutoFillModeTypeText>
  <DeliveryMethodTypeID>1<DeliveryMethodTypeID>
  <DeliveryMethodText>UPS</DeliveryMethodText>
  <AnimalOwnerPrimaryPrescriberPioneerRxID>94043A8D-D09A-439C-A09A-ABC46E06FD66</AnimalOwnerPrimaryPrescriberPioneerRxID>
  <HealthCoachEmployeePioneerRxID>985BC7B5-A96E-4AA2-A760-E816605EA33E</HealthCoachEmployeePioneerRxID>
  <SyncStatusTypeID>2</SyncStatusTypeID>
  <SyncStatusTypeText>Enrolled</SyncStatusTypeText>
  <SyncDate>2016-11-04</SyncDate>
  <CallDate>2016-12-01</CallDate>
  <NextPickupDate>2016-12-04</NextPickupDate>
  <Comments>...</Comments>
  <Categories>
    <Category>...</Category>
  </Categories>
  <PrimaryCategory>Diabetic</PrimaryCategory>
  <Allergies>
    <Allergy>...</Allergy>
  </Allergies>
  <OtherMedications>
    <Medication>...</Medication>
  </OtherMedications>
  <ChangedOnUTC>2016-07-29T14:31:45.667Z</ChangedOnUTC>
  <AnimalOwnerRiskScore>77</AnimalOwnerRiskScore>
  <AnimalOwnerMultidose>0</AnimalOwnerMultidose>
  <AnimalOwnerPioneerRxID>58828136-8d3f-4307-bca2-89b1d9ae9bb9</AnimalOwnerPioneerRxID>
  <AlertTypeID>3</AlertTypeID>
  <AlertTypeText>Custom</AlertTypeText>
  <AlertCustomText>Custom Text Here</AlertCustomText>
  <AllergyAlertTypeID>0</AllergyAlertTypeID>
  <AllergyAlertTypeText>ASK FOR ALLERGIES?</AllergyAlertTypeText>
  <CreatedOnUTCDateTime>2012-03-07T10:21:08.627Z</CreatedOnUTCDateTime>
  <DeliveryMethodComment>Delivery Method Comment</DeliveryMethodComment>
</AnimalOwner>

Field	DataType	Always Present	Values / Description
Identification	Animal Owner Identification	Yes	A Data Object that gives various IDs that represent the Animal Owner.
Name	Name	Yes	Animal Owner’s Name
Addresses	Address List	No	A List of Addresses for the Animal Owner
PhoneNumbers	Phone Number List	No	A List of Phone Numbers for the Animal Owner
PrimaryPhoneSequenceNumber	Int	No	The sequence number for the primary phone number for the Animal Owner
RxNotifyPhoneSequenceNumber	Int	No	The sequence number for the notify phone number for the Animal Owner
RxNotifyProviderTypeID	Enum(Int)	No	The provider type for Rx Notify SMS Messages (Carriers) (See table below)
RxNotifyProviderTypeText	String	No	The text description for the RxNotifyProviderTypeID
RxNotifyTypeID	Enum(Int)	No	A type to show what the preference of the Animal Owner is with regards to notifications (See table below)
RxNotifyTypeText	String	No	The text description for the RxNotifyTypeID
EZOpenRequested	Int	Yes	A flag to show if a Animal Owner prefers Easy Open Bottles (0 = No, 1 = Yes)
HasAnimal OwnerReceivedNopp	Int	Yes	A flag to show if a Animal Owner has Received an NOPP (0 = No, 1 = Yes)
HeightInches	Int	No	Animal Owner’s Height in Inches
WeightOunces	Int	No	Animal Owner’s Weight in Ounces
IsAnimal	Int	No	A flag to show if a Animal Owner is an Animal (0 = No, 1 = Yes)
HipaaStatusTypeID	Int	No	Animal Owner’s HIPAA Status Type ID 1-Good Faith Effort 2-Signed 3-Print and Sign
HipaaStatusTypeText	String	No	Animal Owner’s HIPAA Status Type Text
Email	String	No	Animal Owner’s Email Address
Gender	String	No	Animal Owner’s Gender (M = Male, F = Female)
LanguageText	String	No	Animal Owner’s Prefered Language Text, this is the human readable version of LanguageCode below
LanguageCode	String	No	Animal Owner’s Prefered Language Code en-English sp-Spanish 3
LanguageTypeID	Int	No	Animal Owner’s Prefered Language Code 1-English 2-Spanish 3 + are dynamic and set by the pharmacy
DateOfBirth	Date	No	Animal Owner’s Date of Birth
AutoFillModeTypeID	Int	No	Animal Owner’s Auto Fill Mode Type ID 0-Ask Animal Owner? 1-Auto Fill 2-Auto Renew 3-Not Used 10-Declined
AutoFillModeTypeText	String	No	Animal Owner’s Auto Fill Mode Type Text
DeliveryMethodTypeID	Enum	Animal Owner’s Prefered Delivery Method ID (See Table Below)
DeliveryMethodText	String	No	A text description for the DeliverMethodTypeID
AnimalOwnerPrimaryPrescriberPioneerRxID	Guid	No	The Animal Owner’s Primary Prescriber Internal PioneerRx ID
HealthCoachEmployeePioneerRxID	Guid	No	The Animal Owner’s Health Coach Employee Internal PioneerRx ID
SyncStatusTypeID	Int	No	Animal Owner’s Sync Status Type ID 0-Not Enrolled 1-Recommended 2-Enrolled 3-Declined 4-Not Recommended
SyncStatusTypeText	String	No	Animal Owner’s Sync Status Type Text
SyncDate	Date	No	Sync Pickup Date
CallDate	Date	No	Next Sync Call Date
NextPickupDate	Date	No	Next Sync Pickup Date
Comments	Animal Owner Comments	No	Internal Pharmacy Comments about the Animal Owner
Categories	Category	No	List of Animal Owner’s Categories
PrimaryCategory	String	No	Animal Owner’s Primary Category
Allergies	Allergy	No	A List of Animal Owner Allergies
OtherMedications	Medication	No	A List of Animal Owner Medications
ChangedOnUTC	DateTime	Yes	The DateTime (in UTC) of the last time this data object was edited
AnimalOwnerRiskScore	String	No	The PioneerRx Animal Owner Risk Score
AnimalOwnerMultidose	Int	Yes	Animal Owner’s Multidose Flag
AnimalOwnerPioneerRxID	Guid	No	The PioneerRx ID of the Animal Owner
AlertTypeID	Int	No	The Alert Type ID for a Animal Owner (See Table Below)
AlertTypeText	String	No	Alert Type Text for a Animal Owner
AlertCustomText	String	No	Custom Alert Text for a Animal Owner
AllergyAlertTypeID	Int	No	Allergy Alert Type ID for a Animal Owner
AllergyAlertTypeText	String	No	Allergy Alert Type Text for a Animal Owner
CreatedOnUTCDateTime	DateTime	Yes	The DateTime (in UTC) of the time the Animal Owner was added.
DeliveryMethodComment	String	No	The Delivery Method Comment

RxNotify Provider Type ID

RxNotify Provider Type ID	Description
0	Custom
1	T-Mobile
2	Virgin Mobile
3	ATT
4	Sprint
5	Verizon
8	Boost
9	MetroPCS
10	Cricket
11	US Cellular
12	Viaero
13	Net10
14	Cellular One
15	Blue Grass Cellular
16	Northwest Missouri Cell
17	AIO Wireless
18	Pioneer Wireless
19	Thumb Cellular
20	CSpire
21	Carolina West
22	AIO/Cricket MMS

RxNotify Type ID

RxNotify Type ID	Description
1	Ask Patient? (patient has not yet indicated their choice)
2	Do not notify
3	Text (aka SMS)
4	Email, Text
5	IVR (Phone only)
6	Email,IVR
7	IVR, Text
8	Email, IVR, Text

Patient Alert Type ID

Alert Type ID	Description
1	See Pharmacist
2	Call Doctor
3	Custom
4	Visit Doctor

Patient Identification

{
  "PatientPioneerRxID":"E4109AAD-ACE2-494B-9A75-1B22B156665F",
  "SSN":"123456789",
  "DriverLicenseNumber":"9087654",
  "DriversLicenseStateCode":"LA",
  "AlternateID":"1232432",
  "AlternateIDTypeID":1,
  "AlternateIDTypeText":"MilitaryID",
  "ExternalID":"123456",
  "CentralKey":"12345",
  "SerialNumberPerson":456789
}

<Identification>
  <PatientPioneerRxID>E4109AAD-ACE2-494B-9A75-1B22B156665F</PatientPioneerRxID>
  <SSN>123456789</SSN>
  <DriverLicenseNumber>9087654</DriverLicenseNumber>
  <DriversLicenseStateCode>LA</DriversLicenseStateCode>
  <AlternateID>1232432</AlternateID>
  <AlternateIDTypeID>1</AlternateIDTypeID>
  <AlternateIDTypeText>MilitaryID</AlternateIDTypeText>
  <ExternalID>123456</ExternalID>
  <CentralKey>12345</CentralKey>
  <SerialNumberPerson>456789</SerialNumberPerson>
</Identification>

Field	DataType	Always Present	Values / Description
PatientPioneerRxID	Guid	Yes	The internal PioneerRx Patient ID
SSN	String	No	The Patient’s Social Security Number
DriverLicenseNumber	String	No	The Patient’s Driver’s License Number
DriversLicenseStateCode	String	No	The Patient’s Driver’s License State Code
AlternateID	String	No	The Patient’s Alternate ID
AlternateIDTypeID	Int	No	The Patient’s Alternate ID Type ID (see table below)
AlternateIDTypeText	String	No	The Patient’s Alternate ID Type Text
ExternalID	String	No	The Patient’s External ID
CentralKey	Int	No	The Patient’s Central Key
SerialNumberPerson	Int	No	The Patient’s Serial Number

Animal Owner Identification

{
  "AnimalOwnerPioneerRxID":"E4109AAD-ACE2-494B-9A75-1B22B156665F",
  "SSN":"123456789",
  "DriverLicenseNumber":"9087654",
  "DriversLicenseStateCode":"LA",
  "AlternateID":"1232432",
  "AlternateIDTypeID":1,
  "AlternateIDTypeText":"MilitaryID",
  "ExternalID":"123456",
  "CentralKey":"12345",
  "SerialNumberPerson":456789
}

<Identification>
  <AnimalOwnerPioneerRxID>E4109AAD-ACE2-494B-9A75-1B22B156665F</PatientPioneerRxID>
  <SSN>123456789</SSN>
  <DriverLicenseNumber>9087654</DriverLicenseNumber>
  <DriversLicenseStateCode>LA</DriversLicenseStateCode>
  <AlternateID>1232432</AlternateID>
  <AlternateIDTypeID>1</AlternateIDTypeID>
  <AlternateIDTypeText>MilitaryID</AlternateIDTypeText>
  <ExternalID>123456</ExternalID>
  <CentralKey>12345</CentralKey>
  <SerialNumberPerson>456789</SerialNumberPerson>
</Identification>

Field	DataType	Always Present	Values / Description
AnimalOwnerPioneerRxID	Guid	Yes	The internal PioneerRx Animal Owner ID
SSN	String	No	The Animal Owner’s Social Security Number
DriverLicenseNumber	String	No	The Animal Owner’s Driver’s License Number
DriversLicenseStateCode	String	No	The Animal Owner’s Driver’s License State Code
AlternateID	String	No	The Animal Owner’s Alternate ID
AlternateIDTypeID	Int	No	The Animal Owner’s Alternate ID Type ID (see table below)
AlternateIDTypeText	String	No	The Animal Owner’s Alternate ID Type Text
ExternalID	String	No	The Animal Owner’s External ID
CentralKey	Int	No	The Animal Owner’s Central Key
SerialNumberPerson	Int	No	The Animal Owner’s Serial Number

Alternate ID Type

Alternate ID Type	Description
0	Other
1	MilitaryID
2	Other State Issued ID
3	Passport ID
4	Permanent Resident Card
10	SSN
11	Driver’s License

Medication Synchronization Contact Method ID

Contact Method ID	Description
3	Future Fill
4	Auto Refill
5	IVR
6	Rx Local
7	Intake
8	Escript
9	Batch Fill
10	Facility Cycle Fill
11	Unknown
12	Retail Cycle Fill
13	Data Entry
14	Rx Resupply
15	App

Patient Comments

{
  "Informational":"Comments about Patient that are non-critical",
  "Critical":"Critical Comments that are presented with more emphasis in the software",
  "PointOfSale":"Comments that show at the PioneerRx POS to the POS Clerk",
  "LatestMTMComment":"The last MTM Comment that is recorded"
}

<Comments>
  <Informational>Comments about Patient that are non-critical</Informational>
  <Critical>Critical Comments that are presented with more emphasis in the software</Critical>
  <PointOfSale>Comments that show at the PioneerRx POS to the POS Clerk</PointOfSale>
  <LatestMTMComment>The last MTM Comment that is recorded</LatestMTMComment>
</Comments>

Field	DataType	Always Present	Values / Description
Informational	String	No	Internal Pharmacy Informational Comments about the Patient
Critical	String	No	Internal Pharmacy Critical Comments about the Patient
PointOfSale	String	No	Internal Pharmacy Point of Sale Comments about the Patient
LatestMTMComment	String	No	The latest MTM Comment for the Patient

Animal Owner Comments

{
  "Informational":"Comments about Animal Owner that are non-critical",
  "Critical":"Critical Comments that are presented with more emphasis in the software",
  "PointOfSale":"Comments that show at the PioneerRx POS to the POS Clerk",
  "LatestMTMComment":"The last MTM Comment that is recorded"
}

<Comments>
  <Informational>Comments about Animal Owner that are non-critical</Informational>
  <Critical>Critical Comments that are presented with more emphasis in the software</Critical>
  <PointOfSale>Comments that show at the PioneerRx POS to the POS Clerk</PointOfSale>
  <LatestMTMComment>The last MTM Comment that is recorded</LatestMTMComment>
</Comments>

Field	DataType	Always Present	Values / Description
Informational	String	No	Internal Pharmacy Informational Comments about the Animal Owner
Critical	String	No	Internal Pharmacy Critical Comments about the Animal Owner
PointOfSale	String	No	Internal Pharmacy Point of Sale Comments about the Animal Owner
LatestMTMComment	String	No	The latest MTM Comment for the Animal Owner

Category

{
  "Category":"Diabetic"
}

<Category>Diabetic</Category>

Field	DataType	Always Present	Values / Description
Category	String	No	Patient’s Category

Allergy

{
  "Description":"Zinc",
  "MedicationID":"574076",
  "MedicationIDType":"FDB"
}

<Allergy>
  <Description>Zinc</Description>
  <MedicationID>574076</MedicationID>
  <MedicationIDType>FDB</MedicationIDType>
</Allergy>

Field	DataType	Always Present	Values / Description
Description	String	No	Allergy Description
MedicationID	String	No	Allergy Medication ID
MedicationIDType	Enum(String)	No	FDB GoldStandard RxNorm

Medication

{
  "RxNumber":"2341",
  "LastDateFilledUTC":"2016-07-29T14:31:45.667Z",
  "RefillsRemaining":1,
  "DaysSupply":30,
  "ExternalPharmacyID":"F11ADC67-892F-4686-8256-000616D24A07",
  "PrescriberID":"E8C3D9EE-41C2-4DF9-A77B-D159009E50C5",
  "NDC":"00093761356",
  "MedicationName":"Aripiprazole Tab 2 Mg 30 Teva"
}

<Medication>
  <RxNumber>2341</RxNumber>
  <LastDateFilledUTC>2016-07-29T14:31:45.667Z</LastDateFilledUTC>
  <RefillsRemaining>1</RefillsRemaining>
  <DaysSupply>30</DaysSupply>
  <ExternalPharmacyID>F11ADC67-892F-4686-8256-000616D24A07</ExternalPharmacyID>
  <PrescriberID>E8C3D9EE-41C2-4DF9-A77B-D159009E50C5</PrescriberID>
  <NDC>00093761356</NDC>
  <MedicationName>Aripiprazole Tab 2 Mg 30 Teva</MedicationName>
</Medication>

Field	DataType	Always Present	Values / Description
RxNumber	String	No	The Medication’s Rx Number
LastDateFilledUTC	DateTime	No	The Medication’s Last Date (In UTC) Filled
RefillsRemaining	Int	No	The Medication’s Remainng Refills
DaysSupply	Int	No	The Medication’s Days Supply
ExternalPharmacyID	Guid	No	The Medication’s Pharmacy
PrescriberID	Guid	No	The Medication’s Prescriber
NDC	String	No	The Medication’s Drug NDC
MedicationName	String	No	The Medication’s Drug Name

Facility

{
  "Identification":{...},
  "Name":"Facility Name",
  "Addresses":[...],
  "PhoneNumbers":[...],
  "PrimaryPhoneSequenceNumber":1,
  "PatientAdmittedOnDateTime":"2016-07-29T14:31:45.667Z",
  "PatientDischargedOnDateTime":"2016-07-30T14:31:45.667Z",
  "FacilityTypeID":"FEDE5EE6-F5A3-4112-9508-2982053263D0",
  "FacilityTypeText":"ICF/IID",
  "WingPioneerRxID":"D54E1959-77D0-4C71-B956-509D127EDE1C",
  "WingName":"B",
  "RoomNumber":"254",
  "Bed":"87",
  "Email":"test@test.com",
  "Comments":{...},
  "ChangedOnUTC":"2016-07-30T14:31:45.667Z"
}

<Facility>
  <Identification>...</Identification>
  <Name>Facility Name</Name>
  <Addresses>
    <Address>...</Address>
  </Addresses>
  <PhoneNumbers>
    <PhoneNumber>...</PhoneNumber>
  </PhoneNumbers>
  <PrimaryPhoneSequenceNumber>1</PrimaryPhoneSequenceNumber>
  <PatientAdmittedOnDateTime>2016-07-29T14:31:45.667Z</PatientAdmittedOnDateTime>
  <PatientDischargedOnDateTime>2016-07-30T14:31:45.667Z</PatientDischargedOnDateTime>
  <FacilityTypeID>FEDE5EE6-F5A3-4112-9508-2982053263D0</FacilityTypeID>
  <FacilityTypeText>ICF/IID</FacilityTypeText>
  <WingPioneerRxID>D54E1959-77D0-4C71-B956-509D127EDE1C</WingPioneerRxID>
  <WingName>B</WingName>
  <RoomNumber>254</RoomNumber>
  <Bed>87</Bed>
  <Email>test@test.com</Email>
  <Comments>...</Comments>
  <ChangedOnUTC>2016-07-30T14:31:45.667Z</ChangedOnUTC>
</Facility>

Field	DataType	Always Present	Values / Description
Identification	Facility Identification	Yes	A Data Object that gives various IDs that represent the Facility
Name	String	Yes	The Facility’s Name
Addresses	Address List	No	A List of Addresses for the Facilty
PhoneNumbers	Phone Number List	No	A List of Phone Numbers for the Facility
PrimaryPhoneSequenceNumber	Int	No	The sequence number for the primary phone number for the Facility
PatientAdmittedOnDateTime	DateTime	No	The date the Patient was Admitted into the Facility
PatientDischargedOnDateTime	DateTime	No	the date the Patient was Discharged from the Facility
FacilityTypeID	Guid	No	Facility Type ID (see table below)
FacilityTypeText	String	No	Facility Type Text
WingPioneerRxID	Guid	No	Internal PioneerRx ID for the Facility Wing
WingName	String	No	The Patient’s Wing Name at the Facility.
RoomNumber	String	No	The Patient’s Room Number at the Facility.
Bed	String	No	The Patient’s Bed at the Facility.
Email	String	No	The Facilty’s Email Address
Comments	Facility Comments	No	Internal Pharmacy Comments about the Facility
ChangedOnUTC	DateTime	Yes	The DateTime (in UTC) of the last time this data object was edited

Facility Type ID

Facility Type ID	Description
FEDE5EE6-F5A3-4112-9508-2982053263D0	ICF/IID
8793872F-B925-4E75-B068-3F217B1BCDFB	Boys Home
2CD32E79-4955-4A89-ADEC-461202F61640	Assisted Living
AEBA2D3F-C1E6-4BC1-9F51-530C7221586D	Other
0365632C-B3ED-4E22-8337-6176F8610026	Mental Health
C9D05A3F-91D8-47E2-8081-7AB96070BB13	Hospice
9A7D8A7B-76C6-4900-A0F7-7DDE80475304	Dialysis Clinic
A2B3CB6F-608A-4C88-A662-832B23638FD8	Girls Home
ED58C461-D278-4609-AA33-B217C4E4CFDC	Jail
DD039C5C-223B-4856-B918-C56DB644F732	Rehab
62CB5AE2-69FC-4E91-88E4-C74A757D23E7	Group Home
9F79FD4B-C06C-4D5B-9CC3-F53CDA48261D	Nursing Home

Facility Identification

{
  "GroupCode":"AF",
  "FacilityPioneerRxID":"BFA1A8C5-70A6-4355-81B9-E64A8F6BD169"
}

<Identification>
  <GroupCode>AF</GroupCode>
  <FacilityPioneerRxID>BFA1A8C5-70A6-4355-81B9-E64A8F6BD169</FacilityPioneerRxID>
</identification>

Field	DataType	Always Present	Values / Description
GroupCode	String	No	A Facility Group Code
FacilityPioneerRxID	Guid	No	The internal PioneerRx ID for a Facility

Facility Comments

{
  "Informational":"Comments about the Facility that are non-critical",
  "Critical":"Critical Comments that are presented with more emphasis in the software",
  "PointOfSale":"Comments that show at the PioneerRx POS to the POS Clerk"
}

<Comments>
  <Informational>Comments about the Facility that are non-critical</Informational>
  <Critical>Critical Comments that are presented with more emphasis in the software</Critical>
  <PointOfSale>Comments that show at the PioneerRx POS to the POS Clerk</PointOfSale>
</Comments>

Field	DataType	Always Present	Values / Description
Critical	String	No	Critical Comments about the Facility
Informational	String	No	Information Comments about the Facility
PointOfSale	String	No	Point of Sale Comments about the Facility

Rx

{
  "WrittenByPrescriberPioneerRxID":"075AC36C-A8FD-4C16-8226-619CDC8FDA52",
  "WrittenBySupervisorPrescriberPioneerRxID":"DC16796F-82CD-4261-8B6D-A196CD015032",
  "RxNumber":12345,
  "RefillNumber":1,
  "RxPioneerRxID":"89E30A3F-7182-48A1-AF92-A328F15FE5D5",
  "RxFillTransactionPioneerRxID":"BAF0C1EF-E56D-4644-ADEF-77AE499F7BF3",
  "ScriptType":"Refill",
  "PreviousRxNumber":123,
  "PrescriberOrderNumber":"412351235",
  "MedicationPrescribed":{...},
  "MedicationDispensed":{...},
  "CurrentRxStatusID":1,
  "CurrentRxStatusText":"Fill in Progress",
  "RxStatusChangedOnDateTimeUTC":"2016-07-29T14:31:45.667Z",
  "CurrentRxTransactionStatusID":1,
  "CurrentRxTransactionStatusText":"Waiting for Data Entry",
  "RxTransactionStatusChangedOnDateTimeUTC":"2016-07-29T14:31:45.667Z",
  "PreviousDateTimeFilled":"2016-07-29T14:31:45.667Z",
  "OriginTypeID":1,
  "OriginTypeText":"Walk-In",
  "DateFilledUTC":"2016-07-29T14:31:45.667Z",
  "ExpirationDate":"2016-07-29",
  "DawCodeID":1,
  "DawCodeText":"Substitution Not Allowed by Prescriber",
  "DaysSupply":30,
  "QuantityRemaining":900,
  "NumberOfRefillsAllowed":10,
  "NumberofRefillsFilled":2,
  "RefillsRemaining":2,
  "FutureFill":0,
  "AllowPartialFills":0,
  "DiagnosisCodes":[...],
  "PrimaryDiagnosisSequenceNumber":1,
  "SecondaryDiagnosisSequenceNumber":2,
  "TertiaryDiagnosisSequenceNumber":3,
  "SigCode":"t1t 1d",
  "DirectionsTranslatedEnglish":"TAKE ONE TABLET ONCE DAILY",
  "DirectionsTranslatedOtherLanguage":"TOMAR UNA TABLETA UNA VEZ DIARIAMENTE",
  "IsCycleFill":0,
  "IsPrn":0,
  "DrugUseTypeID":1,
  "DrugUseTypeText":"DrugUseText",
  "PriorityTypeID":1,
  "PriorityTypeText":"Waiting",
  "PromiseTimeUTC":"2013-08-20 16:00:00.000Z",
  "Comments":{...},
  "CompletedDate":"2016-07-29",
  "TrackingNumber":"37487487474874784",
  "PharmacistPioneerRxID":"2B8DBC85-BEAC-48F1-AE85-DDB000C8979F",
  "CheckedByPharmacistEmployeeID":"2B8DBC85-BEAC-48F1-AE85-DDB000C8979F",
  "ChangedOnUTC":"2016-07-29T14:31:45.667Z",
  "IngredientCostSubmitted":0.7400,
  "IngredientCostPaid":0.6660,
  "DispensingFeeSubmitted":11.5000,
  "DispensingFeePaid":1.0000,
  "TaxRateSubmitted":0.000000,
  "TaxRatePaid":0.000000,
  "TaxAmountSubmitted":0.0000,
  "TaxAmountPaid":0.0000,
  "FlatSalesTaxAmount":0.0000,
  "TotalPriceSubmitted":12.2400,
  "TotalPricePaid":1.6700,
  "UsualCustomaryPrice":12.2400,
  "UsualCustomaryPricePaid":0.0000,
  "AcquisitonCost":0.1100,
  "PatientPaidAmount":0.0000,
  "ExternalScheduleName":ScheduleName,
  "StartDate":2018-01-03T00:00:00,
  "EndDate":2018-02-15T00:00:00,
  "DataEntryByPioneerRxID":"604dbdd5-2833-43d9-ae5c-91670ef76527",
  "FilledByPioneerRxID":"6b6fc130-55a6-4ed7-b0db-e3c2ec1fe1fe",
  "PreviousDispensedNDC":"04852545026",
  "AutoRefill":"0",
  "BasePriceScheduleName":"Cost + $5",
  "RenewalIndicator":"R",
  "DirFeeTotal":0.0000,
  "PrescriptionLabelBarcode":"X018471206",
  "MPR":0.908163,
  "PDC":90.816300,
  "GAP":0,
  "PriorityCategoryTypeID":3,
  "PriorityCategoryTypeText":"Delivery",
  "MedsOnCueURL":"https://hub.medsoncue.com/qrc/MrlMMsRnKjS6-648215976/m_642951",
  "ExcludeFromMAR":1,
  "ExcludeFromMARTypeText":"Exclude Always",
  "RxFillRequestedMethodTypeID": "12",
  "RxFillRequestedMethodTypeText":"Retail Cycle Fill",
  "BinLocationTypeID" : 0,
  "BinLocationTypeText" : "Will Call",
  "BinLocationID" : "00000000-0000-0000-0000-000000000000",
  "BinLocationName" : "",
  "PrecheckedByID": "6b6fc130-55a6-4ed7-b0db-e3c2ec1fe1fe",
  "DataEnteredDateTime": "2016-07-29T14:31:45.667Z",
  "PayMethods":[...]

}

<Rx>
  <WrittenByPrescriberPioneerRxID>"075AC36C-A8FD-4C16-8226-619CDC8FDA52"</WrittenByPrescriberPioneerRxID>
  <WrittenBySupervisorPrescriberPioneerRxID>DC16796F-82CD-4261-8B6D-A196CD015032</WrittenBySupervisorPrescriberPioneerRxID>
  <RxNumber>12345</RxNumber>
  <RefillNumber>1</RefillNumber>
  <RxPioneerRxID>89E30A3F-7182-48A1-AF92-A328F15FE5D5</RxPioneerRxID>
  <RxFillTransactionPioneerRxID>BAF0C1EF-E56D-4644-ADEF-77AE499F7BF3</RxFillTransactionPioneerRxID>
  <ScriptType>Refill</ScriptType>
  <PreviousRxNumber>123</PreviousRxNumber>
  <PrescriberOrderNumber>412351235</PrescriberOrderNumber>
  <MedicationPrescribed>...</MedicationPrescribed>
  <MedicationDispensed> ...</MedicationDispensed>
  <CurrentRxStatusID>1</CurrentRxStatusID>
  <CurrentRxStatusText>Fill in Progress</CurrentRxStatusText>
  <RxStatusChangedOnDateTimeUTC>2016-07-29T14:31:45.667Z</RxStatusChangedOnDateTimeUTC>
  <CurrentRxTransactionStatusID>1</CurrentRxTransactionStatusID>
  <CurrentRxTransactionStatusText>Waiting for Data Entry</CurrentRxTransactionStatusText>
  <RxTransactionStatusChangedOnDateTimeUTC>2016-07-29T14:31:45.667Z</RxTransactionStatusChangedOnDateTimeUTC>
  <PreviousDateTimeFilled>2016-07-29T14:31:45.667Z</PreviousDateTimeFilled>
  <OriginTypeID>1</OriginTypeID>
  <OriginTypeText>Walk-In</OriginTypeText>
  <DateFilledUTC>2016-07-29T14:31:45.667Z</DateFilledUTC>
  <ExpirationDate>2016-07-29</ExpirationDate>
  <DawCodeID>1</DawCodeID>
  <DawCodeText>Substitution Not Allowed by Prescriber</DawCodeText>
  <DaysSupply>30</DaysSupply>
  <QuantityRemaining>900</QuantityRemaining>
  <NumberOfRefillsAllowed>10</NumberOfRefillsAllowed>
  <NumberofRefillsFilled>2</NumberofRefillsFilled>
  <RefillsRemaining>2</RefillsRemaining>
  <FutureFill>0</FutureFill>
  <AllowPartialFills>0<AllowPartialFills>
  <DiagnosisCodes>
    <DiagnosisCode>...</DiagnosisCode>
  </DiagnosisCodes>
  <PrimaryDiagnosisSequenceNumber>1</PrimaryDiagnosisSequenceNumber>
  <SecondaryDiagnosisSequenceNumber>2</SecondaryDiagnosisSequenceNumber>
  <TertiaryDiagnosisSequenceNumber>3</TertiaryDiagnosisSequenceNumber>
  <SigCode>t1t 1d</SigCode>
  <DirectionsTranslatedEnglish>TAKE ONE TABLET ONCE DAILY</DirectionsTranslatedEnglish>
  <DirectionsTranslatedOtherLanguage>TOMAR UNA TABLETA UNA VEZ DIARIAMENTE</DirectionsTranslatedOtherLanguage>
  <IsCycleFill>0</IsCycleFill>
  <IsPrn>0</IsPrn>
  <DrugUseTypeID>1</DrugUseTypeID>
  <DrugUseTypeText>"Drug Use Text"</DrugUseTypeText>
  <PriorityTypeID>1</PriorityTypeID>
  <PriorityTypeText>Waiting</PriorityTypeText>
  <PromiseTimeUTC>2013-08-20 16:00:00.000Z</PromiseTimeUTC>
  <Comments>...</Comments>
  <CompletedDate>2016-07-29</CompletedDate>
  <TrackingNumber>37487487474874784</TrackingNumber>
  <PharmacistPioneerRxID>2B8DBC85-BEAC-48F1-AE85-DDB000C8979F</PharmacistPioneerRxID>
  <CheckedByPharmacistEmployeeID>2B8DBC85-BEAC-48F1-AE85-DDB000C8979F</CheckedByPharmacistEmployeeID>
  <ChangedOnUTC>2016-07-29T14:31:45.667Z</ChangedOnUTC>
  <IngredientCostSubmitted>0.7400</IngredientCostSubmitted>
  <IngredientCostPaid>0.6660</IngredientCostPaid>
  <DispensingFeeSubmitted>11.5000</DispensingFeeSubmitted>
  <DispensingFeePaid>1.0000</DispensingFeePaid>
  <TaxRateSubmitted>0.000000</TaxRateSubmitted>
  <TaxRatePaid>0.000000</TaxRatePaid>
  <TaxAmountSubmitted>0.0000</TaxAmountSubmitted>
  <TaxAmountPaid>0.0000</TaxAmountPaid>
  <FlatSalesTaxAmount>0.0000</FlatSalesTaxAmount>
  <TotalPriceSubmitted>12.2400</TotalPriceSubmitted>
  <TotalPricePaid>1.6700</TotalPricePaid>
  <UsualCustomaryPrice>12.2400</UsualCustomaryPrice>
  <UsualCustomaryPricePaid>0.0000</UsualCustomaryPricePaid>
  <AcquisitonCost>0.1100</AcquisitonCost>
  <PatientPaidAmount>0.0000</PatientPaidAmount>
  <ExternalScheduleName>ScheduleName</ExternalScheduleName>
  <StartDate>2018-01-03T00:00:00</StartDate>
  <EndDate>2018-02-15T00:00:00</EndDate>
  <DataEntryByPioneerRxID>2f3ea578-2238-4271-ad37-15ade1a6c842</DataEntryByPioneerRxID>
  <FilledByPioneerRxID>00000000-0000-0000-0000-000000000000</FilledByPioneerRxID>
  <PreviousDispensedNDC>00591557101</PreviousDispensedNDC>
  <AutoRefill>0</AutoRefill>
  <BasePriceScheduleName>Cost + $5</BasePriceScheduleName>
  <RenewalIndicator>R</RenewalIndicator>
  <DirFeeTotal>0.0000</DirFeeTotal>
  <PrescriptionLabelBarcode>X018471206</PrescriptionLabelBarcode>
  <MPR>0.908163</MPR>
  <PDC>90.816300></PDC>
  <GAP>0</GAP>
  <PriorityCategoryTypeID>3</PriorityCategoryTypeID>
  <PriorityCategoryTypeText>Delivery</PriorityCategoryTypeText>
  <MedsOnCueURL>https://hub.medsoncue.com/qrc/MrlMMsRnKjS6-648215976/m_642951</MedsOnCueURL>
  <ExcludeFromMAR>1</ExcludeFromMAR>
  <ExcludeFromMARTypeText>Exclude Always</ExcludeFromMARTypeText>
  <RxFillRequestedMethodTypeID>12</RxFillRequestedMethodTypeID>
  <RxFillRequestedMethodTypeText>Retail Cycle Fill</RxFillRequestedMethodTypeText>
  <BinLocationID>0</BinLocationID>
  <BinLocationName>Will Call</BinLocationName>
  <BinLocationTypeID>00000000-0000-0000-0000-000000000000</BinLocationTypeID>
  <BinLocationTypeText></BinLocationTypeText>
  <PrecheckedByID>6b6fc130-55a6-4ed7-b0db-e3c2ec1fe1fe</PrecheckedByID>
  <DateEnteredDateTime>2016-07-29T14:31:45.667Z</DateEnteredDateTime>
  <PayMethods>
    <PayMethod>...</PayMethod>
  </PayMethods>
</Rx>

Field	DataType	Always Present	Values / Description
WrittenByPrescriberPioneerRxID	Guid	No	Prescription’s Written By Internal PioneerRx Prescriber ID
WrittenBySupervisorPrescriberPioneerRxID	Guid	No	Prescription’s Writen By Supervisor’s Internal PioneerRx Prescriber ID
RxNumber	Int	Yes	The Rx Number
RefillNumber	Int	Yes	The Rx Refill Number
RxPioneerRxID	Guid	Yes	The Internal PioneerRx ID for the Rx
RxFillTransactionPioneerRxID	Guid	Yes	Internal PioneerRx ID for the Rx Transaction
ScriptType	String	Yes	The Rx Type: Original or Refill
PreviousRxNumber	Int	No	Previous Rx Number
PrescriberOrderNumber	String	No	Prescriber Order Number for the Rx
MedicationPrescribed	Medication Prescribed	No	Information regarding the Prescribed Medication for the Rx
MedicationDispensed	Medication Dispensed	No	Information regarding the Dispensed Medication for the Rx
CurrentRxStatusID	Enum(Int)	Yes	The Rx Current Status ID (see table below)
CurrentRxStatusText	String	Yes	The Rx Current Status Text
RxStatusChangedOnDateTimeUTC	DateTime	No	The DateTime of the last time this data object was edited
CurrentRxTransactionStatusID	Enum(Int)	No	The Rx Transaction Current Status ID (see table below)
CurrentRxTransactionStatusText	String	No	The Rx Transaction Current Status Text
RxTransactionStatusChangedOnDateTimeUTC	DateTime	No	The DateTime of the last time this data object was edited
PreviousDateTimeFilled	DateTime	No	The Previous Fill Date of this Rx
OriginTypeID	Enum(Int)	No	The Origin Type ID of the Rx (see table below)
OriginTypeText	String	No	The Origin Text ID of the Rx
DateFilledUTC	Date	No	The Date Filled of the Rx
ExpirationDate	Date	No	The Expiration Date of the Rx
DawCodeID	Int	No	The Dispense As Written (DAW) Product Selection Code ID for the Rx (see table below)
DawCodeText	String	No	The Dispense As Written (DAW) Product Selection Code Text for the Rx
DaysSupply	Int	No	The Days Supply for the Rx
QuantityRemaining	Decimal	No	The Quantity Remaining for the Rx
NumberOfRefillsAllowed	Int	No	The Number of Refills Allowed for the Rx
NumberofRefillsFilled	Int	No	The Number of Refills Filled for the Rx
RefillsRemaining	Int	No	The Number of Refills Remaining for the Rx
FutureFill	Int	No	Indicator if this is a future fill (0 = No, 1 = Yes)
AllowPartialFills	Int	No	Indicator if partial fills are allowed (0 = No, 1 = Yes)
DiagnosisCodes	Diagnosis List	No	List of Patient’s Diagnosis Codes associated with the Rx
PrimaryDiagnosisSequenceNumber	Int	No	The Sequence Number for the Primary Diagnosis Code for the Rx
SecondaryDiagnosisSequenceNumber	Int	No	The Sequence Number for the Secondary Diagnosis Code for the Rx
TertiaryDiagnosisSequenceNumber	Int	No	The Sequence Number for the Tertiary Diagnosis Code for the Rx
SigCode	String	No	The Sig Code for the Rx
DirectionsTranslatedEnglish	String	No	The English Translation of the Sig Code for the Rx
DirectionsTranslatedOtherLanguage	String	No	The (other) Language Translation of the Sig Code for the Rx
IsCycleFill	Int	No	Indicator if this is a Cycle Fill (0 = No, 1 = Yes)
IsPrn	Int	No	Indicator if this is Prn (0 = No, 1 = Yes)
DrugUseTypeID	Enum(Int)	No	The Drug Use Type ID for the Rx (see table below)
DrugUseTypeText	String	No	The Drug Use Type Text for the Rx
PriorityTypeID	Enum(Int)	No	The Priority Type ID for the Rx (see table below)
PriorityTypeText	String	No	The Priority Type Text for the Rx
PromiseTimeUTC	DateTime	No	The Promised Time for an Rx to be ready in UTC
Comments	Prescription Comments	No	Internal Pharmacy Comments about the Prescription
CompletedDate	DateTime	No	The DatetTime that the Rx was Completed
TrackingNumber	String	No	The Tracking number of a shipment
PharmacistPioneerRxID	Guid	No	The Internal PioneerRx Pharmacist ID associated with the Rx
CheckedByPharmacistEmployeeID	Guid	No	The Employee ID of the Pharmacist that Checked the Rx
ChangedOnUTC	DateTime	No	The DateTime (in UTC) of the last time this data object was edited
SpecialPackagingTypeID	Enum(Int)	No	The Special Packaging Type ID for the Rx (see table below)
SpecialPackagingTypeText	String	No	The Special Packaging Type text for the Rx
IngredientCostSubmitted	Decimal	No	The Ingredient Cost Submitted for the Rx
IngredientCostPaid	Decimal	No	The Ingredient Cost Paid for the Rx
DispensingFeeSubmitted	Decimal	No	The Dispensing Fee Submitted for the Rx
DispensingFeePaid	Decimal	No	The Dispensing Fee Paid for the Rx
TaxRateSubmitted	Decimal	No	The Tax Rate Submitted for the Rx
TaxRatePaid	Decimal	No	The Tax Rate Paid for the Rx
TaxAmountSubmitted	Decimal	No	The Tax Amount Submitted for the Rx
TaxAmountPaid	Decimal	No	The Tax Amountt Paid for the Rx
FlatSalesTaxAmount	Decimal	No	The Flat Sales Tax Amount for the Rx
TotalPriceSubmitted	Decimal	No	The Total Price Submitted for the Rx
TotalPricePaid	Decimal	No	The Total Price Paid for the Rx
UsualCustomaryPrice	Decimal	No	The Usual Customary Price for the Rx
UsualCustomaryPricePaid	Decimal	No	The Usual Customary Price Paid for the Rx
AcquisitonCost	Decimal	No	The Acquisition Cost for the Rx
PatientPaidAmount	Decimal	No	The Patient Paid Amount for the Rx
ExternalScheduleName	String	No	The external schedule name for a Mar
StartDate	DateTime	No	The Rx Start Date
EndDate	DateTime	No	The Rx Stop Date
DataEntryByPioneerRxID	Guid	No	The PioneerRx ID of the person that did Data Entry
FilledByPioneerRxID	Guid	No	The PioneerRx ID of the person that Filled the Rx
PreviousDispensedNDC	String	No	The Previous NDC that was dispensed
AutoRefill	Int	Yes	The Auto Refill Indicator (0 = No, 1 = Yes)
BasePriceScheduleName	String	No	The Base Price Schedule Name
RenewalIndicator	String	Yes	The Renewal Indicator (N = No, R = Yes)
DirFeeTotal	Decimal	No	The Dir Fee Total
PrescriptionLabelBarcode	String	No	The Barcode for the Rx
MPR	Decimal	No	The MPR for the Rx
PDC	Decimal	No	The PDC for the Rx
GAP	Decimal	No	The GAP for the Rx
PriorityCategoryTypeID	Int	No	The Priority Category Type ID 1-Waiting 2-Returning 3-Delivery 4-Shipment 5-Special Handling 6-Drive-Thru 7-Unknown 8-Partner Network
PriorityCategoryTypeText	String	No	The Priority Category Type Text of the Rx
MedsOnCueURL	String	No	The MedsOnCue URL
ExcludeFromMAR	Int	No	The Exclude From MAR Type ID 0-Include Always 1-Exclude Always 2-Exclude Packaging Device 3-Exclude MAR
ExcludeFromMARTypeText	String	No	The Exclude from MAR Type Text
RxFillRequestedMethodTypeID	Int	No	Rx Fill Requested Method Type (see table below)
RxFillRequestedMethodTypeText	String	No	Rx Fill Requested Method Type Text
BinLocationID	Int	No	The Bin Location ID of the Will Call bin that the RxTransaction is in at the time the message sent
BinLocationName	String	No	The Bin Location Name of the Will Call bin that the RxTransaction is in at the time the message sent
BinLocationTypeID	Guid	No	The Bin Location Type ID 1-Inventory 2-WillCall 3-Delivery 4-InProcess 5-Device
BinLocationTypeText	String	No	The Bin Location Type Text
PrecheckedByID	Guid	No	The ID of the Pharmacist that PreChecked the Rx
DateEnteredDateTime	No	The DateTime (in UTC) of the last time this data object was entered
PayMethods	Pay Methods List	No	List of Pay Methods used for the Rx

Current Rx Status ID

Current Rx Status ID	Description
1	Fill in Progress
2	Refills Remaining
3	Expired or No Refills
4	Discontinued
8	On Hold
9	Transferred
10	Deleted
11	Quantity Remaining
13	Fill Requested

Current Rx Transaction Status ID

Current Rx Transaction Status ID	Description
1	Waiting for Data Entry
2	Waiting for Pre-check
3	Waiting for Fill
4	Waiting for Check
5	To Be Put in Bin
6	Waiting for Pick up
7	Waiting for Delivery
8	Waiting to Transmit
9	Reject Third Party
10	Completed
11	Out for Delivery
12	Reversed
16	Cancelled
17	Waiting for Print

Origin Type ID

Origin Type ID	Description
1	Walk-In
2	Phone-In
3	Fax
4	Transfer-In
5	Electronic
6	Other - Pharmacy

DAW Code

DAW Code	Description
0	No Product Selection Indicated
1	Substitution Not Allowed by Prescriber
2	Substitution Allowed-Patient Requested Product Dispensed
3	Substitution Allowed-Pharmacist Selected Product Dispensed
4	Substitution Allowed-Generic Drug Not in Stock
5	Substitution Allowed-Brand Drug Dispensed
6	Override
7	Substitution Not Allowed-Brand Drug Mandated by Law
8	Substitution Allowed-Generic Drug Not Available in Marketplace
9	Substitution Allowed By Prescriber but Plan Requests Brand

Priority Type ID

Priority Type ID	Description
1	Waiting
2	Returning
3	Delivery
4	Shipment
5	Special Handling
6	Drive-Thru
7	Unknown
8	Partner Network

Medication Prescribed

{
  "DrugStrength":"20 mg",
  "NDC":"60505366403",
  "UPC":"36050536643",
  "GCN":"12312312312",
  "PioneerRxItemID":"E9F5AC8E-2656-4B6C-ABF5-094345B9A888",
  "DeaSchedule":0,
  "Quantity":30.00000,
  "UnitText":"EA",
  "LabelType":"Brand",
  "BrandName":"Paxil 20 Mg Tablet",
  "WrittenName":"Paxil 20 Mg Tablet",
  "GenericName":"Paroxetine Hcl 20 Mg Tablet"
}

<MedicationPrescribed>
  <DrugStrength>20 mg</DrugStrength>
  <NDC>60505366403</NDC>
  <UPC>36050536643</UPC>
  <GCN>12312312312</GCN>
  <PioneerRxItemID>E9F5AC8E-2656-4B6C-ABF5-094345B9A888</PioneerRxItemID>
  <DeaSchedule>0</DeaSchedule>
  <Quantity>30.00000</Quantity>
  <UnitText>EA</UnitText>
  <LabelType>Brand</LabelType>
  <BrandName>Paxil 20 Mg Tablet</BrandName>
  <WrittenName>Paxil 20 Mg Tablet</WrittenName>
  <GenericName>Paroxetine Hcl 20 Mg Tablet</GenericName>
</MedicationPrescribed>

Field	DataType	Always Present	Values / Description
DrugStrength	String	No	The Prescribed Medication’s Strength
NDC	String	No	The Prescribed Medication’s NDC (usually present, but will commonly be missing if compound or an OTC item)
UPC	String	No	The Prescribed Medication’s UPC
GCN	String	No	The Prescribed Medication’s GCN
PioneerRxItemID	Guid	No	The Prescribed Medication’s Internal PioneerRx ID
DeaSchedule	Int	No	The Prescribed Medication’s DEA Schedule 0 – No Schedule 2 – Schedule 2 3 – Schedule 3 4 – Schedule 4 5 – Schedule 5
Quantity	Decimal(15,5)	No	The Prescribed Medication’s Quantity
UnitText	Enum(String)	The Dispensed Medication’s Unit Text (EA, ML, GM)
LabelType	Enum(String)	No	The Prescribed Medication’s Label Type Generic Brand Compound
BrandName	String	No	The Prescribed Medication’s Brand Name
WrittenName	String	No	The Prescribed Medication’s Written Name
GenericName	String	No	The Prescribed Medication’s Generic Name

Medication Dispensed

{
  "DrugStrength":"20 mg",
  "NDC":"68382009805",
  "UPC":"36838209805",
  "GCN":"12312312312",
  "PioneerRxItemID":"CCD7491A-020E-4199-95F1-E0C20BFF4D6A",
  "DeaSchedule":0,
  "PartialFillDueDate":"2017-11-01",
  "PartialFillSatisfiedDate":"2017-11-01",
  "PartialFillSatisfiedByPersonID": "CCD7491A-020E-4199-95F1-E0C20BFF4D6A",
  "PartialFillDispensedQuantity":10.00000,
  "PartialFillTotalDispensedQuantity":30.00000,
  "Quantity":30.0000,
  "UnitText":"EA",
  "DaysSupply":30,
  "LastFillDate":"2016-11-01",
  "LabelType":"Generic",
  "BrandName":"Paxil 20 Mg Tablet",
  "GenericName":"Paroxetine Hcl 20 Mg Tablet",
  "DrugName":"Paroxetine Hcl 20 Mg Tablet",
  "ImprintText":"biconvex round film-coated white scored oral tablet\nImprint 1: ZC 20",
  "Manufacturer":"Zydus Pharmaceu",
  "LotNumber":"12345",
  "LotExpirationDate":"2017-08-01",
  "DispensedItemAlternateID":"1234",
  "Group":"ROBOT",
  "SubstitutionText":"Substituted for:Paxil 20 Mg Tablet",
  "DosageFormText":"Tablet",
  "DrugClassID":1,
  "DrugClassText":"Rx",
  "LabelWarnings":[...],
  "DispensedInventoryGroup":"Robot",
  "DispensedInventoryGroupExternalID":"1234",
  "RefrigerationTypeID":"1",
  "RefrigerationTypeText":"Once Mixed",
  "UPC12WithCheckDigit":"3683820980541",
  "PrintName":"Paxil 20 Mg Tablet",
  "DispensingUnitsPerLabel":"0.00",
  "InventoryBins":[...]
}

<MedicationDispensed>
  <DrugStrength>20 mg</DrugStrength>
  <NDC>68382009805</NDC>
  <UPC>36838209805</UPC>
  <GCN>12312312312</GCN>
  <PioneerRxItemID>CCD7491A-020E-4199-95F1-E0C20BFF4D6A</PioneerRxItemID>
  <DeaSchedule>0</DeaSchedule>
  <PartialFillDueDate>2017-11-01<PartialFillDueDate>
  <PartialFillSatisfiedDate>2017-11-01<PartialFillSatisfiedDate>
  <PartialFillSatisfiedByPersonID>"CCD7491A-020E-4199-95F1-E0C20BFF4D6A"<PartialFillSatisfiedByPersonID>
  <PartialFillDispensedQuantity>10.00000<PartialFillDispensedQuantity>
  <PartialFillTotalDispensedQuantity>30.00000<PartialFillTotalDispensedQuantity>
  <Quantity>30.00000</Quantity>
  <UnitText>EA</UnitText>
  <DaysSupply>30</DaysSupply>
  <LastFillDate>2016-11-01</LastFillDate>
  <LabelType>Generic</LabelType>
  <BrandName>Paxil 20 Mg Tablet</BrandName>
  <GenericName>Paroxetine Hcl 20 Mg Tablet</GenericName>
  <DrugName>Paroxetine Hcl 20 Mg Tablet</DrugName>
  <ImprintText>biconvex round film-coated white scored oral tablet\nImprint 1: ZC 20</ImprintText>
  <Manufacturer>Zydus Pharmaceu</Manufacturer>
  <LotNumber>12345</LotNumber>
  <LotExpirationDate>2017-08-01</LotExpirationDate>
  <DispensedItemAlternateID>1234</DispensedItemAlternateID>
  <Group>ROBOT</Group>
  <SubstitutionText>Substituted for:Paxil 20 Mg Tablet</SubstitutionText>
  <DosageFormText>Tablet</DosageFormText>
  <DrugClassID>1</DrugClassID>
  <DrugClassText>Rx</DrugClassText>
  <LabelWarnings>
    <Warning>...</Warning>
  </LabelWarnings>
  <DispensedInventoryGroup>Robot</DispensedInventoryGroup>
  <DispensedInventoryGroupExternalID>1234</DispensedInventoryGroupExternalID>
  <RefrigerationTypeID>1</RefrigerationTypeID>
  <RefrigerationTypeText>Once Mixed</RefrigerationTypeText>
  <UPC12WithCheckDigit>368382098051</UPC12WithCheckDigit>
  <PrintName>Paxil 20 Mg Tablet</PrintName>
  <DispensingUnitsPerLabel>0.00></DispensingUnitsPerLabel>
  <InventoryBins>
    <Bin>...</Bin>
  </InventoryBins>
</MedicationDispensed>

Field	DataType	Always Present	Values / Description
DrugStrength	String	No	The Dispensed Medication’s Strength
NDC	String	No	The Dispensed Medication’s NDC (usually present, but will commonly be missing if compound or an OTC item)
UPC	String	No	The Dispensed Medication’s UPC
GCN	String	No	The Dispensed Medication’s GCN
PioneerRxItemID	Guid	No	The Dispensed Medication’s Internal PioneerRx ID
DeaSchedule	Int	No	The Dispensed Medication’s DEA Schedule 0 – No Schedule 2 – Schedule 2 3 – Schedule 3 4 – Schedule 4 5 – Schedule 5
PartialFillDueDate	Datetime	No	The Dispensed Medications’s Partial Fill Due Date
PartialFillSatisfiedDate	Datetime	No	The Dispensed Medications’s Partial Fill Satisfied Date
PartialFillSatisfiedByPersonID	Guid	No	The Dispensed Medications’s Partial Satisfied By Person ID
PartialFillDispensedQuantity	Decimal(15,5)	No	The Dispensed Medications’s Partial Quantity
PartialFillTotalDispensedQuantity	Decimal(15,5)	No	The Dispensed Medications’s Partial Fill Total Dispensed Quantity
Quantity	Decimal(15,5)	No	The Dispensed Medication’s Quantity
UnitText	Enum(String)	No	The Dispensed Medication’s Unit Text (EA, ML, GM)
DaysSupply	Int	No	The Dispensed Medication’s Days Supply
LastFillDate	Date	No	The Last Fill Date of the Dispensed Medication
LabelType	Enum(String)	No	The Dispensed Medication’s Label Type Generic Brand Compound
BrandName	String	No	The Dispensed Medication’s Brand Name
GenericName	String	No	The Dispensed Medication’s Generic Name
DrugName	String	No	The Dispensed Medication’s Drug Name
ImprintText	String	No	The Dispensed Medication’s Imprint Text
Manufacturer	String	No	The Dispensed Medication’s Manufacturer
LotNumber	String	No	The Dispensed Medication’s Lot Number
LotExpirationDate	Date	No	The Dispensed Medication’s Lot Expiration Date
DispensedItemAlternateID	String	No	The Dispensed Medication’s Alternate ID
Group	String	No	The Dispensed Medication’s Group
SubstitutionText	String	No	The Dispensed Medication’s Substitution Text
DosageFormText	String	No	The Dispensed Medication’s Dosage Form Text
DrugClassID	Int	No	The Dispensed Medication’s Drug Class ID 1 – Rx 2 – OTC
DrugClassText	String	No	The Dispensed Medication’s Drug Class Text
LabelWarnings	Warning List	No	List of Warnings associated with the Dispensed Medication
DispensedInventoryGroup	String	Yes	The Dispensed Medication’s Dispensed Inventory Group Text
DispensedInventoryGroupExternalID	String	No	The Dispensed Medication’s Dispensed Inventory Group’s External ID
RefrigerationTypeID	Int	No	The Dispensed Medication’s Refrigeration Type ID 0 – Not Required 1 – Once Mixed 2 – Required
RefrigerationTypeText	String	No	The Dispensed Medication’s Refrigeration Type Text
UPC12WithCheckDigit	String	No	The Dispensed Medication’s UPC with Check Digit
PrintName	String	No	The Dispensed Medication’s Print Name
DispensingUnitsPerLabel	Decimal(18,9)	No	The Dispensing Medication’s Units Dispensed Per Label
InventoryBins	Inventory Bin List	No	List of Inventory Bins associated with the Dispensed Medication

Warning

{
  "RelativePriority": "1",
  "WarningCode": "0062",
  "WarningVendorCode": "1-715",
  "PharmexTextOnly": "May cause dizziness"
}

<Warning>
  <RelativePriority>1</RelativePriority>
  <WarningCode>0062</WarningCode>
  <WarningVendorCode>1-715</WarningVendorCode>
  <PharmexTextOnly>May cause dizziness</PharmexTextOnly>
</Warning>

Field	DataType	Always Present	Values / Description
RelativePriority	Int	No	The priority for a Warning
WarningCode	String	No	The Code for a Warning
WarningVendorCode	String	No	The Vendor Code for a Warning
PharmexTextOnly	String	No	The text for a Warning.

Inventory Bin

{
  "InventoryBinID":"00000000-0000-0000-0000-000000000000",
  "InventoryBinText":"Inventory Bin Text",
  "InventoryBinGroupText":"InventoryBinGroupText"
}

<InventoryBin>
  <InventoryBinID>00000000-0000-0000-0000-000000000000</InventoryBinID>
  <InventoryBinText>Inventory Bin Text</InventoryBinText>
  <InventoryBinGroupText>Inventory Bin Group Text</InventoryBinGroupText>
</InventoryBin>

Field	DataType	Always Present	Values / Description
InventoryBinID	Guid	No	The Inventory Bin ID
InventoryBinText	String	No	The Inventory Bin Text
InventoryBinGroupText	String	No	The Inventory Bin Group Text

Diagnosis

{
  "SequenceNumber":0,
  "Qualifier":"ICD10",
  "Value":"V97.33"
}

<Diagnosis>
  <SequenceNumber>0</SequenceNumber>
  <Qualifier>ICD10</Qualifier>
  <Value>V97.33</Value>
</Diagnosis>

Field	DataType	Always Present	Values / Description
SequenceNumber	Int	Yes	A Reference Number used in areas of the spec to refer to specific objects
Qualifier	String	No	Diagnosis Qualifier
Value	String	Yes	Diagnosis Value

Prescription Comments

{
  "RxComments":{...},
  "FillComments":{...}
}

<PrescriptionComments>
  <RxComments>...</RxComments>
  <FillComments>...</FillComments>
</PrescriptionComments>

Field	DataType	Always Present	Values / Description
RxComments	Prescription Comments Details List	No	Prescription Comments
FillComments	Prescription Comments Details List	No	Fill Comments

Prescription Comments Details

{
  "Informational":"Comments that are non-critical",
  "Critical":"Critical Comments that are presented with more emphasis in the software",
  "PointOfSale":"Comments that show at the PioneerRx POS to the POS Clerk",
}

<RxComments>
  <Informational>Comments that are non-critical</Informational>
  <Critical>Critical Comments that are presented with more emphasis in the software</Critical>
  <PointOfSale>Comments that show at the PioneerRx POS to the POS Clerk</PointOfSale>
</RxComments>

Field	DataType	Always Present	Values / Description
Informational	String	No	Prescription’s Informational Comments
Critical	String	No	Prescription’s Critical Comments
PointOfSale	String	No	Prescription’s PointOfSale Comments

PayMethod

{
  "PatientPayMethodID":"AF4D3C5F-2BD8-4798-BACD-9D373BF28D49",
  "PayMethodBillingOrder":"1",
  "PayMethodPayorID":"B043ADA3-68F8-48F3-B6CF-CE0216323CAA",
  "PayMethodPayorName":"Empire Loyalty",
  "PayMethodBinNumber":"610674",
  "PayMethodPCN":"RXLOCAL",
  "PayMethodPlanTypeID":6,
  "PayMethodPlanTypeText":"Standard"
}

<PayMethod>
  <PatientPayMethodID>AF4D3C5F-2BD8-4798-BACD-9D373BF28D49</PatientPayMethodID>
  <PayMethodBillingOrder>1</PayMethodBillingOrder>
  <PayMethodPayorID>B043ADA3-68F8-48F3-B6CF-CE0216323CAA</PayMethodPayorID>
  <PayMethodPayorName>Empire Loyalty</PayMethodPayorName>
  <PayMethodBinNumber>610674</PayMethodBinNumber>
  <PayMethodPCN>RXLOCAL</PayMethodPCN>
  <PayMethodPlanTypeID>6</PayMethodPlanTypeID>
  <PayMethodPlanTypeText>Standard</PayMethodPlanTypeText>
 </PayMethod>

Field	DataType	Always Present	Values / Description
PatientPayMethodID	Guid	Yes	The Patient Pay Method ID
PayMethodBillingOrder	Int	No	The Billing Order of the Pay Method
PayMethodPayorID	Guid	No	The Pay Method Payor ID
PayMethodPayorName	String	No	The Pay Method Payor Name
PayMethodBinNumber	String	No	The Pay Method Bin Number
PayMethodPCN	String	No	The Pay Method PCN
PayMethodPlanTypeID	Int	No	The Pay Method Plan Type ID 1 - Assignment of Benefits 2 - Medicaid/Welfare 3 - Indigent Case 4 - Medicare Part D 5 - Worker’s Comp 6 - Standard 8 - Medicare Part B 9 - Government 10 - Cash/AR
PayMethodPlanTypeText	String	No	The Pay Method Plan Type Text

Claim

Claim data is contingent on level of service for the configured interface

{
  "SequenceNumber":0,
  "BillingOrder":1,
  "Type":"Paid",
  "PayorName":"BC/BS LA",
  "TransmissionDate":"2016-07-29T14:31:45.667Z",
  "CardholderID":"123455",
  "ClaimEdiSent":"RAW EDI STRING",
  "ClaimEdiReceived":"RAW EDI STRING",
  "BinNumber":"123456",
  "PCN":"ABC",
  "TransactionResponseStatus":"P",
  "TransactionCode":"B1",
  "PriorAuthorizationNumberSubmitted":0,
  "AcquisitionCost":10.00000,
  "GrossAmountSubmitted":32.45000,
  "GrossAmountPaid":22.45000,
  "PatientPayAmountPaid":10.00000,
  "PercentageSalesTaxAmountPaid":0.00000,
  "PercentageSalesTaxAmountSubmitted":0.00000,
  "PercentageSalesTaxRatePaid":0.00000,
  "PercentageSalesTaxRateSubmitted":0.00000,
  "FlatSalesTaxAmountPaid":0.00000,
  "FlatSalesTaxAmountSubmitted":0.10000,
  "UsualAndCustomaryFeeSubmitted":33.45000
}

<Claim>
  <SequenceNumber>0</SequenceNumber>
  <BillingOrder>1</BillingOrder>
  <Type>Billing</Type>
  <PayorName>BC/BS LA</PayorName>
  <TransmissionDate>2016-07-29T14:31:45.667Z</TransmissionDate>
  <CardholderID>123455</CardholderID>
  <ClaimEdiSent>RAW EDI</ClaimEdiSent>
  <ClaimEdiReceived>RAW EDI</ClaimEdiReceived>
  <BinNumber>123456</BinNumber>
  <PCN>ABC</PCN>
  <TransactionResponseStatus>P</TransactionResponseStatus>
  <TransactionCode>B1</TransactionCode>
  <PriorAuthorizationNumberSubmitted>0</PriorAuthorizationNumberSubmitted>
  <AcquisitionCost>10.00000</AcquisitionCost>
  <GrossAmountSubmitted>32.45000</GrossAmountSubmitted>
  <GrossAmountPaid>22.45000</GrossAmountPaid>
  <PatientPayAmountPaid>10.00000</PatientPayAmountPaid>
  <PercentageSalesTaxAmountPaid>0.00000</PercentageSalesTaxAmountPaid>
  <PercentageSalesTaxAmountSubmitted>0.00000</PercentageSalesTaxAmountSubmitted>
  <PercentageSalesTaxRatePaid>0.00000</PercentageSalesTaxRatePaid>
  <PercentageSalesTaxRateSubmitted>0.00000</PercentageSalesTaxRateSubmitted>
  <FlatSalesTaxAmountPaid>0.00000</FlatSalesTaxAmountPaid>
  <FlatSalesTaxAmountSubmitted>0.10000</FlatSalesTaxAmountSubmitted>
  <UsualAndCustomaryFeeSubmitted>33.45000</UsualAndCustomaryFeeSubmitted>
</Claim>

Field	DataType	Always Present	Values / Description
SequenceNumber	Int	Yes	A number representing the Sequence order of this record in regards to this XML document
BillingOrder	Enum(Int)	Yes	Represents the Billing Order of Third Party 0 - Cash 1 - Primary 2 - Secondary 3 - Tertiary 4 - Quaternary 5 - Quinary
Type	Enum(String)	No	Billing Reversal Reversal and Resubmit
PayorName	String	No	Third Party Payor Name
TransmissionDate	DateTime	No	Transmission Date
CardholderID	String	No	Third Party Cardholder ID
ClaimEdiSent	String	No	Third Party EDI Sent
ClaimEdiReceived	String	No	Third Party EDI Received
BinNumber	String	No	Third Party Bin Number
PCN	String	No	Third Party PCN Number
TransactionResponseStatus	String	No	Third Party Transaction Response Status (NCPDP Code, e.g. P = Paid, R = Rejected, A = Accepted, …)
TransactionCode	String	No	Third Party Transaction Code (NCPDP Code, e.g. B1 = Billing, B2 = Reversal, B3 = Reversal and Resubmit …)
PriorAuthorizationNumberSubmitted	Int	No	Third Party Prior Authorization Number Submitted
AcquisitionCost	Decimal	No	Third Party Aquisition Cost
GrossAmountSubmitted	Decimal	No	Third Party Gross Amount Submitted
GrossAmountPaid	Decimal	No	Third Party Gross Amount Paid
PatientPayAmountPaid	Decimal	No	Third Party Patient Pay Amount Paid
PercentageSalesTaxAmountPaid	Decimal	No	Third Party Percentage Sales Tax Paid
PercentageSalesTaxAmountSubmitted	Decimal	No	Third Party Percentage Sales Tax Submitted
PercentageSalesTaxRatePaid	Decimal	No	Third Party Percentage Sales Tax Rate Paid
PercentageSalesTaxRateSubmitted	Decimal	No	Third Party Percentage Sales Tax Rate Submitted
FlatSalesTaxAmountPaid	Decimal	No	Third Party Flat Sales Tax Amount Paid
FlatSalesTaxAmountSubmitted	Decimal	No	Third Party Flat Sales Tax Amount Submitted
UsualAndCustomaryFeeSubmitted	Decimal	No	Third Party Usual and Customary Fee Submitted

Response

{
  "Message_Header":{
    "Message_ID":"1cc13e63-f271-4ca5-b839-75e645cc45d8",
    "Message_Type":"ACK",
    "Error":"Optional Error Message, will only apply when sending NAK for Message_Type"
  }
}

<XML>
  <Message_Header>
    <Message_ID>1cc13e63-f271-4ca5-b839-75e645cc45d8</Message_ID>
    <Message_Type>ACK</Message_Type>
    <Error>Optional Error Message, will only apply when sending NAK for Message_Type</Error>
  </Message_Header>
</XML>

When your service receives a message, it needs to respond with an ackowledgement. This will inform the PioneerRx system to not transmit that message again. If it is not ackowledged, the system will attempt to resend it.

You will send data back with a Message_Header object in it, with the following fields.

Field	DataType	Always Present	Values / Description
Message_ID	Guid	Yes	The ID from the message that was transmitted to you
Message_Type	String	Yes	The indicator for the status type of the message ACK = Ackowledgement NAK = Error Occurred and message Not received
Error	String	No	Optional Error Message, will only apply when sending NAK for Message_Type

Examples

TODO provide full examples