PioneerRx Enterprise API
PioneerRx Enterprise API allows users to implement custom integrations into an external workflow.
Connectivity
The api will use a self issued cert that users will need to trust.
All API requests are required to be HTTPS.
Security
Authentication
//Example Code is in C#
var timeStamp = DateTime.UtcNow;
var sharedSecret = "{fromPrx}";//Value given from PioneerRx upon enrollment
var saltedString = timeStamp.ToString("yyyy-MM-ddTHH:mm:ss.ffffffZ") + sharedSecret;
//Encoding saltedString using Unicode little-endian byte order
byte[] encodedSaltedString = Encoding.Unicode.GetBytes(saltedString);
//Hashing Algorithm used is SHA512
HashAlgorithm hash = new SHA512Managed();
//Compute Hash of encodedSaltedString
byte[] hashedEncodedString = hash.ComputeHash(encodedSaltedString);
//Convert hashed array to base64-encoded string
string signature = Convert.ToBase64String(hashedEncodedString);
Debug.WriteLine(signature); //prx-signature
Debug.WriteLine(timeStamp.ToString("yyyy-MM-ddTHH:mm:ss.ffffffZ")); //prx-timestamp
Example Headers
prx-api-key: testApiKeyValue
prx-timestamp: 0001-01-01T00:00:00.001Z
prx-signature: o5qhXR/j9w/+42o/dafZdKCuNWK93jW2xR4EKWh+rUgNzdYR7Qwoeutub1fboZMk+hLil0jDE/UDXIywtWmg2Zug==
Required Request Headers
Headers are required for all Enterprise API Requests
| HeaderName | Description |
|---|---|
| prx-api-key | This is the value given to you upon enrollment with Enterprise |
| prx-timestamp | Represents the UTC time the request is made |
| prx-signature | A Hashed string salted with your shared secret (see example and information below) |
How to create the signature hash
- Generate a Datatime value as ISO formatted UTC to use as the timestamp of the request.
- Salt the timestamp value with your shared secret by concatenating two values (timestamp value + shared secret)
- Using the salted timestamp generate an UTF-16-LE encoded byte array.
- Use a SHA512 hashing algorithm to compute a hash for the encoded byte array from step 3.
- Convert the resulting byte array from the hash as a base64 string.
- The base64 string can now be used in the request header.
For more information on Unicode Encoding, see Wikipedia
Methods
IsAuthenticated
Success Reponse:
StatusCode: 200
{
true
}
Error Response:
StatusCode: 400
{
"Invalid Header(s)"
}
StatusCode: 401
{
"Unauthorized"
}
POST - Used to confirm validity of the request headers.
No Request Body needed
https://{API URL}/api/enterprise/IsAuthenticated
Method List
Success Response:
StatusCode: 200
[
{
"methodName": "Test",
"version" : "1.0",
"availableOn":"2020-04-16T00:00:00Z",
"parameters": [
{
"name": "TestParameter",
"isRequired": true,
"dataType": "Int32"
},
{...},
...
]
},
{...},
...
]
Error Response:
StatusCode: 401
{
"Unauthorized"
}
GET - Self documentation endpoint. Provides list of available methods along with parameter info.
https://{API URL}/api/enterprise/method/list
Process Method
Example Request Body:
{
"MethodName": "Test",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "LocationName",
"Value": "Test Pharmacy"
}
]
}
Success Response:
StatusCode: 200
{
"results": [
"1":
[
{
"PropertyName": {PropertyValue}
...
}
],
...
"{N}": [
{
"PropertyName": {PropertyValue}
...
}
]
],
"metadata": []
}
Error Response:
StatusCode: 400
{
"Invalid Method"
}
StatusCode: 400
{
"{Parameter Name} is a required parameter"
}
StatusCode: 400
{
"{Parameter Value} is invalid. {Parameter Name} is a {data type}"
}
POST - Used to execute method using parameter collection. The resulting data may vary per MethodName.
Each Data collection in the result set are numbered by default, some methods could have dynamic names for these. Use the SampleMethod call to see examples of the result sets of a MethodName.
| Property Name | Description |
|---|---|
| MethodName | API call to execute |
| Version | Major and minor of API method (ex. “1.0”) |
| ParameterCollection | Name/Value array of parameters used for a specific API Method |
All Requests bodies are to be formatted as followed: { “MethodName” : “(api method name)”, “Version” : “(version)”, “ParameterCollection” : [ { “Name” : “(parameter1 name)”, “Value”: “(parameter1 value)”}, … { “Name” : “(parameterN name)”, “Value”: “(parameterN value)”} ] }
Api methods and parameters are made available on a per customer basis.
https://{API URL}/api/enterprise/method/process
Process Test Method
Example Request Body:
{
"MethodName": "Test",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "LocationName",
"Value": "Test Pharmacy"
}
]
}
Success Response:
StatusCode: 200
{
"results": [
"1":
[
{
"PropertyName": {PropertyValue}
...
}
],
...
"{N}": [
{
"PropertyName": {PropertyValue}
...
}
]
],
"metadata": []
}
Error Response:
StatusCode: 400
{
"Invalid Method"
}
StatusCode: 400
{
"{Parameter Name} is a required parameter"
}
StatusCode: 400
{
"{Parameter Value} is invalid. {Parameter Name} is a {data type}"
}
POST - Used to execute method only on Test Database using parameter collection.
Uses the same Request body as the Process Method call
Uses the Test API Key and Shared Secret values - these values differ from the Production values
https://{API URL}/api/enterprise/method/test/process
Validate Method Parameters
Example Request Body:
{
"MethodName": "Test",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "LocationName",
"Value": "Test Pharmacy"
}
]
}
Success Response:
StatusCode: 200
{
true
}
Error Response:
StatusCode: 400
{
"Invalid Method"
}
StatusCode: 400
{
"{Parameter Name} is a required parameter"
}
StatusCode: 400
{
"{Parameter Value} is invalid. {Parameter Name} is a {data type}"
}
POST - Used to check that the parameters passed to a specific method are correct. No data returned by this method.
Uses the same Request body as the Process Method call
https://{API URL}/api/enterprise/method/validate
Sample Method Data
Example Request Body:
{
"MethodName": "Test",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "LocationName",
"Value": "Test Pharmacy"
}
]
}
Success Response:
StatusCode: 200
{
"results": [
"1":
[
{
"PropertyName": {PropertyValue}
...
}
],
...
"{N}": [
{
"PropertyName": {PropertyValue}
...
}
]
],
"metadata": []
}
Error Response:
StatusCode: 400
{
"Invalid Method"
}
StatusCode: 400
{
"{Parameter Name} is a required parameter"
}
StatusCode: 400
{
"{Parameter Value} is invalid. {Parameter Name} is a {data type}"
}
POST - Used to generate mock data for integration testing.
Uses the same Request body as the Process Method call
https://{API URL}/api/enterprise/method/sample
Read Methods
Patient
Get Patient
Example Request Body:
{
"MethodName": "GetPatient",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"person": [{
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"ssn": "123456789",
"driversLicenseNumber": "234324234",
"driversLicenseStateCode": "NC",
"driversLicenseExpirationDate": "2021-04-18T00:00:00Z",
"alternateID": "AI1234",
"alternateIDTypeID": 0,
"alternateIDTypeText": "Other",
"identificationExpirationDate": "2024-01-18T00:00:00Z",
"externalID": "BR549",
"centralKey":123456789,
"serialNumberPerson": 42295,
"loyaltyID": "L1234",
"loyaltyStartDate": "2021-01-18T00:00:00Z",
"patientTierOverrideTypeID": 0,
"patientTierOverrideTypeText": "No Override",
"medicareBeneficiaryID": "12345678901",
"mirixaID": "M1234",
"outcomesID": "O134234",
"kloudScriptID": "K13244",
"immunizationRegistryID": "IR1234",
"ccncID": "C234324",
"salutation": "Mr.",
"firstName": "Timothy",
"middleName": "M",
"lastName": "Reedman",
"suffix": "Jr.",
"initials": "TMR",
"dateOfBirth": "1969-04-28T00:00:00Z",
"gender": "M",
"heightInches": 68,
"weightOz": 2972,
"autoFillModeTypeID":"",
"autoFillModeText":"",
"allergyStatusTypeID": 1,
"allergyStatusTypeText": "No Known Allergies",
"otherMedStatusTypeID": 1,
"otherMedicationStatusTypeText": "No Know other Medications",
"medConditionStatusTypeID": 1,
"medConditionStatusText": "No Known Conditions",
"defaultPriorityTypeID": 2,
"defaultPriorityTypeText": "Special Handling",
"deliveryMethodID": "7646e57a-9303-4ec8-a93f-e7fc5c545eb6",
"deliveryMethodText": "Driver",
"deliveryPaymentTypeEnum": 1,
"deliveryPaymentTypeText": "Cash",
"deliveryZoneID": "e0f92929-3c53-4f03-9951-3b75ed71bdb9",
"deliveryZoneText": "PRESTON POINTE",
"deliveryMethodComment": "do not mess around",
"raceTypeID": 1,
"raceTypeText": "Caucasian",
"ethnicityTypeID":"",
"ethnicityTypeText":"",
"isAnimal": 0,
"animalSpeciiesTypeID":"",
"animalSpecisesTypeText":"",
"animalFeedTypeID":"",
"animalFeedTypeText":"",
"animalPerformanceTypeID":"",
"animalPerformanaceTypeText":"",
"animalOwerID":"",
"languageTypeID": 1,
"languageTypeText": "English",
"patientEducationID":"",
"patientEducationText":"",
"patientMeducationLanguageID":"",
"patientMeducationLanguageText":"",
"patientMeducaitonFontSizeID":"",
"patientMeducaitonFontSizeText":"",
"printPatientEducationTypeID":"",
"printPatientEducationTypeText":"",
"goGreenEnrolledOn":"",
"countyID": "458be74c-bec2-439c-9c7d-7a08d52481ec",
"countyText": "Caddo",
"mothersMaidenName": "Johnson",
"birthStateCode","",
"birthOrder","",
"preferBrand": 1,
"ezOpen": 1,
"ezOpenSignedOn":"2021-01-18T12:15:00Z",
"unitDose": 0,
"noCheckPayment": 0,
"callWhenReady": 0,
"weeklyPlanner": 0,
"adherenceDoNotPhone": 0,
"restrictCashOnlyPHI": 0,
"visuallyImpaired": 0,
"hearingImpaired": 1,
"ignoreACEIARB": 0,
"ignoreHRM": 0,
"multiDose": 0,
"doNotPhone": 0,
"doNotEmail": 0,
"doNotFax": 0,
"doNotText": 0,
"doNotMail": 0,
"doNotAllowScheduledDrugs": 0,
"emailAddress": "tr@xr7.com",
"primaryAddressID": "685c4be7-6308-47d8-a348-c92cdb5627ae",
"mailingAddressID": "685c4be7-6308-47d8-a348-c92cdb5627ae",
"deliveryAddressID": "685c4be7-6308-47d8-a348-c92cdb5627ae",
"primaryPhoneID": "aa191108-7157-4c1a-9d80-32973e2f8078",
"primaryFaxID":"bb191108-7157-4c1a-9d80-32973e2f8099",
"criticalComment": "Do not look him in the eye becasue he will turn you to stone!",
"criticalCommentWithRTF": "{\\rtf1\\ansi\\ansicpg1252\\deff0\\deflang1033{\\fonttbl{\\f0\\fnil\\fcharset0 Microsoft Sans Serif;}}\r\n{\\colortbl ;\\red0\\green0\\blue0;\\red0\\green255\\blue0;}\r\n\\viewkind4\\uc1\\pard\\cf1\\highlight2\\f0\\fs29 Do not look him in the eye becasue he will turn you to stone!\\cf0\\highlight0\\fs17\\par\r\n}\r\n",
"informationalComment": "He likes Dogs",
"informationalCommentWithRTF": "{\\rtf1\\ansi\\ansicpg1252\\deff0\\deflang1033{\\fonttbl{\\f0\\fnil\\fcharset0 Microsoft Sans Serif;}}\r\n{\\colortbl ;\\red0\\green128\\blue0;}\r\n\\viewkind4\\uc1\\pard\\cf1\\f0\\fs56 He likes Dogs\\cf0\\fs17\\par\r\n}\r\n",
"hiddenComment": "His checks are bad!",
"hiddenCommentWithRTF": "{\\rtf1\\ansi\\ansicpg1252\\deff0\\deflang1033{\\fonttbl{\\f0\\fnil\\fcharset0 Microsoft Sans Serif;}}\r\n\\viewkind4\\uc1\\pard\\b\\f0\\fs17 His checks are bad!\\b0\\par\r\n}\r\n",
"saleComment": "Make sure you only take cash!",
"saleCommentWithRTF": "{\\rtf1\\ansi\\ansicpg1252\\deff0\\deflang1033{\\fonttbl{\\f0\\fnil\\fcharset0 Microsoft Sans Serif;}}\r\n{\\colortbl ;\\red255\\green0\\blue128;}\r\n\\viewkind4\\uc1\\pard\\cf1\\ul\\b\\i\\f0\\fs17 Make sure you only take cash!\\cf0\\ulnone\\b0\\i0\\par\r\n}\r\n",
"primaryCarePrescriberID": "df6463ea-4e0e-4a8f-ab50-3295b7779f3d",
"adherenceEmployeeID": "e374273c-00e7-4fb0-96f1-adecc506f27d",
"medicationSynchronizationContactMethodID": 0,
"medicationSynchronizationContactMethodText": "None",
"syncDate":"",
"nextCallDate":"",
"nextSyncDate":"",
"adherenceComments":"",
"syncDays":"",
"syncStatusTypeID": 3,
"syncStatusTypeText": "Declined",
"medicarePartANumber":"",
"vaNumber":"",
"medicaidNumber":"",
"diet":"",
"diagnosis":"",
"usePatientDiagnosisOnMar": 0,
"rehabPotential":"",
"facilityAllergyText":"",
"usePatientAllergyOnMar": 0,
"todaysPriorityTypeID": 3,
"todaysPriorityTypeText": "Delivery",
"todaysPriorityDateTime": "2021-10-15T14:00:00Z",
"todaysPriorityFillComment": "Leave behind big bush.",
"todaysPriorityLastChangedOn": "2021-10-14T15:36:52Z",
"homePharmacyExternalPharmacyID":"",
"primaryCategoryID": "f47557ef-3d3d-4c38-a3c4-a1428ea7eb6d",
"currentPatientFacilityID": "af5e9ff4-3ac3-4d16-bebc-6a1a0bb2ca63",
"statusTypePatientID": "eba0f507-7995-4481-8c30-77c9edbf9a63",
"statusTypePatientText": "Active",
"statusChangedOn":"2021-01-18T16:19:28Z",
"isActive": 1,
"createdOn": "2019-09-26T11:55:54Z",
"changedOn": "2021-01-18T16:19:28Z",
"changedByID": "3c21ddeb-dd94-4bf3-9688-e16b8c1af8f3",
"changedByName": "PioneerRx Support",
"changedAtID": "c836fe41-9457-484b-a3c5-48abe244e429",
"changedAtLocation": "PRX Pharmacy"
}],
"address": [{
"addressID": "685c4be7-6308-47d8-a348-c92cdb5627ae",
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"addressTypeID": "00000000-0000-0000-0000-000000000000",
"addressTypeText": "Primary",
"displaySequence": 0,
"address": "408 Kay Ln",
"city": "Shreveport",
"stateCode": "LA",
"zipCode": "71115-3604",
"country": "USA",
"changedOn": "2021-01-18T15:57:18Z",
"changedByID": "3c21ddeb-dd94-4bf3-9688-e16b8c1af8f3",
"changedByName": "PioneerRx Support",
"changedAtID": "c836fe41-9457-484b-a3c5-48abe244e429",
"changedAtLocation": "PRX Pharmacy"
}],
"phone": [{
"phoneID": "aa191108-7157-4c1a-9d80-32973e2f8078",
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"phoneTypeID": "8e62bba1-fda3-4524-ae59-88fa4bb667c4",
"phoneTypeText": "Other",
"displaySequence": 0,
"phoneNumber": "7778889999",
"extension": "X124",
"changedOn": "2021-01-18T15:57:18Z",
"changedAtID": "c836fe41-9457-484b-a3c5-48abe244e429",
"changedAtLocation": "PRX Pharmacy"
}, {
"phoneID": "8a34e5b6-7f83-4b76-8878-14b3550329c7",
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"phoneTypeID": "efc09089-fcb4-4711-9872-f5de9d8f2a36",
"phoneTypeText": "Work",
"displaySequence": 1,
"phoneNumber": "5556668888",
"extension": "123",
"changedOn": "2021-01-18T15:57:18Z",
"changedAtID": "c836fe41-9457-484b-a3c5-48abe244e429",
"changedAtLocation": "PRX Pharmacy"
}],
"category": [{
"categoryID": "0c45b9d9-b190-4d95-a977-5178d317af13",
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"categoryText": "Shingrix Vaccine (Age > 50)",
"categoryDescription": "Patients > 50 years who have not received the first dose of Shingrix vaccine, excluding patients who have received the Zostavax vaccine in the last 8 weeks (2 months).",
"isAutoFilter": 1
}, {
"categoryID": "c323f5a1-acf5-4c16-a0ba-84e0c7f88cc4",
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"categoryText": "Cardinal Rehab Pilot",
"categoryDescription": "Cardinal Rehab Pilot",
"isAutoFilter": 0
}, {
"categoryID": "00efb741-f208-42fa-8353-9235b8e02277",
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"categoryText": "Pneumococcal Vaccine (Age > 65)",
"categoryDescription": "All patients 65 or older excluding those who have taken both Prevnar and Pneumovax OR those who have picked up Prevnar or Pneumovax in the last 12 months.",
"isAutoFilter": 1
}, {
"categoryID": "2110dc77-7097-4271-82ef-b62dd36fd4c3",
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"categoryText": "Ecare",
"categoryDescription": "Ecare",
"isAutoFilter": 0
}, {
"categoryID": "94177239-df8b-4464-ad8f-ea9a42a2c19c",
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"categoryText": "Prevnar 13 Needed",
"categoryDescription": "Prevnar 13 Needed",
"isAutoFilter": 1
}],
"allergy": [],
"condition": [],
"otherMedication": [],
"patientFacility": [{
"patientFacilityID": "af5e9ff4-3ac3-4d16-bebc-6a1a0bb2ca63",
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"facilityID": "76ff6562-35c3-4c7c-b106-ecff36c82991",
"facilityName": "The PioneerRx Rest Home",
"facilityWingID": "42ea2974-9c2a-40ed-905c-ca3fa11fe7c3",
"facilityWingText": "Default",
"admittedOn": "2019-09-26T00:00:00Z",
"roomNumber": "127",
"bed": "Window",
"medicalRecordNumber": "MR12345"
}],
"patientInventoryGroup": [],
"autoPayCreditCard": [],
"accountsReceivable": [],
"payMethod": [{
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"patientPayMethodID": "91b93626-ec40-4e00-9366-f5fd6f493216",
"payMethodTypeID": 2,
"payMethodTypeText": "Third Party",
"billingOrder": "O",
"priority": 1,
"autoSelect": 0,
"thirdPartyID": "5ecd0aca-f7ef-4cce-986f-e5feff3a5eb3",
"thirdPartyName": "HBP Loyalty Plan",
"bin": "014798",
"submissionTypeID": 1,
"submissionTypeText": "Transmitted",
"isTransmitted": 1,
"pcn": "RXLOCAL",
"pcnUserDefined": 0,
"patientRelationshipTypeID": 0,
"patientRelationshipTypeText": "Not Specified",
"ncpdpCode": 0,
"cardHolderLastNameFirst": "Reedman, Timothy M Jr.",
"groupNumberUserDefined": 0,
"startDate": "2019-09-26T00:00:00Z",
"patientLocationTypeID": 0,
"patientLocationTypeText": "Not Specified",
"eligibilityClarificationTypeID": 0,
"eligibilityClarificationTypeText": "Not Specified",
"placeOfResidenceTypeID": 0,
"placeOfResidenceTypeText": "Not Specified",
"placeOfServiceTypeID": 1,
"placeOfServiceTypeText": "Pharmacy",
"mtmEligible": 0,
"nonPartDConfirmed": 1,
"changedOn": "2021-01-18T16:18:30Z"
}]
},
"metadata": []
}
Method Name - GetPatient
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetPatient GetPatient will return the patient information. It will also return the results from methods GetPatientAddress, GetPatientPhone, GetPatientCategory, GetPatientAllergy, GetPatientCondition, GetPatientOtherMedication, GetPatientFacility, GetPatientInventoryGroup, GetPatientAutoPayCreditCard, GetPatientAccountsReceivable, GetPatientPayMethod. xxx
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
Get Patient Accounts Receivable
Example Request Body:
{
"MethodName": "GetPatientAccountsReceivable",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"patientAccountsReceivable": [{
"accountPersonChargeID": "96c92887-7762-42ba-9382-230ac0437ee0",
"accountID": "d0575cf6-70f6-4e57-9cc6-dd4759d7a864",
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"accountName": "Reedman Jr., Timothy M",
"accountNumber": 2772,
"alternateAccountNumber": "Old1234"
"allowed": 1,
"changedOn": "2021-01-12T14:02:52Z",
"changedByID": "3c21ddeb-dd94-4bf3-9688-e16b8c1af8f3",
"changedByName": "PioneerRx Support"
}]
},
"metadata": [
]
}
Method Name - GetPatientAccountsReceivable
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetPatientAccountsReceivable At least PersonID or AccountID is required for this method. Only passing in the PersonID, will return the accounts linked to the patient. Only passing in the AccountID, will return the specific account.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| AccountID | Guid | No | |
| AccountPersonChargeID | Guid | No | |
| PersonID | Guid | No |
Get Patient Address
Example Request Body:
{
"MethodName": "GetPatientAddress",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"address": [{
"addressID": "685c4be7-6308-47d8-a348-c92cdb5627ae",
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"addressTypeID": "00000000-0000-0000-0000-000000000000",
"addressTypeText": "Primary",
"displaySequence": 0,
"address": "1414 Mocking Bird Ln",
"city": "Shreveport",
"stateCode": "LA",
"zipCode": "92421-5942",
"country": "USA",
"changedOn": "2019-09-26T11:55:55Z",
"changedByID": "0a334e13-9c6a-404f-9448-815ee4e24217",
"changedByName": "Jonny Jones"
"changedAtID": "c836fe41-9457-484b-a3c5-48abe244e429",
"changedAtLocation": "PRX Pharmacy"
}]
},
"metadata": [
]
}
Method Name - GetPatientAddress
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetPatientAddress At least PersonID or AddressID is required for this method. Only passing in the PersonID, will return the addresses linked to the patient. Only passing in the AddressID, will return the specific address.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| AddressID | Guid | No | |
| PersonID | Guid | No |
Get Patient Allergy
Example Request Body:
{
"MethodName": "GetPatientAllergy",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"patientAllergy": [
{
"patientAllergyID": "990bed7f-bff1-4c23-8237-393ddce034f3",
"personID": "3f4f3284-e9a5-4210-ac92-195cc656576c",
"allergenDescription": "Sulfamethoxazole (Bulk) Powder",
"allergenGroupCode": 0,
"routedDosageFormMedicationID": 94865,
"isAllergic": 1,
"allergyReactionTypeID": 1,
"allergyReactionTypeText": "Severe"
},
{
"patientAllergyID": "7f1bd5b9-6611-4b22-8e63-9a553eadb663",
"personID": "3f4f3284-e9a5-4210-ac92-195cc656576c",
"allergenDescription": "Sulfa (Sulfonamide Antibiotics)",
"allergenGroupCode": 491,
"routedDosageFormMedicationID": 0,
"isAllergic": 1,
"allergyReactionTypeID": 1,
"allergyReactionTypeText": "Severe"
}
],
"person": [
{
"personID": "3f4f3284-e9a5-4210-ac92-195cc656576c",
"allergyStatusTypeID": 0,
"allergyStatusTypeText": "Ask Patient?"
}
]
},
"metadata": []
}
Method Name - GetPatientAllergy
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetPatientAllergy At least PersonID or PatientAllergyID is required for this method. Only passing in the PersonID, will return the allergies linked to the patient. Only passing in the PatientAllergyID, will return the specific allergy. An extra result set has been added, "person", which will now identify the patient settings are for Allergies, reguardless if the patient has actuall allergies list or not. The Example result current shows the patient has 2 allergies, but has been set to "Ask Patient?", which means the pharmacy needs to recheck the allergies with the patient the next time they talk with them.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| PatientAllergyID | Guid | No | |
| PersonID | Guid | No |
Get Patient Auto Pay Credit Card
Example Request Body:
{
"MethodName": "GetPatientAutoPayCreditCard",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"patientAutoPayCreditCard": [{
"autoPayCreditCardID": "6a5162df-1e41-409d-a818-a6c8232183ab",
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"expMonth": 12,
"expYear": 2021,
"creditCardTypeID": 3,
"creditCardTypeText": "Visa",
"nameOnCard": "Test Not Real",
"billingAddress": "408 Kay Ln",
"billingCity": "Shreveport",
"stateCode": "LA",
"zipCode": "71115-1234",
"comments": "This card is great",
"creditCardDescription": "Nice blue one",
"creditCardToken": "9XXtgFXXX3WpEXXXXLXX12XX",
"tokenIssuedByProcessorID": 1,
"tokenIssuedByProcessorTypeName": "Heartland",
"cardFirstSix": "123456",
"cardLastFour": "1234",
"createdOn": "2021-01-12T16:50:10Z"
}]
},
"metadata": [
]
}
Method Name - GetPatientAutoPayCreditCard
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetPatientAutoPayCreditCard At least PersonID or AutoPayCreditCardID is required for this method. Only passing in the PersonID, will return the credit cards linked to the patient. Only passing in the AutoPayCreditCardID, will return the specific credit card.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| AutoPayCreditCardID | Guid | No | |
| PersonID | Guid | No |
Get Patient Category
Example Request Body:
{
"MethodName": "GetPatientCategory",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"category": [{
"categoryID": "0c45b9d9-b190-4d95-a977-5178d317af13",
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"categoryText": "Shingrix Vaccine (Age > 50)",
"categoryDescription": "Patients > 50 years who have not received the first dose of Shingrix vaccine, excluding patients who have received the Zostavax vaccine in the last 8 weeks (2 months).",
"isAutoFilter": 1
}, {
"categoryID": "00efb741-f208-42fa-8353-9235b8e02277",
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"categoryText": "Pneumococcal Vaccine (Age > 65)",
"categoryDescription": "All patients 65 or older excluding those who have taken both Prevnar and Pneumovax OR those who have picked up Prevnar or Pneumovax in the last 12 months.",
"isAutoFilter": 1
}, {
"categoryID": "f47557ef-3d3d-4c38-a3c4-a1428ea7eb6d",
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"categoryText": "Tennis Player",
"categoryDescription": "Patients who play tennis.",
"isAutoFilter": 0
}]
},
"metadata": [
]
}
Method Name - GetPatientCategory
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetPatientCategory At least PersonID or CategoryID is required for this method. Only passing in the PersonID, will return the categories linked to the patient. Only passing in the CategoryID, will return the specific category.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| CategoryID | Guid | No | |
| PersonID | Guid | No |
Get Patient Comment
Example Request Body:
{
"MethodName": "GetPatientComments",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"patientComment": [
{
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"commentTypeID": 1,
"comment": "Do not look him in the eye becasue he will turn you to stone!",
"commentWithRTF": "{\\rtf1\\ansi\\ansicpg1252\\deff0\\deflang1033{\\fonttbl{\\f0\\fnil\\fcharset0 Microsoft Sans Serif;}}\r\n{\\colortbl ;\\red0\\green0\\blue0;\\red0\\green255\\blue0;}\r\n\\viewkind4\\uc1\\pard\\cf1\\highlight2\\f0\\fs29 Do not look him in the eye becasue he will turn you to stone!\\cf0\\highlight0\\fs17\\par\r\n}\r\n"
},
{
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"commentTypeID": 2,
"comment": "He likes Dogs",
"commentWithRTF": "{\\rtf1\\ansi\\ansicpg1252\\deff0\\deflang1033{\\fonttbl{\\f0\\fnil\\fcharset0 Microsoft Sans Serif;}}\r\n{\\colortbl ;\\red0\\green128\\blue0;}\r\n\\viewkind4\\uc1\\pard\\cf1\\f0\\fs56 He likes Dogs\\cf0\\fs17\\par\r\n}\r\n"
},
{
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"commentTypeID": 3,
"comment": "His checks are bad!",
"commentWithRTF": "{\\rtf1\\ansi\\ansicpg1252\\deff0\\deflang1033{\\fonttbl{\\f0\\fnil\\fcharset0 Microsoft Sans Serif;}}\r\n\\viewkind4\\uc1\\pard\\b\\f0\\fs17 His checks are bad!\\b0\\par\r\n}\r\n"
},
{
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"commentTypeID": 4,
"comment": "Make sure you only take cash!",
"commentWithRTF": "{\\rtf1\\ansi\\ansicpg1252\\deff0\\deflang1033{\\fonttbl{\\f0\\fnil\\fcharset0 Microsoft Sans Serif;}}\r\n{\\colortbl ;\\red255\\green0\\blue128;}\r\n\\viewkind4\\uc1\\pard\\cf1\\ul\\b\\i\\f0\\fs17 Make sure you only take cash!\\cf0\\ulnone\\b0\\i0\\par\r\n}\r\n"
}
]
},
"metadata": []
}
Method Name - GetPatientComment
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetPatientComment This mehtod will return the comments on the patient. Passing in a specific CommentTypeID, will return that comment.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| CommentTypeID | Int32 | Defaults to return all comments. 1 Critical 2 Informational 3 Hidden 4 Sale | No |
Get Patient Condition
Example Request Body:
{
"MethodName": "GetPatientCondition",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"patientCondition": [{
"patientConditionID": "160ffb65-86c0-4842-8fca-03bc0f752d87",
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"conditionStartDate": "2019-12-01T00:00:00Z",
"icD9Code": "",
"snomedConceptID": 1310004,
"patientConditionTypeID": 1,
"patientConditionTypeText": "Other",
"patientConditionStatusTypeID": 7,
"patientConditionStatusTypeText": "Active (NOS)",
"patientConditionSeverityTypeID": 3,
"patientConditionSeverityTypeText": "Unknown",
"patientConditionReportedDate": "2020-01-02T00:00:00Z"
}, {
"patientConditionID": "530a210d-bd55-4c74-badb-93ac75e17a70",
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"diseaseID": 3446,
"diseaseDescription56": "Pregnancy",
"diseaseDescription100": "Pregnancy",
"fdbDiseaseCode": "18.V22200",
"conditionStartDate": "2020-03-01T00:00:00Z",
"conditionEndDate": "2020-12-01T00:00:00Z",
"icD10Code": "Z33.1",
"icD10ShortDescription": "Pregnant state, incidental ",
"icD9Code": "V22.2",
"icD9ShortDescription": "Preg state, incidental",
"snomedConceptID": 77386006,
"snomedDescription": "Pregnant",
"patientConditionTypeID": 0,
"patientConditionTypeText": "Medical",
"patientConditionStatusTypeID": 7,
"patientConditionStatusTypeText": "Active (NOS)",
"patientConditionSeverityTypeID": 1,
"patientConditionSeverityTypeText": "Acute",
"patientConditionReportedDate": "2020-04-01T00:00:00Z"
}, {
"patientConditionID": "5125b2ee-48cf-4210-b40f-f01c128664f6",
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"conditionStartDate": "2021-01-23T00:00:00Z",
"icD10Code": "T59.811",
"icD10ShortDescription": "Toxic effect of smoke, accidental (unintentional) ",
"icD9Code": "909.1",
"icD9ShortDescription": "Late eff nonmed substanc",
"snomedConceptID": 426936004,
"snomedDescription": "Smoke inhalation injury",
"patientConditionTypeID": 0,
"patientConditionTypeText": "Medical",
"patientConditionStatusTypeID": 7,
"patientConditionStatusTypeText": "Active (NOS)",
"patientConditionSeverityTypeID": 2,
"patientConditionSeverityTypeText": "Chronic",
"patientConditionReportedDate": "2021-02-01T00:00:00Z"
}]
},
"metadata": []
}
Method Name - GetPatientCondition
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetPatientCondition At least PersonID or PatientConditionID is required for this method. Only passing in the PersonID, will return the conditions linked to the patient. Only passing in the PatientConditionID, will return the specific condition.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| PatientConditionID | Guid | No | |
| PersonID | Guid | No |
Get Patient Document
Example Request Body:
{
"MethodName": "GetPatientDocument",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098"
}
]
}
Success Response:
StatusCode: 200
"results": {
"1": [{
"documentImageID": "2e0c4ee2-3817-429a-822b-27be5e3d11a8",
"documentOwnerID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"documentImageTypeScopeID": 1,
"documentImageTypeScopeText": "Patient",
"documentName": "post it note from patient",
"documentDescription": "Notes about patient",
"documentFileName": ""
"documentImage": "",
"documentCreatedOn": "2021-02-01T12:16:57Z",
"documentChangedOn": "2021-02-01T12:16:57Z",
"documentImageTypeID": "e2e5d30a-73e0-486b-bf57-714c572975ac",
"documentImageTypeText": "Patient Profile",
"documentImageMethodID": 0,
"documentImageMethodText": "Unknown",
"createdBy": "3c21ddeb-dd94-4bf3-9688-e16b8c1af8f3",
"isDeleted": 0
}, {
"documentImageID": "f6fdb66b-fd7b-4a89-9228-9101e164595f",
"documentOwnerID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"documentImageTypeScopeID": 1,
"documentImageTypeScopeText": "Patient",
"documentName": "Other",
"documentDescription": "Patient pets",
"documentFileName": "alligator-feeding-frenzy.jpg"
"documentImage": "",
"documentCreatedOn": "2021-02-01T12:12:15Z",
"documentChangedOn": "2021-02-01T12:12:15Z",
"documentImageTypeID": "71e62554-c84a-4897-abdd-0fcf451ddcf1",
"documentImageTypeText": "Other",
"documentImageMethodID": 0,
"documentImageMethodText": "Unknown",
"createdBy": "3c21ddeb-dd94-4bf3-9688-e16b8c1af8f3",
"isDeleted": 0
}]
},
"metadata": []
}
Method Name - GetPatientDocument
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetPatientDocument At least PersonID or DocumentImageID is required for this method. Only passing in the PersonID, will return the documents linked to the patient with out the DocumentImage data in the results. In order to get the actual DocumentImage data, you will have to pass in the DocumentImageID. This will return the specific document information with the actual date in DocumentImage data. The field DocumentImage is returned as a encoded Base64 string.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| DocumentImageID | Guid | No | |
| PersonID | Guid | No |
Get Patient Facility
Example Request Body:
{
"MethodName": "GetPatientFacility",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"patientFacility": [{
"patientFacilityID": "af5e9ff4-3ac3-4d16-bebc-6a1a0bb2ca63",
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"facilityID": "76ff6562-35c3-4c7c-b106-ecff36c82991",
"facilityName": "NEW BAPTIST",
"facilityGroup": "NB",
"facilityWingID": "42ea2974-9c2a-40ed-905c-ca3fa11fe7c3",
"facilityWingText": "Default",
"admittedOn": "2019-09-26T00:00:00Z",
"dischargedOn": "2020-09-28T23:59:59Z",
"roomNumber": "12B",
"bed": "Window",
"medicalRecordNumber": "MRN12345",
"PrescriberIDPrimary": "B072AAC4-FB40-4D1E-A992-C74FC2121AED",
"PrescriberIDAlternate": "1D3A267D-9E1C-440B-8087-DC9D442AEF88",
"FacilityCycleFillID": "C2FFB960-7ACE-484A-9A5C-6DA079297537"
}, {
"patientFacilityID": "cef1883e-414c-4963-9088-65529172c3f4",
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"facilityID": "31105ed7-fd31-4e81-b4fc-9cb70def0f11",
"facilityName": "CARDINAL HOME",
"facilityGroup": "CARDINAL",
"facilityWingID": "035a4bc3-5aa3-41a7-a493-dada5c94d1c6",
"facilityWingText": "Default",
"admittedOn": "2020-09-29T00:00:00Z"
}]
},
"metadata": []
}
Method Name - GetPatientFacility
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetPatientFacility At least PersonID or PatientFacilityID is required for this method. Only passing in the PersonID, will return a history of facilites for that patient. The row with out a discharge date, will be the current facility for that patient. Only passing in the PatientFacilityID, will return the specific patient facility row.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| PatientFacilityID | Guid | No | |
| PersonID | Guid | No |
Get Patient Inventory Group
Example Request Body:
{
"MethodName": "GetPatientInventoryGroup",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"patientInventoryGroup": [
{
"inventoryGroupTypeID": "a3563e34-5da9-42de-b33b-0a4ad7f5fc2b",
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"inventoryGroupTypeText": "340B",
"isActive": 1,
"externalID": "340B-X14"
}
]
},
"metadata": []
}
Method Name - GetPatientInventoryGroup
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetPatientInventoryGroup At least PersonID or InventoryGroupTypeID is required for this method. Only passing in the PersonID, will list of inventory groups preferred by the patient. Only passing in the InventoryGroupTypeID, will return the specific preferred inventory group.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| InventoryGroupTypeID | Guid | No | |
| PersonID | Guid | No |
Get Patient Other Medication
Example Request Body:
{
"MethodName": "GetPatientOtherMedication",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"patientOtherMedication": [{
"patientOtherMedicationID": "7b8591d0-5368-4faf-85d7-c2c2771d70e9",
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"otherMedicationSourceTypeID": 1,
"otherMedicationSourceTypeText": "Patient",
"otherMedicationTypeID": 1,
"otherMedicationTypeText": "Rx",
"ndc": "00054429731",
"medicationName": "Furosemide 20 Mg Tablet",
"directions": "T1T QD PRN TY ",
"directionsTranslated": "TAKE ONE TABLET EVERY DAY AS NEEDED **THANK YOU**",
"isPrn": 1,
"startedOnUtc": "2020-12-01T06:00:00Z",
"asOfDateUtc": "2021-02-17T06:00:00Z",
"comment": "Patient provided details about drug she was taking from a mail order pharmacy, required by her insurance",
"otherMedicationStatusTypeID": 1,
"otherMedicationStatusTypeText": "Active",
"statusChangedOnUtc": "2021-02-17T06:00:00Z",
"prescriberID": "d90929f1-ec91-4e13-9af2-c549e4eae3a2",
"rxNumber": 123424234,
"lastDateFilledUtc": "2021-01-12T12:00:00Z",
"refillsRemaining": 2,
"lastQuantityDispensed": 30.000000,
"daysSupply": 30,
"icD10Primary": "L75.8",
"icD10PrimaryShortDescription": "Other apocrine sweat disorders ",
"externalPharmacyID": "05cc5f2e-7de7-4c70-a5fb-7d027430443b"
}, {
"patientOtherMedicationID": "f497e51d-0d3f-41d6-a22e-81ff7e90ab0f",
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"otherMedicationSourceTypeID": 1,
"otherMedicationSourceTypeText": "Patient",
"otherMedicationTypeID": 2,
"otherMedicationTypeText": "OTC/Supplement",
"ndc": "07431200530",
"medicationName": "VIT B COMPLEX WITH C TAB",
"directions": "qd ",
"directionsTranslated": "EVERY DAY",
"isPrn": 0,
"asOfDateUtc": "2021-02-17T06:00:00Z",
"otherMedicationStatusTypeID": 1,
"otherMedicationStatusTypeText": "Active",
"statusChangedOnUtc": "2021-02-17T06:00:00Z",
"lastQuantityDispensed": 0.000000
}]
},
"metadata": []
}
Method Name - GetPatientOtherMedication
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetPatientOtherMedication At least PersonID or PatientOtherMedicationID is required for this method. Only passing in the PersonID, will return the other medications linked to the patient. Only passing in the PatientOtherMedicationID, will return the specific other medication.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| PatientOtherMedicationID | Guid | No | |
| PersonID | Guid | No |
Get Patient Pay Method
Example Request Body:
{
"MethodName": "GetPatientPayMethod",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"patientPayMethod": [{
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"patientPayMethodID": "f03c9044-d9c3-4f37-9b2f-b49d9746c6fa",
"payMethodTypeID": 2,
"payMethodTypeText": "Third Party",
"billingOrder": "O",
"priority": 3,
"autoSelect": 0,
"thirdPartyID": "6672648a-4227-467b-9168-5f7217714fda",
"thirdPartyName": "Omnisys BCBSNC Advantage",
"thirdPartyPrintName": "Omnisys BCBSNC Advantage (Plant)",
"submissionTypeID": 2,
"submissionTypeText": "Manual",
"isTransmitted": 0,
"pcnUserDefined": 0,
"cardHolderID": "BR549",
"patientRelationshipTypeID": 8,
"patientRelationshipTypeText": "Significant Other",
"ncpdpCode": 8,
"cardHolderPersonID": "8052b925-cbc5-4a92-91dd-58b8207906af",
"cardHolderLastNameFirst": "GrandPaw, The",
"relationCode": "03",
"groupNumber": "J7",
"groupNumberUserDefined": 1,
"startDate": "2021-02-16T00:00:00Z",
"patientLocationTypeID": 3,
"patientLocationTypeText": "Nursing Home",
"eligibilityClarificationTypeID": 3,
"eligibilityClarificationTypeText": "Full Time Student",
"placeOfResidenceTypeID": 2,
"placeOfResidenceTypeText": "Skilled Nursing Facility",
"placeOfServiceTypeID": 1,
"placeOfServiceTypeText": "Pharmacy",
"informationalComment": "Card from father.\r\n",
"mtmEligible": 1,
"nonPartDConfirmed": 0,
"changedOn": "2021-02-17T14:03:34Z",
"changedByID": "3c21ddeb-dd94-4bf3-9688-e16b8c1af8f3",
"changedByName": "PioneerRx Support",
"changedAtID": "c836fe41-9457-484b-a3c5-48abe244e429",
"changedAtLocation": "PioneerRx Pharmacy"
}, {
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"patientPayMethodID": "1b238638-f3a6-4479-8de5-ee00544dba6b",
"payMethodTypeID": 2,
"payMethodTypeText": "Third Party",
"billingOrder": "P",
"priority": 1,
"autoSelect": 1,
"thirdPartyID": "d7322432-4198-4f7f-a525-818d141260dd",
"thirdPartyName": "Blue Cross Blue Shield",
"bin": "610014",
"submissionTypeID": 1,
"submissionTypeText": "Transmitted",
"isTransmitted": 1,
"displayName": "Blue Cross Blue Shield of Tx",
"pcnUserDefined": 0,
"cardHolderID": "1234567890",
"patientRelationshipTypeID": 1,
"patientRelationshipTypeText": "Cardholder",
"ncpdpCode": 1,
"cardHolderPersonID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"cardHolderLastNameFirst": "Reedman, Timothy M",
"relationCode": "01",
"groupNumber": "GR1",
"groupNumberUserDefined": 1,
"startDate": "2021-01-01T00:00:00Z",
"patientLocationTypeID": 1,
"patientLocationTypeText": "Home",
"eligibilityClarificationTypeID": 0,
"eligibilityClarificationTypeText": "Not Specified",
"placeOfResidenceTypeID": 1,
"placeOfResidenceTypeText": "Home",
"placeOfServiceTypeID": 1,
"placeOfServiceTypeText": "Pharmacy",
"informationalComment": "This is here card for Tx\r\n",
"mtmEligible": 0,
"nonPartDConfirmed": 0,
"changedOn": "2021-02-17T14:00:25Z",
"changedByID": "3c21ddeb-dd94-4bf3-9688-e16b8c1af8f3",
"changedByName": "PioneerRx Support",
"changedAtID": "c836fe41-9457-484b-a3c5-48abe244e429",
"changedAtLocation": "PioneerRx Pharmacy"
}, {
"personID": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098",
"patientPayMethodID": "91b93626-ec40-4e00-9366-f5fd6f493216",
"payMethodTypeID": 2,
"payMethodTypeText": "Third Party",
"billingOrder": "O",
"priority": 2,
"autoSelect": 0,
"thirdPartyID": "5ecd0aca-f7ef-4cce-986f-e5feff3a5eb3",
"thirdPartyName": "Pharmacy Loyalty Plan",
"bin": "014798",
"submissionTypeID": 1,
"submissionTypeText": "Transmitted",
"isTransmitted": 1,
"displayName": "HBP Loyalty Plan",
"pcn": "RXLOCAL",
"pcnUserDefined": 0,
"patientRelationshipTypeID": 0,
"patientRelationshipTypeText": "Not Specified",
"ncpdpCode": 0,
"cardHolderLastNameFirst": "Reedman, Timothy M",
"groupNumber": "20022111",
"groupNumberUserDefined": 1,
"startDate": "2019-09-26T00:00:00Z",
"patientLocationTypeID": 0,
"patientLocationTypeText": "Not Specified",
"eligibilityClarificationTypeID": 0,
"eligibilityClarificationTypeText": "Not Specified",
"placeOfResidenceTypeID": 0,
"placeOfResidenceTypeText": "Not Specified",
"placeOfServiceTypeID": 1,
"placeOfServiceTypeText": "Pharmacy",
"mtmEligible": 0,
"nonPartDConfirmed": 1,
"changedOn": "2021-02-17T14:00:25Z",
"changedByID": "3c21ddeb-dd94-4bf3-9688-e16b8c1af8f3",
"changedByName": "PioneerRx Support",
"changedAtID": "c836fe41-9457-484b-a3c5-48abe244e429",
"changedAtLocation": "PioneerRx Pharmacy"
}]
},
"metadata": []
}
Method Name - GetPatientPayMethod
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetPatientPayMethod Passing in the PersonID, will return the pay plans linked to the patient.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| ActiveOnly | Int32 | 0 or 1, default is 1. 1=Active pay methods only 0=All pay methods | No |
Get Patient Phone
Example Request Body:
{
"MethodName": "GetPatientPhone",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"phone": [{
"phoneID": "1f60c7a2-d2ae-4b01-9e5d-6f328b8be8e6",
"personID": "82580f62-ceda-4d64-b8fc-e94715f631b4",
"phoneTypeID": "859c2036-74ec-44a6-af73-f72f44c59791",
"phoneTypeText": "Cell",
"displaySequence": 1,
"phoneNumber": "9998881111",
"extention": "x129",
"changedOn": "2016-03-09T13:14:48Z",
"changedAtID": "c836fe41-9457-484b-a3c5-48abe244e429",
"changedAtLocation": "PRX Pharmacy (Scrambled)"
}]
},
"metadata": []
}
Method Name - GetPatientPhone
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetPatientPhone At least PersonID or PhoneID is required for this method. Only passing in the PersonID, will return the phones linked to the patient. Only passing in the PhoneID, will return the specific phone.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| PersonID | Guid | No | |
| PhoneID | Guid | No |
Get Patient Profile
Example Request Body:
{
"MethodName": "GetPatientProfile",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "80bdf06d-5b33-443f-bed6-d910bb071ae1"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"patientProfile": [{
"rxID": "3e0a8324-0fd0-458e-b9b4-8baf1a0d7396",
"rxNumber": 7511785,
"patientID": "80bdf06d-5b33-443f-bed6-d910bb071ae1",
"itemName": "Androgel 1.62% Gel Pump",
"gcn": "67366",
"numberOfRefillsAllowed": 3,
"refillsLeft": 3,
"prescribedQualtity": 600.000000,
"prescribedQuantity": 150.000000,
"totalPrescribedQuantity": 600.000000,
"dispensedQuantity": 0.000000,
"quantityLeft": 600.000000,
"lastFilled": "2020-08-05T00:00:00Z",
"expirationDate": "2021-02-01T00:00:00Z",
"lastPayMethod": "CASH",
"typeText": "Active",
"statusText": "On Hold: 08-05-20",
"rxStatusTypeEnum": 8,
"isActive": 1,
"refillDueLimit": 7.000000,
"directions": "APL 2 PUMPS TOPICALLY QD ",
"prescriberName": "Reid, John",
"prescriberID": "db3ef217-b98f-4e9a-86c7-405258a3107a",
"patientName": "Adams, Myrtle",
"readyToFillState": 0,
"fillState": "FH - Fillable on Hold",
"fillStateColor": 3,
"defaultSortDate": "2020-08-05T00:00:00Z",
"dispensedItemName": "Testosterone 1.62% Gel Pump",
"dispensedNdc": "24979007815",
"dispensedManufacturer": "Twi Pharmaceuti",
"dateWritten": "2020-08-05T00:00:00Z",
"nextFillDate": "2020-09-04T00:00:00Z",
"daysSupplyEndsOn": "2020-09-04T00:00:00Z",
"priorityTypeText": "Delivery",
"cycleFill": 0,
"patientDaysSupplyEndsOn": "2020-09-04T16:48:53Z",
"rxtransactionIDForReporting": "1e5b336f-51a5-4b44-b936-40fb20c4d0e5",
"isPrn": 0,
"deaSchedule": 3,
"deaControlTypeAbbreviation": "C",
"autoRefill": "No",
"originTypeID": 5,
"originTypeText": "Electronic",
"isCompound": "No",
"inventoryGroup": "Rx",
"rxTransactionCompletedDate": "2020-08-05T16:48:53Z",
"daysSincePickup": 6,
"gross Profit": 0.0000,
"escriptID": "b599e76b-90bd-4956-8aad-b560a2014bbf",
"promise Time": "2020-08-05T14:00:00Z",
"delivery Zone": "FIVE MILES OR LESS",
"patient Primary Category": "CCNC",
"directions Translated": "APPLY TWO PUMPS TOPICALLY EVERY DAY",
"fill Critical Comment": "",
"therapeutic Class Code": 68080000.0,
"therapeutic Class Description": "ANDROGENS",
"delivery Method": "Driver",
"label Type": "Generic",
"checked By": "",
"medicationTypeID": 1
}, {
"rxID": "16f8945c-6c29-4cab-866f-76a3df20e3ef",
"rxTransactionID": "521e6692-5eea-4fc3-803b-57e0e752bc1b",
"rxNumber": 7484152,
"patientID": "80bdf06d-5b33-443f-bed6-d910bb071ae1",
"itemName": "Losartan 100 Mg Tablet",
"gcn": "38686",
"numberOfRefillsAllowed": 0,
"numberOfRefillsFilled": 1,
"refillNumber": 0,
"refillsLeft": 0,
"prescribedQualtity": 30.000000,
"prescribedQuantity": 30.000000,
"totalPrescribedQuantity": 30.000000,
"dispensedQuantity": 30.000000,
"quantityLeft": 0.000000,
"daysSupply": 30,
"lastFilled": "2019-12-09T00:00:00Z",
"daysSinceLastFill": 246,
"lastPrice": 3.7800,
"expirationDate": "2020-10-25T00:00:00Z",
"lastPayMethod": "BC/BS Medicare",
"typeText": "Inactive",
"statusText": "Renew Pending (08-05-20): Expired or No Refills: 08-05-20",
"rxStatusTypeEnum": 3,
"isActive": 0,
"refillDueLimit": 7.000000,
"rxTransactionStatusText": "Completed",
"completedDate": "2019-12-09T13:06:39Z",
"lastFilledWithDays": "12/09/2019 (246)",
"directions": "T1T PO QD ",
"prescriberName": "Reid, John",
"prescriberID": "db3ef217-b98f-4e9a-86c7-405258a3107a",
"patientPaidAmount": 3.7800,
"patientName": "Adams, Myrtle",
"readyToFillState": 0,
"fillState": "CPR - Currently Processing Renewal",
"fillStateColor": 6,
"statusTypeEnum": 10,
"defaultSortDate": "2019-12-09T00:00:00Z",
"dispensedItemName": "Losartan Potassium 100 Mg Tab",
"lastDispensedQuantity": "30",
"acquisitionCost": 8.2784,
"dispensedNdc": "31722070210",
"dispensedManufacturer": "Camber Pharmace",
"dateWritten": "2019-10-26T00:00:00Z",
"daysSupplyEndsOn": "2020-01-08T00:00:00Z",
"priorityTypeText": "Returning",
"rxRenewStatusTypeText": "Renew Pending",
"cycleFill": 0,
"thirdPartyPayableOn": "2020-01-01T00:00:00Z",
"patientDaysSupplyEndsOn": "2020-01-08T13:06:39Z",
"rxRenewStatusTypeEnum": 1,
"rxtransactionIDForReporting": "521e6692-5eea-4fc3-803b-57e0e752bc1b",
"isPrn": 0,
"deaControlTypeAbbreviation": " ",
"lastQuantityDispensed": 30.00000,
"autoRefill": "No",
"originTypeID": 2,
"originTypeText": "Phone-In",
"isCompound": "No",
"inventoryGroup": "Rx",
"rxTransactionCompletedDate": "2019-12-09T13:06:39Z",
"daysSincePickup": 246,
"gross Profit": -4.4984,
"scriptImageID": "a7d13568-1ac4-4c2a-8c7e-8b557f6677d1",
"promise Time": "2019-12-09T09:47:00Z",
"delivery Zone": "FIVE MILES OR LESS",
"patient Primary Category": "CCNC",
"directions Translated": "TAKE ONE TABLET BY MOUTH EVERY DAY",
"fill Critical Comment": "",
"therapeutic Class Code": 24320800.0,
"therapeutic Class Description": "ANGIOTENSIN II RECEPTOR ANTAGONISTS",
"delivery Method": "Driver",
"label Type": "Generic",
"checked By": "Cobel, Jerry",
"medicationTypeID": 1
}, {
"rxID": "b607997f-300f-4ccc-9214-64d398e4e55e",
"rxNumber": 7454950,
"patientID": "80bdf06d-5b33-443f-bed6-d910bb071ae1",
"itemName": "Sildenafil (pulmonary Hypertension) 20 Mg Tablet",
"gcn": "59211",
"numberOfRefillsAllowed": 1,
"refillsLeft": 1,
"prescribedQualtity": 100.000000,
"prescribedQuantity": 50.000000,
"totalPrescribedQuantity": 100.000000,
"dispensedQuantity": 0.000000,
"quantityLeft": 100.000000,
"expirationDate": "2019-12-20T00:00:00Z",
"lastPayMethod": "CASH",
"typeText": "Inactive",
"statusText": "Expired or No Refills: 12-21-19",
"rxStatusTypeEnum": 3,
"isActive": 0,
"refillDueLimit": 7.000000,
"directions": "TAKE 1-5 TABS PO 1 HOUR AHEAD OF TIME. MAX OF 1T DAILY. ",
"prescriberName": "Reid, John",
"prescriberID": "db3ef217-b98f-4e9a-86c7-405258a3107a",
"patientName": "Adams, Myrtle",
"readyToFillState": 0,
"fillState": "NR - No Refills",
"fillStateColor": 0,
"defaultSortDate": "2018-12-20T00:00:00Z",
"dispensedItemName": "Sildenafil 20 Mg Tablet",
"dispensedNdc": "33342012110",
"dispensedManufacturer": "Macleods Pharma",
"dateWritten": "2018-12-20T00:00:00Z",
"priorityTypeText": "Returning",
"cycleFill": 0,
"rxtransactionIDForReporting": "038575c4-57bf-4c84-aebb-81f7af014704",
"isPrn": 0,
"deaControlTypeAbbreviation": " ",
"autoRefill": "No",
"originTypeID": 5,
"originTypeText": "Electronic",
"isCompound": "No",
"inventoryGroup": "Rx",
"gross Profit": 0.0000,
"escriptID": "7eae0da4-8e68-489f-a581-b3b9ac6aaaa5",
"promise Time": "2018-12-20T14:25:00Z",
"delivery Zone": "FIVE MILES OR LESS",
"patient Primary Category": "CCNC",
"directions Translated": "TAKE 1-5 TABLETS BY MOUTH ONE HOUR AHEAD OF TIME. MAX OF ONE TABLET DAILY.",
"fill Critical Comment": "",
"therapeutic Class Code": 24121200.0,
"therapeutic Class Description": "PHOSPHODIESTERASE TYPE 5 INHIBITORS",
"delivery Method": "Driver",
"label Type": "Generic",
"checked By": "",
"medicationTypeID": 1
}]
},
"metadata": []
}
Method Name - GetPatientProfile
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetPatientProfile This method will return the patient profile as it does in the UI.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| PatientProfileShow | Int32 | Defaults to your pharmacy location settings, valid values are: 0 (All) 1 (Active) 2 (Expired Last 90 Days) 3 (Expired) 4 (Filled in Last 90 Days) 5 (Active and Expired) | No |
| PatientProfileYears | Int32 | Defaults to your pharmacy location settings, valid values are: 0 (All), 1,...99 A common value for most pharmacies is 2 years. | No |
Search Patient
Example Request Body:
{
"MethodName": "SearchPatient",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "LastName",
"Value": "alb%"
},
{
"Name": "FirstName",
"Value": "will%"
},
{
"Name": "Gender",
"Value": "M"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"patients": [{
"personID": "82580f62-ceda-4d64-b8fc-e94715f631b4",
"sSN": "123456789",
"sSNLastFour": "6789",
"alternateID": "ALT12",
"externalID": "EX12345",
"serialNumberPerson": 36428,
"personIdentityLocal": 14075,
"legacyNumber": "AWILLIAM14",
"firstName": "William",
"middleName": "J",
"lastName": "Albritton",
"dateOfBirth": "1951-11-04T00:00:00Z",
"gender": "M",
"primaryAddressID": "78cb0051-b89b-4dfe-bccf-015eab615462",
"primaryAddressTypeID": "00000000-0000-0000-0000-000000000000",
"primaryAddressTypeText": "Primary",
"primaryAddress": "120 Neiborhood Dr",
"primaryCity": "SomeCity",
"primaryStateCode": "GA",
"primaryZipCode": "39999-8888",
"emailAddress":"someone@something.ccc",
"primaryPhoneID": "1f60c7a2-d2ae-4b01-9e5d-6f328b8be8e6",
"primaryPhoneTypeID": "859c2036-74ec-44a6-af73-f72f44c59791",
"primaryPhoneTypeText": "Cell",
"primaryPhoneNumber": "9118880001",
"primaryExtension": "x19",
"statusTypePatientID": "eba0f507-7995-4481-8c30-77c9edbf9a63",
"statusTypePatientText": "Active",
"isActive": 1,
"atStore": true
}, ]
},
"metadata": []
}
Method Name - SearchPatient
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - SearchPatient Besides the required parameter RequestedByEmployeeID, at least one other parameter is required. When multiple parameters are specified, all criteria must be met (AND condition). You may also use the % in a parameter as a wildcard. When the % is used, the LIKE condition is used vs the EQUAL condition. **Note, for those of you on our Central Office, you will need to watch for the result element called "AtStore". When this value is true, that means, this patient is already loaded at the current location. When this value is false, that means this patient is available from the central office patient master list. At this time, we are working on a method to add the patient from central. As of now, it is not available.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| AlternateID | String(200) | No | |
| CentralKey | Int32 | No | |
| DateOfBirth | Date | No | |
| EmailAddress | String(255) | No | |
| ExternalID | String(200) | No | |
| FirstName | String(200) | No | |
| Gender | String(1) | M or F | No |
| IsActive | Int32 | 0 or 1, default is 1. 1=Active patient statuses only 0=All patient statuses | No |
| LastName | String(200) | No | |
| LegacyNumber | String(200) | No | |
| MiddleName | String(200) | No | |
| PersonID | Guid | No | |
| PersonIdentityLocal | Int32 | No | |
| PrimaryAddress | String(200) | No | |
| PrimaryCity | String(200) | No | |
| PrimaryPhoneNumber | String(200) | No | |
| PrimaryStateCode | String(2) | No | |
| PrimaryZipCode | String(200) | No | |
| SerialNumberPerson | Int32 | No | |
| SSNLastFour | String(4) | No |
Employee
Employee Search
Example Request Body:
{
"MethodName": "EmployeeSearch",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "2005"
},
{
"Name": "EmployeeID",
"Value": "%5%"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"employees": [
{
"personID": "d18fdce3-e8dd-4c20-8ba4-3593b5990ff2",
"employeeID": "50972",
"lastName": "Walker",
"firstName": "Johnny",
"logonName": "jwalker",
"employeeTypeID": "12200be5-0c58-4a38-9550-cda2ea6d4e84",
"employeeTypeText": "Employee",
"createdOn": "2022-03-22T08:51:45Z",
"dateOfBirth": "1967-11-27T00:00:00Z",
"emailAddress": "j.walk@gmail.com",
"primaryAddress": "555 Market St",
"primaryCity": "SomeCity",
"primaryState": "NC",
"primaryZipCode": "88554-1715",
"primaryPhone": "7776664444",
"statusTypeEmployeeID": "2df87f4f-edaa-4d1a-b464-da5c7e99a7b6",
"statusTypeEmployeeText": "Active",
"isActive": 1
},
{
"personID": "0d1937c0-e2a3-456c-b822-a5ecea2e19b4",
"employeeID": "P12539",
"lastName": "Doe",
"firstName": "Jane",
"logonName": "jdoe",
"employeeTypeID": "4ad485cd-41e2-4250-b674-bca7f471873d",
"employeeTypeText": "Pharmacist",
"hireDate": "2019-11-01T00:00:00Z",
"createdOn": "2019-11-01T08:11:22Z",
"dateOfBirth": "1964-02-13T00:00:00Z",
"emailAddress": "jdoe@gmail.com",
"primaryAddress": "134 Morning Dove Rd",
"primaryCity": "Vidalia",
"primaryState": "SC",
"primaryZipCode": "95420",
"primaryPhone": "4449998888",
"statusTypeEmployeeID": "2df87f4f-edaa-4d1a-b464-da5c7e99a7b6",
"statusTypeEmployeeText": "Active",
"isActive": 1
}
]
},
"metadata": []
}
Method Name - EmployeeSearch
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - EmployeeSearch This will return a list of employees, based on the criteria you provide for the search. When multiple parameters are specified, all criteria must be met (AND condition). You may also use the % in a parameter as a wildcard. When the % is used, the LIKE condition is used vs the EQUAL condition.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| DateOfBirth | DateTime | No | |
| EmployeeID | AnsiString(20) | No | |
| EmployeeTypeID | Guid | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 63, found under Read, Other. | No |
| FirstName | AnsiString(200) | No | |
| IsActive | Int32 | 0 or 1, default is 1. 1=Active External Location statuses only 0=All External Location statuses | No |
| LastName | AnsiString(200) | No | |
| LogonName | AnsiString(50) | No | |
| PrimaryAddress | AnsiString(200) | No | |
| PrimaryCity | AnsiString(200) | No | |
| PrimaryPhoneNumber | AnsiString(200) | No | |
| PrimaryStateCode | AnsiStringFixedLength(2) | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 5, found under Read, Other. | No |
| PrimaryZipCode | AnsiString(200) | No |
Get Employee
Example Request Body:
{
"MethodName": "GetEmployee",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "PersonID",
"Value": "410c4b88-4d1e-489d-9b40-823cd4f72851"
},
{
"Name": "RequestedByEmployeeID",
"Value": "7700"
}
]
}
Method Name - GetEmployee
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes |
Get Employee Address
Example Request Body:
{
"MethodName": "GetEmployeeAddress",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "6556"
}
]
}
Method Name - GetEmployeeAddress
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | Yes | |
| AddressID | Guid | No | |
| PersonID | Guid | No |
Get Employee Category
Example Request Body:
{
"MethodName": "GetEmployeeCategory",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "6617"
}
]
}
Method Name - GetEmployeeCategory
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | Yes | |
| CategoryID | Guid | No | |
| PersonID | Guid | No |
Get Employee Document
Example Request Body:
{
"MethodName": "GetEmployeeDocument",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "9720"
}
]
}
Method Name - GetEmployeeDocument
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | Yes | |
| DocumentImageID | Guid | No | |
| PersonID | Guid | No |
Get Employee Phone
Example Request Body:
{
"MethodName": "GetEmployeePhone",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "7526"
}
]
}
Method Name - GetEmployeePhone
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | Yes | |
| PersonID | Guid | No | |
| PhoneID | Guid | No |
Get Employee Role
Example Request Body:
{
"MethodName": "GetEmployeeRole",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "3527"
}
]
}
Method Name - GetEmployeeRole
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | Yes | |
| AuthorizedGroupID | Guid | No | |
| PersonAuthorizedGroupID | Guid | No | |
| PersonID | Guid | No |
Prescriber
Get Prescriber
Example Request Body:
{
"MethodName": "GetPrescriber",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "2005"
},
{
"Name": "PersonID",
"Value": "7f52849c-0b63-448f-8fd0-dfe76c053945"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"prescriber": [
{
"personID": "7f52849c-0b63-448f-8fd0-dfe76c053945"
, "npi": "9999888801"
, "dea": "FK1234567"
, "upin": "12345"
, "stateLicense": "7891452"
, "eScriptRoutingNumber": "1234567891005"
, "alternateID": "BF594"
, "externalID": "BR549"
, "serialNumberPerson": 46639
, "personIdentityLocal": 36756
, "suboxoneDEA": "SB1234237"
, "firstName": "Johnny"
, "lastName": "Walker"
, "initials": "JW"
, "printName": "Dr. JOHNNY WALKER"
, "printNameUserDefined": 0
, "prescriberTypeID": "d139410d-1df9-4f25-afff-f6f35f4e4c30"
, "prescriberTypeText": "M.D."
, "prescriberTypePrefix": "Dr."
, "groupCode": "The Free Clinic"
, "websiteAddress": "www.jw.com"
, "marketerID": "b3f4d1c4-c046-4938-b26a-895f120f33f0"
, "emailAddress": "jw@junk.com"
, "primaryAddressID": "f1fe0241-6d42-46b1-ae52-986dde2d6999"
, "mailingAddressID": "f1fe0241-6d42-46b1-ae52-986dde2d6999"
, "deliveryAddressID": "d501eb45-6692-4dfd-8938-f1682e3796eb"
, "primaryPhoneID": "59df68c0-a6ef-46fb-b9d5-d4832655cec2"
, "primaryFaxID": "e6120815-5191-468d-a2ff-dc341465a3e5"
, "classification": "Orthopaedic Surgery"
, "renewMethodTypeID": 3
, "renewedMethodTypeText": "Surescript"
, "doNotEmail": 1
, "doNotPhone": 1
, "doNotFax": 1
, "submitRenewalRequestDaysBeforeSupplyEnds": 10
, "primaryCategoryID": "7b9fe8f3-bac8-46e0-875d-ce1bfbbcf6d1"
, "statusTypePrescriberID": "b105bbca-6ce0-439a-a7eb-bbc570895ebf"
, "statusTypePrescriberText": "Active"
, "isActive": 1
, "createdOn": "2023-08-03T10:23:54Z"
, "changedOn": "2024-02-13T12:45:43Z"
, "changedByID": "3c21ddeb-dd94-4bf3-9688-e16b8c1af8f3"
, "changedByName": "Any Employee"
, "changedAtID": "9e2fc1f9-8c42-4f0b-9f14-595cf835bd7c"
, "changedAtLocation": "PRX Pharmacy (Scrambled)"
}
]
, "address": [
{
"addressID": "f1fe0241-6d42-46b1-ae52-986dde2d6999"
, "personID": "7f52849c-0b63-448f-8fd0-dfe76c053945"
, "addressTypeID": "00000000-0000-0000-0000-000000000000"
, "addressTypeText": "Primary"
, "displaySequence": 0
, "address": "951 Mocking Bird Ln"
, "city": "Statesville"
, "stateCode": "NC"
, "zipCode": "99999-1234"
, "country": "USA"
, "changedOn": "2024-02-13T12:45:41Z"
, "changedByID": "3c21ddeb-dd94-4bf3-9688-e16b8c1af8f3"
, "changedByName": "PioneerRx Support"
, "changedAtID": "9e2fc1f9-8c42-4f0b-9f14-595cf835bd7c"
, "changedAtLocation": "PRX Pharmacy (Scrambled)"
}
, {
"addressID": "d501eb45-6692-4dfd-8938-f1682e3796eb"
, "personID": "7f52849c-0b63-448f-8fd0-dfe76c053945"
, "addressTypeID": "2c97fb10-d0df-4a89-89a5-8cd7a1dc46fa"
, "addressTypeText": "Other"
, "displaySequence": 1
, "address": "108 Lee Ave"
, "city": "Vidalia"
, "stateCode": "LA"
, "zipCode": "71373-3703"
, "country": "USA"
, "changedOn": "2024-02-13T12:45:40Z"
, "changedAtID": "9e2fc1f9-8c42-4f0b-9f14-595cf835bd7c"
, "changedAtLocation": "PRX Pharmacy (Scrambled)"
}
]
, "phone": [
{
"phoneID": "59df68c0-a6ef-46fb-b9d5-d4832655cec2"
, "personID": "7f52849c-0b63-448f-8fd0-dfe76c053945"
, "phoneTypeID": "8e62bba1-fda3-4524-ae59-88fa4bb667c4"
, "phoneTypeText": "Other"
, "displaySequence": 1
, "phoneNumber": "7776665555"
, "changedOn": "2023-08-03T10:23:54Z"
, "changedAtID": "9e2fc1f9-8c42-4f0b-9f14-595cf835bd7c"
, "changedAtLocation": "PRX Pharmacy (Scrambled)"
}
, {
"phoneID": "e6120815-5191-468d-a2ff-dc341465a3e5"
, "personID": "7f52849c-0b63-448f-8fd0-dfe76c053945"
, "phoneTypeID": "37fb5391-892c-432e-a41b-6cfd81f60b3e"
, "phoneTypeText": "Primary Fax"
, "displaySequence": 0
, "phoneNumber": "8887776666"
, "changedOn": "2023-08-03T10:23:54Z"
, "changedAtID": "9e2fc1f9-8c42-4f0b-9f14-595cf835bd7c"
, "changedAtLocation": "PRX Pharmacy (Scrambled)"
}
, {
"phoneID": "e04bd9a4-f103-4562-a3ab-7ea95b12b2bd"
, "personID": "7f52849c-0b63-448f-8fd0-dfe76c053945"
, "phoneTypeID": "859c2036-74ec-44a6-af73-f72f44c59791"
, "phoneTypeText": "Cell"
, "displaySequence": 2
, "phoneNumber": "5558889999"
, "changedOn": "2024-02-13T12:45:41Z"
, "changedAtID": "9e2fc1f9-8c42-4f0b-9f14-595cf835bd7c"
, "changedAtLocation": "PRX Pharmacy (Scrambled)"
}
]
, "category": [
{
"categoryID": "3eeed756-06e7-46af-881e-869677dfe416"
, "personID": "7f52849c-0b63-448f-8fd0-dfe76c053945"
, "categoryText": "Likes Money"
, "isAutoFilter": 0
}
, {
"categoryID": "7b9fe8f3-bac8-46e0-875d-ce1bfbbcf6d1"
, "personID": "7f52849c-0b63-448f-8fd0-dfe76c053945"
, "categoryText": "Special Doctor"
, "isAutoFilter": 0
}
]
, "medicaidLicenses": []
, "patientInventoryGroup": [
{
"inventoryGroupTypeID": "0c505900-13fd-45a6-a8eb-39788ca5f86e"
, "personID": "7f52849c-0b63-448f-8fd0-dfe76c053945"
, "inventoryGroupTypeText": "340B"
, "isActive": 1
, "externalID": ""
}
]
}
, "metadata": []
}
Method Name - GetPrescriber
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetPrescriber GetPrescriber will return the prescriber information. It will also return the results from methods GetPrescriberAddress, GetPrescriberPhone, GetPrescriberCategory, GetPrescriberInventoryGroup, GetPrescriberMedicaidLicenses
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
Get Prescriber Address
Example Request Body:
{
"MethodName": "GetPrescriberAddress",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "7285"
}
]
}
Method Name - GetPrescriberAddress
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | Yes | |
| AddressID | Guid | No | |
| PersonID | Guid | No |
Get Prescriber Category
Example Request Body:
{
"MethodName": "GetPrescriberCategory",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "5038"
}
]
}
Method Name - GetPrescriberCategory
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | Yes | |
| CategoryID | Guid | No | |
| PersonID | Guid | No |
Get Prescriber Document
Example Request Body:
{
"MethodName": "GetPrescriberDocument",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "3850"
}
]
}
Method Name - GetPrescriberDocument
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | Yes | |
| DocumentImageID | Guid | No | |
| PersonID | Guid | No |
Get Prescriber Inventory Group
Example Request Body:
{
"MethodName": "GetPrescriberInventoryGroup",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "4851"
}
]
}
Method Name - GetPrescriberInventoryGroup
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | Yes | |
| InventoryGroupTypeID | Guid | No | |
| PersonID | Guid | No |
Get Prescriber Medicaid Licenses
Example Request Body:
{
"MethodName": "GetPrescriberMedicaidLicenses",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "9424"
}
]
}
Method Name - GetPrescriberMedicaidLicenses
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | Yes | |
| PersonID | Guid | No | |
| PrescriberStateMedicaidLicenseID | Guid | No |
Get Prescriber Phone
Example Request Body:
{
"MethodName": "GetPrescriberPhone",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "704"
}
]
}
Method Name - GetPrescriberPhone
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | Yes | |
| PersonID | Guid | No | |
| PhoneID | Guid | No |
Prescriber Search
Example Request Body:
{
"MethodName": "PrescriberSearch",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "LastName",
"Value": "Walk%"
},
{
"Name": "FirstName",
"Value": "J%"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"prescribers": [
{
"personID": "4f70b79f-53f6-442e-9288-3691db21c01b"
, "prescriberTypeID": "d139410d-1df9-4f25-afff-f6f35f4e4c30"
, "prescriberTypeText": "M.D."
, "firstName": "Johnny"
, "middleName": "X"
, "lastName": "Walker"
, "printName": "Dr. Johnny Walker"
, "groupCode": "ClinicNextDoor"
, "dea": "JW1234567"
, "deaSuffix": "XR7"
, "suboxoneDEA": "XX0699999"
, "suboxoneDEASuffix": "XXXR7"
, "alternateID": "BR549"
, "externalID": "JWBR549"
, "legacyNumber": ""
, "serialNumberPerson": 24717
, "personIdentityLocal": 9737
, "eScriptRoutingNumber": "8888888888001"
, "npi": "9994447771"
, "stateLicense": "2007 01764"
, "primaryAddressID": "cfec2aca-f871-4eb5-8761-87838824d185"
, "primaryAddressTypeID": "00000000-0000-0000-0000-000000000000"
, "primaryAddressTypeText": "Primary"
, "primaryAddress": "11230 Walker Rd"
, "primaryCity": "Shreveport"
, "primaryStateCode": "LA"
, "primaryZipCode": "12345-3736"
, "emailAddress": "docjw@junk.com"
, "primaryPhoneID": "55465d59-2444-4d10-924c-478ed03cfb0b"
, "primaryPhoneTypeID": "8e62bba1-fda3-4524-ae59-88fa4bb667c4"
, "primaryPhoneTypeText": "Other"
, "primaryPhoneNumber": "9998887777"
, "primaryPhoneExtension": "12"
, "statusTypePrescriberID": "b105bbca-6ce0-439a-a7eb-bbc570895ebf"
, "statusTypePrescriberText": "Active"
, "isActive": 1
}
]
}
, "metadata": []
}
Method Name - PrescriberSearch
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - PrescriberSearch Besides the required parameter RequestedByEmployeeID, at least one other parameter is required. When multiple parameters are specified, all criteria must be met (AND condition). You may also use the % in a parameter as a wildcard. When the % is used, the LIKE condition is used vs the EQUAL condition.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| AlternateID | AnsiString(200) | No | |
| DEA | AnsiString(9) | No | |
| DEASuffix | AnsiString(10) | No | |
| EmailAddress | AnsiString(255) | No | |
| EscriptRoutingNumber | AnsiString(200) | No | |
| ExternalID | AnsiString(200) | No | |
| FirstName | AnsiString(200) | No | |
| GroupCode | AnsiString(20) | No | |
| IsActive | Int32 | 0 or 1, default is 1. 1=Active prescriber statuses only 0=All prescriber statuses | No |
| LastName | AnsiString(200) | No | |
| LegacyNumber | AnsiString(200) | No | |
| MiddleName | AnsiString(200) | No | |
| NPI | AnsiString(15) | No | |
| PersonID | Guid | No | |
| PersonIdentityLocal | Int32 | No | |
| PrescriberCentralKey | Int32 | No | |
| PrescriberTypeID | Guid | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 58, found under Read, Other. | No |
| PrimaryAddress | AnsiString(200) | No | |
| PrimaryCity | AnsiString(200) | No | |
| PrimaryPhoneNumber | AnsiString(200) | No | |
| PrimaryStateCode | AnsiStringFixedLength(2) | No | |
| PrimaryZipCode | AnsiString(200) | No | |
| SerialNumberPerson | Int32 | No | |
| StateLicense | AnsiString(20) | No | |
| SuboxoneDEA | AnsiString(9) | No | |
| SuboxoneDEASuffix | AnsiString(10) | No |
RX
Get Rx
Example Request Body:
{
"MethodName": "GetRx",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "c4e9338f-7e2d-44a7-9f90-67e9a7a7eaeb"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"rx": [{
"rxID": "bf707003-e8e6-4a25-a6f0-2b4f9c63d673",
"rxNumber": 7242694,
"pharmacistID": "30f7b913-c742-471d-bf07-6a08a1df0ab1",
"personID": "c4e9338f-7e2d-44a7-9f90-67e9a7a7eaeb",
"prescriberID": "df6463ea-4e0e-4a8f-ab50-3295b7779f3d",
"supervisorID": "",
"medicationID": ,
"prescribedItemID": "cdb064f6-c398-49b0-af03-1c7254e27325",
"gCN": "1234",
"prescribedIvID": "",
"prescribedItemTypeID": 1,
"prescribedItemTypeText": "Rx",
"dispenseAsWritten": 0,
"autoRefill": 0,
"dateWritten": "2011-10-10T00:00:00Z",
"expirationDate": "2012-10-09T00:00:00Z",
"quantity": 0.50000,
"quantityTypeID": 2,
"quantityTypeText": "ML",
"numberOfRefillsAllowed": 0,
"numberOfRefillsFilled": 0,
"originTypeID": 2,
"originTypeText": "Phone-In",
"originTypeNcpdpCode": 2,
"directions": "[INFLUENZA VACCINATION PER PROTOCOL]",
"directionsTranslated": "INFLUENZA VACCINATION PER PROTOCOL",
"directionsSpanish": "",
"directionsTranslatedOther": "",
"translationLanguageTypeID": "",
"translationLanguage": "",
"translationLanguageCode": "",
"scriptImageID": "cdb064f6-c398-49b0-af03-1c7254e99999",
"rxStatusTypeID": "9f7872ab-c9c5-4fa0-815d-f7b999fe7567",
"rxStatusTypeText": "Discontinued",
"rxStatusChangedOn": "2012-11-09T12:25:59Z",
"isActiveStatus": 0,
"criticalComment": "",
"informationalComment": "",
"hiddenComment": "",
"saleComment": "",
"recommendedDaysSuuply": "",
"escriptID": "",
"originAlternateID": "",
"reneweFromRxID": "",
"triplicateNumber": "",
"rxTotalQuantityRemaining": 0.000000,
"rxFillableStatusTypeID": "9f7872ab-c9c5-4fa0-815d-f7b999fe7567",
"rxFillableStatusTypeText": "Discontinued",
"isFillableStatus": 0,
"rxTransactionIDLatest": "8329fcb5-02c3-414f-aee1-09300bca19ab",
"rxTransactionIDLatestComplete": "8329fcb5-02c3-414f-aee1-09300bca19ab",
"counseledOn": "",
"counselingStatusTypeID": "",
"rxCounselingStatusTypeText": "",
"counseledByPharmacistID": "",
"counselingByName": "",
"daysSupplyEndsOn": "2011-11-12T00:00:00Z",
"daysSupplyEndsOnFromInitialFill": "2011-11-12T00:00:00Z",
"daysSupplyEndsOnFromCompletedDate": "2011-11-12T00:00:00Z",
"daysSupplyEndsOnFromInitialCompletedDate": "2011-11-12T00:00:00Z",
"drugUse": "",
"startDate": "",
"endDate": "",
"cycleFill": 0,
"forPain": 0,
"isPrn": 0 ",
"cdtCode": "",
"pmpTreatmentTypeID": "",
"primaryRxIcd10Code": "",
"secodaryRxIcd10Code": "",
"tertiaryRxIcd10Code": "",
"diagnosisICD9Code": "",
"createdOn": "2011-10-13T00:00:00Z",
"changedOn": "2012-11-09T12:25:59Z",
"changedByID": "bd02ddc2-dbcc-4686-be2f-0d9c0b50e6b0",
"changedByName": "Roger Rabbit"
}]
},
"metadata": []
}
Method Name - GetRx
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetRx At least PersonID or RxID is required for this method. Only passing in the PersonID, will return the rxs linked to the patient. Only passing in the RxID, will return the specific Rx.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| FilterTypeID | Int32 | 0 (All) - Default 1 (Active) 2 (Expired Last 90 Days) 3 (Expired) 4 (Filled in Last 90 Days) 5 (Active and Expired) | No |
| PersonID | Guid | Valid Patient, PersonID | No |
| RxID | Guid | No |
Get Rx Event Queue Failed Message Stats
Example Request Body:
{
"MethodName": "GetRxEventQueueFailedMessageStats",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "6983"
}
]
}
Method Name - GetRxEventQueueFailedMessageStats
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | Yes |
Get Rx HOA
Example Request Body:
{
"MethodName": "GetRxHOA",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "8925"
},
{
"Name": "RxID",
"Value": "d876d7c7-3bd3-4386-82d4-4efe48cb3d98"
}
]
}
Method Name - GetRxHOA
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | Yes | |
| RxID | Guid | Yes | |
| Priority | Int32 | No |
Get Rx Queue Count
Example Request Body:
{
"MethodName": "GetRxQueueCount",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "3052"
}
]
}
Method Name - GetRxQueueCount
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | Yes | |
| RequestedTimeFrame | Int32 | No |
Get Rx Transaction
Example Request Body:
{
"MethodName": "GetRxTransaction",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "4234"
}
]
}
Method Name - GetRxTransaction
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | Yes | |
| RxID | Guid | No | |
| RxTransactionID | Guid | No |
Get Rx Transaction Dispensed Items
Example Request Body:
{
"MethodName": "GetRxTransactionDispensedItems",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "1769"
},
{
"Name": "RxTransactionID",
"Value": "431b5d7c-e651-4ae3-a311-7a9e475ad44d"
}
]
}
Method Name - GetRxTransactionDispensedItems
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | Yes | |
| RxTransactionID | Guid | Yes |
Refill Query
Example Request Body:
{
"MethodName": "RefillQuery",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "RxNumber",
"Value": "7528027"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"refillQuery": [{
"rxNumber": 7528027
, "storeNumber": "0"
, "locationID": "c836fe41-9457-484b-a3c5-48abe244e429"
, "rxNumberSearchTypeID": 3
, "useRefillDueLimitForIvr": 1
, "allowExpiredCIIFromIvr": 0
, "refillsDuePercent": 0.0000
, "refillsDueDaysBefore": 7.0000
, "refillDueLimit": 7.0000
, "earliestRefillDaysControlled": 2
, "rxStatusTypeID": "c00f5e42-be56-48ee-a335-dd2860fb853d"
, "rxTransactionStatusTypeID": "89e74ae1-99c7-4a28-a628-73e556d10fb1"
, "daysSupply": 30
, "daysSupplyEndsOn": "2021-07-03T00:00:00Z"
, "dateFilled": "2021-06-03T00:00:00Z"
, "completedDate": "2021-06-03T14:26:07Z"
, "refillsRemaining": 0
, "quantityRemaining": 60.000000
, "originalFillQuantity": 90.00000
, "dateOfFirstFill": "2021-01-20T00:00:00Z"
, "directionsTranslated": "TAKE ONE TABLET BY MOUTH EVERY DAY"
, "numberOfRefillsAllowed": 1
, "drugManufacturerName": "Accord Healthca"
, "expirationDate": "2022-01-05T00:00:00Z"
, "patientID": "d2048bd4-d5d6-4d2a-afcb-b2165f49bc79"
, "patientSerialNumber": 29581
, "patientFirstName": "Cory"
, "patientLastName": "Zeidner"
, "patientGender": "M"
, "patientBirthDate": "1930-05-10T00:00:00Z"
, "patientPrimaryPhone": "9192316333"
, "patientPhoneTypeID": "859c2036-74ec-44a6-af73-f72f44c59791"
, "patientAddress": "316 Bickett Blvd"
, "patientCity": "Greenville"
, "patientState": "NC"
, "patientZip": "27834-2818"
, "drugName": "Bupropion Hcl Xl 150 Mg Tablet"
, "itemTypeID": 1
, "deaSchedule": 0
, "scheduleOfDrug": 0
, "drugNdc": "16729044315"
, "otherRefillOrders": 0
, "systemDateTime": "2021-07-15T08:52:31Z"
, "lastFillQuantity": 30.00000
, "renewMethodTypeID": 3
, "pharmacyName": "PRX Pharmacy"
, "pharmacyEmail": "education@pioneerrx.com"
, "pharmacyPhone": "3187985228"
, "pharmacyFax": "3187985228"
, "pharmacyAddress": "600 Las Colinas Blvd E"
, "pharmacyCity": "Irving"
, "pharmacyState": "MD"
, "pharmacyZip": "75039-5616"
, "doctorLastName": "Sapp"
, "doctorFirstName": "Thomas"
, "doctorDeaNumber": "BT4465630"
, "doctorNpiNumber": "1245385574"
, "doctorPrimaryPhone": "9197891109"
, "doctorPrimaryFax": "9198453332"
, "doctorAddress": "4500 Old Village Rd"
, "doctorCity": "Durham"
, "doctorState": "NC"
, "doctorZip": "27704-2388"
, "promiseTime": "2021-06-03T11:00:00Z"
, "dispensedIventoryGroup": "Rx"
}]
}
, "metadata": []
}
Method Name - RefillQuery
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - RefillQuery Returns information for an rx for the purpose to refill or not. Most commonly used by IVRs. LookupListID=32 will show you possible RxStatusTypeIDs. LookupListID=33 will show you possible RxTransactionStatusTypeIDs. LookupListID=2 will show you possible PhoneTypeIDs.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| RxNumber | Int32 | Yes | |
| ReturnReassignedRxData | Boolean | 0 or 1 | No |
| ReturnReassignedRxNumberInPlaceOfRxNumber | Boolean | 0 or 1 | No |
| StoreNumber | AnsiString(15) | No |
Rx Hardcopy Image
Example Request Body:
{
"MethodName": "RxHardcopyImage",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RxNumber",
"Value": "9501"
}
]
}
Method Name - RxHardcopyImage
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RxNumber | Int32 | Yes |
Rx ID Search
Example Request Body:
{
"MethodName": "RxIDSearch",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "RxNumber",
"Value": "8321619"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"rxID": [
{
"rxNumber": 8321619,
"rxID": "c541f4b2-4142-4b8c-a46f-003652a41fcd"
}
]
},
"metadata": []
}
Method Name - RxIDSearch
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - RxIDSearch This method will return the RxID for a given Rx Number.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| RxNumber | Int32 | Yes |
Rx Transaction ID Search
Example Request Body:
{
"MethodName": "RxTransactionIDSearch",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "RxNumber",
"Value": "8321619"
},
{
"Name": "RefillNumber",
"Value": "0"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"rxTransactionID": [
{
"rxNumber": 8321619,
"rxID": "c541f4b2-4142-4b8c-a46f-003652a41fcd",
"refillNumber": 0,
"rxTransactionID": "2db67b96-93f3-4a8f-8700-7f47614fafc2"
}
]
},
"metadata": []
}
Method Name - RxTransactionIDSearch
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - RxTransactionIDSearch This method will return the RxTransactionID for a given Rx Number, Refill Number. It also returns the RxID for the given Rx Number.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RefillNumber | Int32 | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| RxNumber | Int32 | Yes |
Rx Transaction Workflow Status Count Get
Example Request Body:
{
"MethodName": "RxTransactionWorkflowStatusCountGet",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"rxTransactionWorkflowStatusCount": [
{
"workflowStatusID": "7951f3ab-deb2-46c0-a48a-1355edf603da",
"workflowStatusDisplayText": "TB",
"workflowStatusDescription": "To Be Put in Bin",
"rxCount": 23,
"updatedOnUtc": "2023-05-18T14:50:13Z"
},
{
"workflowStatusID": "d247c2bf-c48b-4193-bd34-1f47050f7dec",
"workflowStatusDisplayText": "PR",
"workflowStatusDescription": "Post Edit Rejection",
"rxCount": 2,
"updatedOnUtc": "2023-05-23T14:19:21Z"
},
{
"workflowStatusID": "38f574df-acc7-47bf-95dc-217552c69b85",
"workflowStatusDisplayText": "OD",
"workflowStatusDescription": "Out for Delivery",
"rxCount": 244,
"updatedOnUtc": "2023-05-04T14:57:41Z"
},
{
"workflowStatusID": "92931625-58ed-42b5-90b9-7c73f864be91",
"workflowStatusDisplayText": "TP",
"workflowStatusDescription": "Third Party Rejection",
"rxCount": 0,
"updatedOnUtc": "2023-05-15T21:45:47Z"
},
{
"workflowStatusID": "1b96a5ce-132a-4537-a48a-806488b19794",
"workflowStatusDisplayText": "CQ",
"workflowStatusDescription": "Compound Queue",
"rxCount": 0,
"updatedOnUtc": "2023-05-04T14:57:41Z"
},
{
"workflowStatusID": "21f26248-a822-4255-8e71-88e136de891e",
"workflowStatusDisplayText": "DE",
"workflowStatusDescription": "Data Entry / Fill Requested",
"rxCount": 5,
"updatedOnUtc": "2023-05-19T19:25:48Z"
},
{
"workflowStatusID": "15650b6e-85ab-4d0e-9f7c-8d0ba33fa14b",
"workflowStatusDisplayText": "C",
"workflowStatusDescription": "Completed",
"rxCount": 138,
"updatedOnUtc": "2023-05-23T14:19:56Z"
},
{
"workflowStatusID": "47140576-ebef-4fc0-9c58-911a52a93951",
"workflowStatusDisplayText": "FS",
"workflowStatusDescription": "Fill",
"rxCount": 83,
"updatedOnUtc": "2023-05-18T14:46:26Z"
},
{
"workflowStatusID": "f51c1620-864c-4b16-9e90-938697bddef2",
"workflowStatusDisplayText": "CK",
"workflowStatusDescription": "Check",
"rxCount": 36,
"updatedOnUtc": "2023-05-18T14:50:11Z"
},
{
"workflowStatusID": "7a349a09-d87b-4a3c-8f90-96a1c541cf44",
"workflowStatusDisplayText": "WP",
"workflowStatusDescription": "Waiting for Pickup",
"rxCount": 297,
"updatedOnUtc": "2023-05-23T14:19:56Z"
},
{
"workflowStatusID": "d495988e-1f5d-4f4e-a955-abadb83f73a4",
"workflowStatusDisplayText": "RP",
"workflowStatusDescription": "Renew Pending",
"rxCount": 1794,
"updatedOnUtc": "2023-05-16T14:02:41Z"
},
{
"workflowStatusID": "f5da6d49-1a9e-451c-b26c-b8b816248101",
"workflowStatusDisplayText": "PS",
"workflowStatusDescription": "Print Queue",
"rxCount": 417,
"updatedOnUtc": "2023-05-19T15:40:59Z"
},
{
"workflowStatusID": "69d80d09-755b-4c6e-ac12-d4d68259d29b",
"workflowStatusDisplayText": "WD",
"workflowStatusDescription": "Waiting for Delivery",
"rxCount": 0,
"updatedOnUtc": "2023-05-04T14:57:41Z"
},
{
"workflowStatusID": "ca97ea21-3a49-427c-8a86-e6029b296e5c",
"workflowStatusDisplayText": "PC",
"workflowStatusDescription": "Pre-Check",
"rxCount": 30,
"updatedOnUtc": "2023-05-19T15:40:59Z"
}
]
},
"metadata": []
}
Method Name - RxTransactionWorkflowStatusCountGet
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - RxTransactionWorkflowStatusCountGet This mehtod will return the workflow counts just like you see on the PRx Flow tab, on the UI.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
Third-Party
Get Third Party
Example Request Body:
{
"MethodName": "GetThirdParty",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "9170"
},
{
"Name": "ThirdPartyID",
"Value": "50694d96-ef7e-4909-9f49-315ea93a2cea"
}
]
}
Method Name - GetThirdParty
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | Yes | |
| ThirdPartyID | Guid | Yes |
Get Third Party Address
Example Request Body:
{
"MethodName": "GetThirdPartyAddress",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "8180"
}
]
}
Method Name - GetThirdPartyAddress
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | Yes | |
| AddressID | Guid | No | |
| ThirdPartyID | Guid | No |
Get Third Party Category
Example Request Body:
{
"MethodName": "GetThirdPartyCategory",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "7142"
}
]
}
Method Name - GetThirdPartyCategory
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | Yes | |
| CategoryID | Guid | No | |
| ThirdPartyID | Guid | No |
Get Third Party Document
Example Request Body:
{
"MethodName": "GetThirdPartyDocument",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "7307"
}
]
}
Method Name - GetThirdPartyDocument
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | Yes | |
| DocumentImageID | Guid | No | |
| ThirdPartyID | Guid | No |
Get Third Party Phone
Example Request Body:
{
"MethodName": "GetThirdPartyPhone",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "788"
}
]
}
Method Name - GetThirdPartyPhone
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | Yes | |
| PhoneID | Guid | No | |
| ThirdPartyID | Guid | No |
Search Third Party
Example Request Body:
{
"MethodName": "ThirdPartySearchDirectory",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "ThirdPartyName",
"Value": "Exp%"
},
{
"Name": "BIN",
"Value": "001553"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"thirdParty": [
{
"thirdPartyID": "4dd61a71-a6e7-469a-918e-020a7c98bf28",
"thirdPartyName": "Express Scripts",
"printName": "Express Scripts",
"legacyNumber": "BD_271",
"planGroupCode": "271",
"bin": "003858",
"pcn": "A4",
"primaryPhoneID": "f653f322-6e53-4ddf-b8f9-0fa847361783",
"primaryPhoneNumber": "8002354357",
"planTypeID": 6,
"planTypeText": "Standard",
"taxMethodTypeID": 1,
"taxMethodTypeText": "Third Party pays",
"submissionTypeID": 1,
"submissionTypeText": "Transmitted",
"statusTypeID": "45a05fae-5bd3-40f2-99b8-9a91c02d3090",
"statusTypeText": "Active",
"isActiveStatus": 1
},
{
"thirdPartyID": "c2d41eba-02ad-48bb-8cf6-b8efbb45649e",
"thirdPartyName": "Express Scripts-Milit?",
"printName": "Express Scripts-Milit?",
"legacyNumber": "BD_441",
"planGroupCode": "441",
"bin": "003858",
"pcn": "SC",
"primaryPhoneID": "323d7847-8319-4d29-a107-29bc49c711dc",
"primaryPhoneNumber": "8006000180",
"primaryPhoneExtention": "",
"planTypeID": 6,
"planTypeText": "Standard",
"taxMethodTypeID": 4,
"taxMethodTypeText": "Third Party Plan is Exempt",
"submissionTypeID": 1,
"submissionTypeText": "Transmitted",
"statusTypeID": "45a05fae-5bd3-40f2-99b8-9a91c02d3090",
"statusTypeText": "Active",
"isActiveStatus": 1
}
]
},
"metadata": []
}
Method Name - SearchThirdParty
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - SearchThirdParty Besides the required parameter RequestedByEmployeeID, at least one other parameter is required. When multiple parameters are specified, all criteria must be met (AND condition). You may also use the % in a parameter as a wildcard. When the % is used, the LIKE condition is used vs the EQUAL condition.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| BIN | AnsiString(20) | No | |
| HelpDeskPhoneNumber | AnsiString(15) | No | |
| IsActive | Int32 | No | |
| PCN | AnsiString(50) | No | |
| PlanGroupCode | AnsiString(30) | No | |
| PlanTypeID | Int32 | No | |
| PrimaryPhoneNumber | AnsiString(15) | No | |
| StatusTypeID | Guid | No | |
| SubmissionTypeID | Int32 | No | |
| TaxMethodTypeID | Int32 | No | |
| ThirdPartyID | Guid | No | |
| ThirdPartyName | AnsiString(100) | No |
Third Party Search Directory
Example Request Body:
{
"MethodName": "ThirdPartySearchDirectory",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "BIN",
"Value": "001553"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"directory": [
{
"planID": "58d04c47-c9d7-4ad8-8cf4-267ca5df520a",
"planName": "Georgia Medicaid",
"bin": "001553",
"pcn": "GAM",
"primaryHelpDeskPhone": "8665255826",
"planTypeID": "6e9fd7f5-9fc4-44d3-8bdc-b293c13096e0",
"planTypeText": "Medicaid"
},
{
"planID": "1095c15d-9779-47a6-9e6e-276349f949f4",
"planName": "Tenncare / Tn Medicaid",
"bin": "001553",
"pcn": "TNM",
"primaryHelpDeskPhone": "8664345520",
"planTypeID": "6e9fd7f5-9fc4-44d3-8bdc-b293c13096e0",
"planTypeText": "Medicaid"
},
{
"planID": "3fa23691-d959-4051-8d8d-7e8075b6f034",
"planName": "Serve You Workers Comp",
"bin": "001553",
"pcn": "SERVU",
"primaryHelpDeskPhone": "8007593203",
"planTypeID": "4dab7ddd-90b0-4ad3-b260-7b13273c0cf6",
"planTypeText": "Standard"
}
]
},
"metadata": []
}
Method Name - ThirdPartySearchDirectory
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - ThirdPartySearchDirectory Besides the required parameter RequestedByEmployeeID, at least one other parameter is required. When multiple parameters are specified, all criteria must be met (AND condition). You may also use the % in a parameter as a wildcard. When the % is used, the LIKE condition is used vs the EQUAL condition.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| BIN | AnsiString(20) | No | |
| PCN | AnsiString(10) | No | |
| PlanName | AnsiString(25) | No | |
| PlanTypeID | Guid | No |
Facility
Get Facility
Example Request Body:
{
"MethodName": "GetFacility",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "FacilityID",
"Value": "9fa1a48b-9b66-41ab-96e2-2c19237aa29d"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"facility": [
{
"facilityID": "9fa1a48b-9b66-41ab-96e2-2c19237aa29d",
"facilityName": "Magnolia Glen",
"facilityTypeID": "aeba2d3f-c1e6-4bc1-9f51-530c7221586d",
"facilityTypeText": "",
"statusTypeID": "aea0a892-714f-4076-95d7-c486e76f9cdf",
"statusTypeText": "Active",
"isActiveStatus": 1,
"statusChangedOn": "2014-02-20T12:07:26Z",
"createdOn": "2014-02-20T17:07:26Z",
"changedOn": "2022-01-20T17:11:20Z",
"changedByID": "3c21ddeb-dd94-4bf3-9688-e16b8c1af8f3",
"changedByName": "PioneerRx Support",
"changedAtID": "c836fe41-9457-484b-a3c5-48abe244e429",
"changedAtLocation": "PRX Pharmacy (Scrambled)"
}
],
"facilityWing": [
{
"facilityWingID": "07547924-2748-4173-9b77-a371344bd4a4",
"facilityID": "9fa1a48b-9b66-41ab-96e2-2c19237aa29d",
"facilityName": "Magnolia Glen",
"wingText": "Default",
"isActive": 1
}
],
"facilityCategory": [],
"facilityAddress": [
{
"addressID": "8359ab69-3079-407e-ae78-232d5e004b60",
"facilityID": "9fa1a48b-9b66-41ab-96e2-2c19237aa29d",
"addressTypeID": "00000000-0000-0000-0000-000000000000",
"addressTypeText": "Primary",
"displaySequence": 0,
"address": "53 Creed Rd",
"city": "Shreveport",
"stateCode": "LA",
"zipCode": "77777-3822",
"country": "USA",
"changedOn": "2022-01-20T17:11:20Z",
"changedByID": "3c21ddeb-dd94-4bf3-9688-e16b8c1af8f3",
"changedByName": "PioneerRx Support",
"changedAtID": "c836fe41-9457-484b-a3c5-48abe244e429",
"changedAtLocation": "PRX Pharmacy (Scrambled)"
}
],
"facilityInventoryGroup": [
{
"inventoryGroupTypeID": "a3563e34-5da9-42de-b33b-0a4ad7f5fc2b",
"facilityID": "9fa1a48b-9b66-41ab-96e2-2c19237aa29d",
"inventoryGroupTypeText": "340B",
"isActive": 1,
"externalID": ""
}
],
"facilityPhone": [
{
"phoneID": "14968bca-8f16-4cf0-ae6d-8670809898f9",
"facilityID": "9fa1a48b-9b66-41ab-96e2-2c19237aa29d",
"phoneTypeID": "56d1abb5-abeb-4b9b-a253-e4d323e07d17",
"phoneTypeText": "Business",
"displaySequence": 0,
"phoneNumber": "5556664747",
"extension": "24"
},
{
"phoneID": "6e70db7d-2eae-48f8-99b5-d6be1c5f36a8",
"facilityID": "9fa1a48b-9b66-41ab-96e2-2c19237aa29d",
"phoneTypeID": "dd3228ca-51f2-4d99-b049-0fa0b9270c4b",
"phoneTypeText": "Fax",
"displaySequence": 0,
"phoneNumber": "5556667777",
"extension": ""
}
]
},
"metadata": []
}
Method Name - GetFacility
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetFacility GetFacility will return the facility information. It will also return the results from methods GetFacilityWing, GetFacilityCategory, GetFacilityPhone, GetFacilityAddress, GetFacilityInventoryGroup.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| FacilityID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
Get Facility Address
Example Request Body:
{
"MethodName": "GetFacilityAddress",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "FacilityID",
"Value": "9fa1a48b-9b66-41ab-96e2-2c19237aa29d"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"facilityAddress": [
{
"addressID": "8359ab69-3079-407e-ae78-232d5e004b60",
"facilityID": "9fa1a48b-9b66-41ab-96e2-2c19237aa29d",
"addressTypeID": "00000000-0000-0000-0000-000000000000",
"addressTypeText": "Primary",
"displaySequence": 0,
"address": "5301 Creedmoor Rd",
"city": "Shreveport",
"stateCode": "NC",
"zipCode": "71115",
"country": "USA",
"changedOn": "2018-10-05T12:25:47Z",
"changedByID": "53990dee-d977-4d7e-b5ea-d68237810180",
"changedByName": "Jonny Walker",
"changedAtID": "c836fe41-9457-484b-a3c5-48abe244e429",
"changedAtLocation": "PioneerRx Pharmacy"
}
]
},
"metadata": []
}
Method Name - GetFacilityAddress
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetFacilityAddress At least FacilityID or AddressID is required for this method. Only passing in the FacilityID, will return the addresses linked to the facility. Only passing in the AddressID, will return the specific address.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| FacilityID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| AddressID | Guid | No |
Get Facility Category
Example Request Body:
{
"MethodName": "GetFacilityCategory",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "FacilityID",
"Value": "9fa1a48b-9b66-41ab-96e2-2c19237aa29d"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"category": [{
"categoryID": "0c45b9d9-b190-4d95-a977-5178d317af13",
"facilityID": "9fa1a48b-9b66-41ab-96e2-2c19237aa29d",
"categoryText": "A Rating",
"categoryDescription": "A Rating",
"isAutoFilter": 0
}, {
"categoryID": "00efb741-f208-42fa-8353-9235b8e02277",
"facilityID": "9fa1a48b-9b66-41ab-96e2-2c19237aa29d",
"categoryText": "Only Women",
"categoryDescription": "Exclusive for Women",
"isAutoFilter": 0
}]
},
"metadata": [
]
}
Method Name - GetFacilityCategory
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetFacilityCategory Only passing in the FacilityID, will return the categories associated to the facility. Passing in the CategoryID, will return the specific category.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| FacilityID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| CategoryID | Guid | No |
Get Facility Inventory Group
Example Request Body:
{
"MethodName": "GetFacilityInventoryGroup",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "FacilityID",
"Value": "9fa1a48b-9b66-41ab-96e2-2c19237aa29d"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"facilityInventoryGroup": [
{
"inventoryGroupTypeID": "a3563e34-5da9-42de-b33b-0a4ad7f5fc2b",
"facilityID": "9fa1a48b-9b66-41ab-96e2-2c19237aa29d",
"inventoryGroupTypeText": "340B",
"isActive": 1,
"externalID": ""
}
]
},
"metadata": []
}
Method Name - GetFacilityInventoryGroup
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetFacilityInventoryGroup At least FacilityID or InventoryGroupTypeID is required for this method. Only passing in the FacilityID, will list of inventory groups preferred by the facility. Only passing in the InventoryGroupTypeID, will return the specific preferred inventory group.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| FacilityID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| InventoryGroupTypeID | Guid | No |
Get Facility Phone
Example Request Body:
{
"MethodName": "GetFacilityPhone",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "FacilityID",
"Value": "9fa1a48b-9b66-41ab-96e2-2c19237aa29d"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"facilityPhone": [
{
"phoneID": "14968bca-8f16-4cf0-ae6d-8670809898f9",
"facilityID": "9fa1a48b-9b66-41ab-96e2-2c19237aa29d",
"phoneTypeID": "56d1abb5-abeb-4b9b-a253-e4d323e07d17",
"phoneTypeText": "Business",
"displaySequence": 0,
"phoneNumber": "5556664747",
"extension": "24"
},
{
"phoneID": "6e70db7d-2eae-48f8-99b5-d6be1c5f36a8",
"facilityID": "9fa1a48b-9b66-41ab-96e2-2c19237aa29d",
"phoneTypeID": "dd3228ca-51f2-4d99-b049-0fa0b9270c4b",
"phoneTypeText": "Fax",
"displaySequence": 0,
"phoneNumber": "5556667777",
"extension": ""
}
]
},
"metadata": []
}
Method Name - GetFacilityPhone
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetFacilityPhone At least FacilityID or PhoneID is required for this method. Only passing in the FacilityID, will return the phones linked to the facility. Only passing in the PhoneID, will return the specific phone.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| FacilityID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| PhoneID | Guid | No |
Get Facility Wing
Example Request Body:
{
"MethodName": "GetFacilityWing",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "FacilityID",
"Value": "9fa1a48b-9b66-41ab-96e2-2c19237aa29d"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"facilityWing": [{
"facilityWingID": "07547924-2748-4173-9b77-a371344bd4a4",
"facilityID": "9fa1a48b-9b66-41ab-96e2-2c19237aa29d",
"facilityName": "Magnolia Glen",
"wingText": "North",
"isActive": 1
}, {
"facilityWingID": "160ffb65-86c0-4842-8fca-03bc0f752d87",
"facilityID": "9fa1a48b-9b66-41ab-96e2-2c19237aa29d",
"facilityName": "Magnolia Glen",
"wingText": "South",
"isActive": 1
}]
},
"metadata": []
}
Method Name - GetFacilityWing
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetFacilityWing Only passing in the FacilityID, will return the wings associated with facility. Passing in the FacilityWingID will return the specific wing.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| FacilityID | Guid | No | |
| FacilityWingID | Guid | No |
Search Facility
Example Request Body:
{
"MethodName": "SearchFacility",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "FacilityName",
"Value": "b%"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"facility": [{
"facilityID": "ce556bcb-e2b2-4a76-b43a-5f1a5d737478",
"facilityName": "BAKERS ASSISTED LIVING",
"facilityTypeID": "2cd32e79-4955-4a89-adec-461202f61640",
"facilityTypeText": "Assisted Living",
"facilityGroup": "AL12",
"legacyNumber": "",
"primaryPhone": "3187971717",
"primaryAddress": "408 Kay Ln",
"primaryCity": "Shreveport",
"primaryStateCode": "LA",
"primaryZipCode": "711151234",
"nPI": "",
"alternateID": "",
"nCPDP": "",
"statusTypeID": "aea0a892-714f-4076-95d7-c486e76f9cdf",
"statusTypeText": "Active",
"isActiveStatus": 1
}, {
"facilityID": "b0fa59e7-b74b-432b-b920-c79579dc9085",
"facilityName": "Big Bobs Senior Living Ranch",
"facilityTypeID": "aeba2d3f-c1e6-4bc1-9f51-530c7221586d",
"facilityTypeText": "",
"statusTypeID": "aea0a892-714f-4076-95d7-c486e76f9cdf",
"statusTypeText": "Active",
"isActiveStatus": 1
}]
},
"metadata": []
}
Method Name - SearchFacility
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - SearchFacility Besides the required parameter RequestedByEmployeeID, at least one other parameter is required. When multiple parameters are specified, all criteria must be met (AND condition). You may also use the % in a parameter as a wildcard. When the % is used, the LIKE condition is used vs the EQUAL condition.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| AlternateID | AnsiString(50) | No | |
| FacilityGroup | AnsiString(50) | No | |
| FacilityName | AnsiString(150) | No | |
| FacilityTypeID | Guid | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 39, found under Read, Other. | No |
| IsActive | Int32 | 0 or 1, default is 1. 1=Active Facility statuses only 0=All Facility statuses | No |
| LegacyNumber | AnsiString(50) | No | |
| NCPDP | AnsiString(50) | No | |
| NPI | AnsiString(100) | No | |
| PrimaryAddress | AnsiString(200) | No | |
| PrimaryCity | AnsiString(200) | No | |
| PrimaryPhone | AnsiString(15) | No | |
| PrimaryStateCode | AnsiString(2) | No | |
| PrimaryZipCode | AnsiString(10) | No |
PointOfSale
Sale Transaction Address Get
Example Request Body:
{
"MethodName": "SaleTransactionAddressGet",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "PWELL"
},
{
"Name": "SaleTransactionID",
"Value": "14EA56E3-4249-4C59-A993-0237FA5D686E"
},
{
"Name": "ReturnAddressTypeID",
"Value": "2"
},
{
"Name": "IncludeSaleTransactionLineItems",
"Value": "1"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"saleTransactionAddressGet": [
{
"saleTransactionID": "14ea56e3-4249-4c59-a993-0237fa5d686e",
"saleReceiptNumber": 156875,
"orderNum": 156875,
"barcode": "S0000156875",
"patientFullNameFirstThenLast": "Roger Rabbit",
"patientAddress": "611 Blue Ridge Rd",
"patientCityStateZip": "Shreveport, LA 27999-1234",
"city": "Shreveport",
"stateCode": "LA",
"zipCode": "27999-1234",
"patientPhone": "(999) 888-1234",
"patientCellPhone": "(777) 666-5555",
"deliveryShopperID": "9fcd58b5-6089-4b32-b025-4c9ee0c6f3ba",
"shippingDeclaredValue": 0.0000,
"useDeclaredValue": 0,
"allowSaleTransactionPODToComplete": 1,
"patientSaleComment":"Always ask him abut his dog.",
"patientDeliveryMethodComment":"Watch out for his bad dog.",
}
],
"saleTransactionLineItems": [
{
"saleTransactionID": "14ea56e3-4249-4c59-a993-0237fa5d686e",
"saleTransactionDetailID": "7ded2fad-b388-4854-8d79-303a1c54b590",
"referenceTypeEnum": 1,
"quantity": 1.0000,
"lineItemDescription": "8340873-0"
},
{
"saleTransactionID": "14ea56e3-4249-4c59-a993-0237fa5d686e",
"saleTransactionDetailID": "a24fe198-a49a-46d5-b79f-d43623013acb",
"referenceTypeEnum": 1,
"quantity": 1.0000,
"lineItemDescription": "8340872-0"
},
{
"saleTransactionID": "14ea56e3-4249-4c59-a993-0237fa5d686e",
"saleTransactionDetailID": "b55fe198-a49a-46d5-b79f-x43623013xyz",
"referenceTypeEnum": 2,
"quantity": 1.0000,
"lineItemDescription": "Snickers Bar"
}
]
},
"metadata": []
}
Method Name - SaleTransactionAddressGet
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - SaleTransactionAddressGet Returns the address tied to the Point of Sale transaction. This method returns the same information that is used by the PioneerRx integration with UPS, FedEx and USPS(Endcia). If you are delivering for the pharmacy, you should use 2 for the ReturnAddressTypeID. If you are mailing(aka shipping) for the pharmacy, you should use 1 for the ReturnAddressTypeID. The Delivery and Mailling(aka shipping) address are pulled from the 1st patients address on the sale transaction. If the patient only has a primary address, then that address will also be the delivery address and the mailing(aka shipping) address. If you IncludeSaleTransactionLineItems, it will return a list of items on the ticket. The list will be the RxNumber-Refill Number, or OTC items. This way you can use this list, in your Proof of Delivery document, to identify what the patient received in their package. AllowSaleTransactionPODToComplete=1 in the result will tell you all money is taken care of, so you will no issues with Proof of Delivery completing. If this value is 0, it is giving you a heads up that you will have issues unless the store fixes the ticket before you send in your Proof of Delivery.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| ReturnAddressTypeID | Int32 | 1 Mailing(Shipping) 2 Delivery | Yes |
| SaleTransactionID | Guid | Yes | |
| BlockIfCanNotCompletePOD | Boolean | 0-No, Default 1-YesIf set to yes, this will not return a result,if you will not be able to complete the POD(Proof Of Delivery), due to the money not being taken care of at time of sale. If Set to 0-No, this will return a result, but the AllowSaleTransactionPODToComplete in the result will give you a heads up as to if you will have issues later. | No |
| IncludeSaleTransactionLineItems | Boolean | 0 Default, no details 1 Return details | No |
Sale Transaction Search
Example Request Body:
{
"MethodName": "SaleTransactionSearch",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "SaleReceiptNumber",
"Value": "444073"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"saleTransactionSearchResults": [
{
"saleTransactionID": "dbe0d055-3746-44c2-8918-f969373af204",
"postingDate": "2022-01-18T00:00:00Z",
"transactionStatusID": 3,
"transactionStatusText": "Closed",
"saleReceiptNumber": 444073,
"receiptBarCode": "S0000444073",
"saleCompletedOn": "2022-01-18T09:10:44Z",
"deliveryStatusTypeID": 1,
"deliveryStatusTypeText": "Pending"
}
]
},
"metadata": []
}
Method Name - SaleTransactionSearch
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - SaleTransactionSearch Besides the required parameter RequestedByEmployeeID, at least one other parameter is required. When multiple parameters are specified, all criteria must be met (AND condition). You may also use the % in a parameter as a wildcard. When the % is used, the LIKE condition is used vs the EQUAL condition.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| PostingDateBegin | Date | No | |
| PostingDateEnd | Date | No | |
| ReceiptBarcode | AnsiString(20) | No | |
| SaleCompletedOnBegin | DateTime | No | |
| SaleCompletedOnEnd | DateTime | No | |
| SaleReceiptNumber | Int32 | No |
Shipping
Shipment Get
Example Request Body:
{
"MethodName": "ShipmentGet",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "ShipmentID",
"Value": "384d030a-6040-4021-af43-b823d5b3b452"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"shipmentInformation": [
{
"shipmentID": "384d030a-6040-4021-af43-b823d5b3b452",
"createdOn": "2022-01-28T11:45:39Z",
"updatedOn": "2022-01-28T11:45:39Z",
"shipperStatusTypeID": 1,
"shipperStatusTypeText": "UNKNOWN",
"saleReceiptString": "444894",
"trackingNumber": "BR549_01282022",
"shipperName": "Fly By Night",
"manualEntry": 0,
"createdBy": "6b4c2403-ba91-4e35-8f73-b59c70a23742",
"createdByName": "David Hart",
"changedBy": "6b4c2403-ba91-4e35-8f73-b59c70a23742",
"changedByName": "David Hart"
}
]
},
"metadata": []
}
Method Name - ShipmentGet
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - ShipmentGet Returns information on a shipment. This method returns the same information that is used by the PioneerRx integration with UPS, FedEx and USPS(Endcia).
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| ShipmentID | Guid | Yes |
Shipment Search
Example Request Body:
{
"MethodName": "ShipmentSearch",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "TrackingNumber",
"Value": "BR549%"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"shipmentSearchResults": [
{
"shipmentID": "384d030a-6040-4021-af43-b823d5b3b452",
"shipperStatusTypeID": 1,
"shipperStatusTypeText": "UNKNOWN",
"saleReceiptString": "444894",
"trackingNumber": "BR549_01282022",
"shipperName": "Fly By Night",
"manualEntry": 0
}
]
},
"metadata": []
}
Method Name - ShipmentSearch
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - ShipmentSearch Besides the required parameter RequestedByEmployeeID, at least one other parameter is required. When multiple parameters are specified, all criteria must be met (AND condition). You may also use the % in a parameter as a wildcard. When the % is used, the LIKE condition is used vs the EQUAL condition.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| ManualEntry | Int32 | No | |
| SaleReceiptString | AnsiString(20) | No | |
| ShipperName | AnsiString(15) | No | |
| ShipperStatusTypeID | Int32 | No | |
| TrackingNumber | AnsiString(40) | No |
Monitoring
Claim Queue Size
Example Request Body:
{
"MethodName": "ClaimQueueSize",
"Version": 1.0,
"ParameterCollection": [
]
}
Success Response:
StatusCode: 200
{
"results": {
"claimQueueSize": [
{
"claimQueueSize": 0
}
]
},
"metadata": []
}
Method Name - ClaimQueueSize
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - ClaimQueueSize Returns a count of claims awaiting transmission.
Device Interface Active Type List
Example Request Body:
{
"MethodName": "DeviceInterfaceActiveTypeList",
"Version": 1.0,
"ParameterCollection": [
]
}
Success Response:
StatusCode: 200
{
"results": {
"deviceInterfaceInformation": [
{
"deviceInterfaceID": "f8a19f31-3529-4ef1-ae60-12c201649c7f",
"deviceName": "Creative Pharmacist",
"deviceTypeID": 27,
"deviceTypeText": "Pioneer Universal",
"isActive": 1,
"changedOn": "2018-09-05T15:56:07Z"
},
{
"deviceInterfaceID": "2385d1a6-d61d-498d-8e11-48fbf0481e69",
"deviceName": "Parata",
"deviceDescription": "Do Not Delete",
"deviceTypeID": 3,
"deviceTypeText": "Parata",
"isActive": 1,
"changedOn": "2022-01-14T10:44:02Z"
}
]
},
"metadata": []
}
Method Name - DeviceInterfaceActiveTypeList
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - DeviceInterfaceActiveTypeList Returns a list of Device Interfaces that are Active.
Device Interface Queue Size
Example Request Body:
{
"MethodName": "DeviceInterfaceQueueSize",
"Version": 1.0,
"ParameterCollection": [
]
}
Success Response:
StatusCode: 200
{
"results": {
"deviceInterfaceQueueSize": [
{
"deviceInterfaceID": "f8a19f31-3529-4ef1-ae60-12c201649c7f",
"size": 4
},
{
"deviceInterfaceID": "e7b5f599-a6fd-4ee4-9cb7-286d79a2e9dd",
"size": 0
},
{
"deviceInterfaceID": "2385d1a6-d61d-498d-8e11-48fbf0481e69",
"size": 3
}
]
},
"metadata": []
}
Method Name - DeviceInterfaceQueueSize
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - DeviceInterfaceQueueSize Returns a count of messages awaiting transmission for all or the selected device.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| DeviceInterfaceID | Guid | No |
Disk Utilization Get
Example Request Body:
{
"MethodName": "DiskUtilizationGet",
"Version": "1.0",
"ParameterCollection": [
]
}
Success Response:
StatusCode: 200
{
"results": {
"diskUtilizationInformation": [
{
"driveLetter": "C",
"diskSpaceUsedMB": 110644,
"availableSpaceMB": 139061,
"diskSpaceUsedGB": 108.05,
"availableSpaceGB": 135.80,
"freeSpacePercentage": 20.44
},
{
"driveLetter": "F",
"diskSpaceUsedMB": 282113,
"availableSpaceMB": 953213,
"diskSpaceUsedGB": 275.50,
"availableSpaceGB": 930.87,
"freeSpacePercentage": 70.40
},
{
"driveLetter": "G",
"diskSpaceUsedMB": 3148624,
"availableSpaceMB": 3334781,
"diskSpaceUsedGB": 3074.83,
"availableSpaceGB": 3256.62,
"freeSpacePercentage": 5.58
},
{
"driveLetter": "H",
"diskSpaceUsedMB": 539640,
"availableSpaceMB": 953213,
"diskSpaceUsedGB": 526.99,
"availableSpaceGB": 930.87,
"freeSpacePercentage": 43.39
}
]
},
"metadata": []
}
Method Name - DiskUtilizationGet
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - DiskUtilizationGet
Get CPU Memory Usage
Example Request Body:
{
"MethodName": "GetCPUMemoryUsage",
"Version": "1.0",
"ParameterCollection": [
]
}
Success Response:
StatusCode: 200
{
"results": {
"metrics": [
{
"instance": "PioneerServer\\NewTech",
"maxServerMemoryMB": 29000,
"sqlServerMemoryUsageMB": 27796,
"physicalMemoryMB": 32751,
"availableMemoryMB": 1738,
"systemMemoryState": "Physical memory usage is steady",
"pageLifeExpectancy": 4785,
"sqlProcessUtilization30": 1,
"sqlProcessUtilization15": 1,
"sqlProcessUtilization10": 1,
"sqlProcessUtilization5": 1,
"dataSampleTimestamp": "2022-01-31T12:32:04Z"
}
]
},
"metadata": []
}
Method Name - GetCPUMemoryUsage
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetCPUMemoryUsage
Get User Sessions
Example Request Body:
{
"MethodName": "GetUserSessions",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "ShowSleepingSpids",
"Value": "0"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"session": [
{
"dd hh:mm:ss.mss": "00 00:01:13.196",
"session_id": 438,
"sql_text": "",
"is_blocking": false,
"reads": " 666",
"status": "dormant",
"open_tran_count": " 0",
"login_name": "ReadOnlyUser",
"host_name": "SQL01",
"program_name": "Microsoft SQL Server",
"start_time": "2022-02-01T14:31:42Z",
"login_time": "2022-02-01T14:17:28Z",
"collection_time": "2022-02-01T14:32:55Z"
}
]
},
"metadata": []
}
Method Name - GetUserSessions
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetUserSessions Only returns sessions for SQL ReadOnlyUser, APIUser, DayOldUser.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| Show_Sleeping_Spids | Boolean | No |
Item
Item Category Get
Example Request Body:
{
"MethodName": "ItemCategoryGet",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "ItemID",
"Value": "92c0d219-c9a1-483f-b4c5-00cb02d85fb8"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"itemCategory": [
{
"categoryID": "8b818447-5a26-4adc-80dc-043f2b536edd",
"itemID": "92c0d219-c9a1-483f-b4c5-00cb02d85fb8",
"categoryText": "Non Schedule Medications",
"categoryScopeID": 12,
"isAutoFilter": 1
},
{
"categoryID": "1620e666-f3b6-4ecb-a27f-bf986ea14eb8",
"itemID": "92c0d219-c9a1-483f-b4c5-00cb02d85fb8",
"categoryText": "Robot/Parata",
"categoryScopeID": 12,
"isAutoFilter": 0
},
{
"categoryID": "3361a3b1-a0ec-40f1-b02c-c064a29a7256",
"itemID": "92c0d219-c9a1-483f-b4c5-00cb02d85fb8",
"categoryText": "PC: 1",
"categoryDescription": "PC: 1",
"categoryScopeID": 12,
"isAutoFilter": 0
}
]
},
"metadata": []
}
Method Name - ItemCategoryGet
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - ItemCategoryGet Passing in the ItemID only, will give you all categories the item is in. Passing in the CategoryID only, will give you all items in the category.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| CategoryID | Guid | No | |
| ItemID | Guid | No |
Item Get
Example Request Body:
{
"MethodName": "ItemGet",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "ItemID",
"Value": "E7AF3704-9EB2-4939-A6C8-36E3E3E81139"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"item": [
{
"itemID": "e7af3704-9eb2-4939-a6c8-36e3e3e81139",
"itemTypeID": 1,
"itemTypeText": "Rx",
"itemName": "Furosemide 80 Mg Tablet",
"printName": "Furosemide 80 Mg Tablet",
"upc": "303780232051",
"upc12WithCheckDigit": "303780232051",
"ndc": "00378023205",
"manufacturer": "Mylan",
"departmentID": "bc577215-6841-4101-b7f5-6a89a5dda041",
"departmentName": "Rx",
"labelTypeID": 1,
"labelTypeText": "Generic",
"drugClassID": 1,
"drugClassText": "Rx",
"deaSchedule": 0,
"cPT": "",
"hCPC": "",
"hicl": "3660",
"gcn": "8210",
"uPN": "",
"legacyNumber": "",
"alternateID": "",
"itemAdministrationID": 24,
"itemAdministrationText": "Oral",
"ncpdpAdministrationID": 11,
"dosageFormID": 81,
"dosageFormText": "Tablet",
"ncpdpDosageFormID": 10,
"dispensingUnitID": 1,
"dispensingUnitText": "EA",
"ncpdpDispensingUnitID": 1,
"unitsPerLabel": 0,
"stockSize": 500.000000000,
"packageTypeID": 10,
"packageTypeText": "BOTTLE",
"strength": "80 mg",
"defaultDaysSupply": 0,
"defualtDirections": "",
"isSoldOTC": 0,
"refrigerationTypeID": "",
"refrigerationTypeText": "",
"criticalComment": "",
"informationalComment": "",
"hiddenComment": "",
"saleComment": "",
"needsReview": 1,
"dateAdded": "2018-05-22T08:20:14Z",
"statusTypeID": "4bb15042-80f2-4c25-bcdd-3f24e436646b",
"statusTypeText": "Active",
"isActiveStatus": 1,
"statusChangedOn": "2018-05-22T08:20:12Z",
"changedOn": "2021-01-11T14:44:29Z",
"changedByID": "0a334e13-9c6a-404f-9448-815ee4e24217",
"changedByName": "RENEE OLIVER",
"changedAt": "2dbd3435-fe93-4d79-8aaf-6d258a98fed7",
"changedAtLocation": "PRX Pharmacy (Scrambled)",
"isDeleted": 0,
"isIv": 0,
"isFlex": 0
}
]
},
"metadata": []
}
Method Name - ItemGet
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - ItemGet ItemGet will return the Item information.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| ItemID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
Item Search
Example Request Body:
{
"MethodName": "ItemSearch",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "BDENNARD"
},
{
"Name": "NDC",
"Value": "69315%"
},
{
"Name": "GCN",
"Value": "8209"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"itemSearchResults": [
{
"itemID": "9312779a-1c2a-4f76-9838-871b7c04c7b8",
"itemTypeID": 1,
"itemTypeText": "Rx",
"itemName": "Furosemide 40 Mg Tablet",
"printName": "Furosemide 40 Mg Tablet",
"itemGroup": "",
"upc": "369315117101",
"upc12WithCheckDigit": "369315117101",
"ndc": "69315011710",
"departmentID": "bc577215-6841-4101-b7f5-6a89a5dda041",
"departmentName": "Rx",
"labelTypeID": 1,
"labelTypeText": "Generic",
"drugClassID": 1,
"drugClassText": "Rx",
"deaSchedule": 0,
"manufacturer": "Leading Pharma",
"gcn": "8209",
"legacyNumber": "",
"dispensingUnitID": 1,
"dispensingUnitText": "EA",
"stockSize": 1000.000000000,
"strength": "40 mg",
"statusTypeID": "4bb15042-80f2-4c25-bcdd-3f24e436646b",
"statusTypeText": "Active",
"isActiveStatus": 1,
"isDeleted": 0
},
{
"itemID": "a4f91a4a-111b-479f-be21-be0218f9bd3b",
"itemTypeID": 1,
"itemTypeText": "Rx",
"itemName": "Furosemide 40 Mg Tablet",
"printName": "Furosemide 40 Mg Tablet",
"itemGroup": "",
"upc": "369315117019",
"upc12WithCheckDigit": "369315117019",
"ndc": "69315011701",
"departmentID": "bc577215-6841-4101-b7f5-6a89a5dda041",
"departmentName": "Rx",
"labelTypeID": 1,
"labelTypeText": "Generic",
"drugClassID": 1,
"drugClassText": "Rx",
"deaSchedule": 0,
"manufacturer": "Leading Pharma",
"gcn": "8209",
"legacyNumber": "",
"dispensingUnitID": 1,
"dispensingUnitText": "EA",
"stockSize": 100.000000000,
"strength": "40 mg",
"statusTypeID": "4bb15042-80f2-4c25-bcdd-3f24e436646b",
"statusTypeText": "Active",
"isActiveStatus": 1,
"isDeleted": 0
}
]
},
"metadata": []
}
Method Name - ItemSearch
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - ItemSearch Besides the required parameter RequestedByEmployeeID, at least one other parameter is required. When multiple parameters are specified, all criteria must be met (AND condition). You may also use the % in a parameter as a wildcard. When the % is used, the LIKE condition is used vs the EQUAL condition.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| AlternateID | AnsiString(50) | No | |
| DeaSchedule | Int32 | No | |
| DepartmentID | Guid | No | |
| DispensingUnitID | Int32 | No | |
| DrugClassID | Int32 | No | |
| GCN | AnsiString(50) | No | |
| IsActive | Int32 | No | |
| IsDeleted | Int32 | No | |
| ItemGroup | AnsiString(50) | No | |
| ItemID | Guid | No | |
| ItemName | AnsiString(100) | No | |
| ItemPrintName | AnsiString(100) | No | |
| ItemTypeID | Int32 | No | |
| LabelTypeID | Int32 | No | |
| LegacyNumber | AnsiString(50) | No | |
| Manufacture | AnsiString(50) | No | |
| NDC | AnsiString(20) | No | |
| StatusTypeID | Guid | No | |
| UPC | AnsiString(100) | No | |
| Upc12WithCheckDigit | AnsiString(12) | No |
AR
Account Balance Info Get
Example Request Body:
{
"MethodName": "AccountBalanceInfoGet",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "AccountID",
"Value": "006893FC-109F-4FC4-AA54-00343AF8F35B"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"accountBalanceInfo": [
{
"accountID": "006893fc-109f-4fc4-aa54-00343af8f35b",
"currentBalance": 90.7600,
"newCharges": 45.3800,
"aging0To29": 45.3800,
"aging30": 45.4800,
"aging60": 45.3800,
"aging90": 0.0000,
"aging120": 13.9400,
"totalPastDue": 104.8000,
"totalBalance": 195.5600,
"lastPaymentOn": "2022-10-25T00:00:00Z",
"lastPaymentAmount": -23.0000,
"balanceStatusID": 5,
"balanceStatusText": "120 Days Past Due",
"lastUpdateOn": "2022-10-28T04:26:29Z",
"lastUpdateByProcess": "Automatic Update",
"lastActivityOn": "2022-10-25T00:00:00Z",
"unreconciledBalance": 0.0000,
"unreconciledPaymentTotal": 0.0000,
"changedOnUTC": "2022-10-28T08:26:29Z"
}
]
},
"metadata": []
}
Method Name - AccountBalanceInfoGet
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - AccountBalanceInfoGet This method will return account balance information for a given AccountID. TotalBalance is what you owe as of now. TotalBalance=Aging120+Aging90+Aging60+Aging30+Aging0To29+NewCharges. CurrentBalance=NewCharges+Aging0To29. TotalPastDue=Aging120+Aging90+Aging60+Aging30
| Field Name | Type | Notes | Required |
|---|---|---|---|
| AccountID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
External Location
External Location Get
Example Request Body:
{
"MethodName": "ExternalLocationGet",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "ExternalLocationID",
"Value": "3afdf8e9-6d2f-4c36-9dc5-13dfefa3d1a4"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"externalLocation": [
{
"externalLocationID": "3afdf8e9-6d2f-4c36-9dc5-13dfefa3d1a4",
"externalLocationName": "The Pharmacy",
"externalLocationTypeID": 4,
"externalLocationTypeText": "Pharmacy",
"dea": "BR9999999",
"npi": "8888888888",
"primaryAddress": "2020 Mocking Bird Lane",
"primaryCity": "Shreveport",
"primaryStateCode": "LA",
"primaryZipCode": "88888-9416",
"primaryPhone": "8887774444",
"primaryPhoneExt": "0",
"primaryFax": "8887775555",
"primaryFaxExt": "",
"inNetwork": 0,
"rxLocalPartnerStatusTypeID": 1,
"rxLocalPartnerStatusTypeText": "Enrolled"
}
],
"pharmacistList": [
{
"pharmacistID": "e9db7c86-8321-4c1f-81b8-e04fedb92a1e",
"externalLocationID": "3afdf8e9-6d2f-4c36-9dc5-13dfefa3d1a4",
"firstName": "Betty",
"middleName": "",
"lastName": "Boo",
"pharmacistInCharge": 1,
"stateLicense": "",
"comment": "",
"statusTypeID": "18794030-fcd1-4fbf-b4bb-0a0b26c07b39",
"statusTypeText": "Active",
"isActiveStatusType": 1
},
{
"pharmacistID": "a5846f83-9bb0-4939-85de-0670c3281903",
"externalLocationID": "3afdf8e9-6d2f-4c36-9dc5-13dfefa3d1a4",
"firstName": "Jackie",
"middleName": "",
"lastName": "Chan",
"pharmacistInCharge": 0,
"stateLicense": "BR549X",
"comment": "",
"statusTypeID": "915cdf37-8398-44e9-a5db-3f93d5f782e2",
"statusTypeText": "Inactive",
"isActiveStatusType": 1
}
]
},
"metadata": []
}
Method Name - ExternalLocationGet
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - ExternalLocationGet This will return the information for the requested external location. By default, it will also return a list of the pharmacist at this external location.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| ExternalLocationID | Guid | You can use the ExternalLocationSearch method to find the location you desire. | Yes |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| ReturnPharmacistList | Int32 | 0 or 1, default is 1. | No |
External Location Search
Example Request Body:
{
"MethodName": "ExternalLocationSearch",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "2005"
},
{
"Name": "LocationName",
"Value": "Evansville%"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"externalLocation": [
{
"externalLocationID": "e3f3034f-db2b-4d90-bdeb-16718a78a1dc",
"externalLocationName": "Evansville In & Out Pharmacy",
"externalLocationTypeID": 4,
"externalLocationTypeText": "Pharmacy",
"dea": "JB9487850",
"npi": "1234567890",
"primaryAddress": "387 N Center St",
"primaryCity": "Shreveport",
"primaryStateCode": "LA",
"primaryZipCode": "71135-7223",
"primaryPhone": "8889994444",
"primaryPhoneExt": "",
"primaryFax": "",
"primaryFaxExt": "",
"inNetwork": 0,
"rxLocalPartnerStatusTypeID": 2,
"rxLocalPartnerStatusTypeText": "Not Enrolled"
}
]
},
"metadata": []
}
Method Name - ExternalLocationSearch
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - ExternalLocationSearch This will return a list of external locations, based on the criteria you provide for the search. When multiple parameters are specified, all criteria must be met (AND condition). You may also use the % in a parameter as a wildcard. When the % is used, the LIKE condition is used vs the EQUAL condition.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| Address | AnsiString(200) | No | |
| City | AnsiString(40) | No | |
| DEA | AnsiStringFixedLength(9) | No | |
| FaxNumber | AnsiString(15) | No | |
| InNetwork | Int32 | 0 or 1, default is 1. 1=In Network only 0=All | No |
| LocationName | AnsiString(150) | No | |
| LocationType | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 62, found under Read, Other. | No |
| NPI | AnsiString(30) | No | |
| Phone | AnsiString(15) | No | |
| RxLocalPartnerStatusTypeID | Int32 | 1,2,3, defaults to all. 1=Enrolled 2=Not Enrolled 3=Partner Network Location Record | No |
| StateCode | AnsiStringFixedLength(2) | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 5, found under Read, Other. | No |
| ZipCode | AnsiString(15) | No |
Other
Get Escript Received Message
Example Request Body:
{
"MethodName": "GetEscriptReceivedMessage",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "MessageID",
"Value": "0f5788d9-2240-40d2-b0a8-102fba92452d"
},
{
"Name": "RequestedByEmployeeID",
"Value": "1391"
}
]
}
Method Name - GetEscriptReceivedMessage
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| MessageID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes |
Get Fill Request Count
Example Request Body:
{
"MethodName": "GetFillRequestCount",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "BreakDownByOrigin",
"Value": "1"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"fillRequestCounts": [
{
"app": 0,
"auto Refill": 0,
"batch Fill": 0,
"data Entry": 0,
"escript": 23,
"facility Cycle Fill": 0,
"future Fill": 0,
"intake": 4,
"ivr": 0,
"partner Program": 0,
"retail Cycle Fill": 0,
"rx Local": 0,
"rx Resupply": 0,
"unknown": 0
}
],
"breakdownByOrigin": [
{
"rxFillRequestedMethodTypeID": 7,
"rxFillRequestedText": "Intake",
"originTypeID": 0,
"breakdownCount": 4
},
{
"rxFillRequestedMethodTypeID": 8,
"rxFillRequestedText": "Escript",
"originTypeID": 5,
"originTypeText": "Electronic",
"breakdownCount": 23
}
]
},
"metadata": []
}
Method Name - GetFillRequestCount
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - GetFillRequestCount GetFillRequestCount will return the counts of each method in the fill request queue including priority fill requests.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| BreakDownByOrigin | Boolean | 0=no breakdown, default 1=Give Breakdown | No |
| RequestedTimeFrame | Int32 | 0,1..90, default is 0. 0=All fill requests 1..90=Only fill request in the last # days. | No |
Get Incoming Document Count
Example Request Body:
{
"MethodName": "GetIncomingDocumentCount",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "8550"
}
]
}
Method Name - GetIncomingDocumentCount
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | Yes | |
| RequestedTimeFrame | Int32 | No |
Item Image And Imprint
Example Request Body:
{
"MethodName": "ItemImageAndImprint",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "RxTransactionID",
"Value": "344dfb65-60c3-4f63-8b15-fcfb6a6da5bd"
}
]
}
Method Name - ItemImageAndImprint
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RxTransactionID | Guid | Yes |
Look Up List Detail Get
Example Request Body:
{
"MethodName": "LookUpListDetailGet",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "LookuplistID",
"Value": "4"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"lookUpListDetails": [{
"lookupListID": 4,
"lookupListName": "Status Type Patient",
"statusTypePatientID": "82234941-3dbc-4b49-afb9-28b259a3391d",
"statusTypePatientText": "Relocated",
"isActive": 1
}, {
"lookupListID": 4,
"lookupListName": "Status Type Patient",
"statusTypePatientID": "9a2847dc-e84f-4dc3-bf53-4fba42743a8d",
"statusTypePatientText": "Deceased",
"isActive": 0
}, {
"lookupListID": 4,
"lookupListName": "Status Type Patient",
"statusTypePatientID": "eba0f507-7995-4481-8c30-77c9edbf9a63",
"statusTypePatientText": "Active",
"isActive": 1
}, {
"lookupListID": 4,
"lookupListName": "Status Type Patient",
"statusTypePatientID": "72d26425-0773-4fe7-b0d9-8356415041b0",
"statusTypePatientText": "Inactive",
"isActive": 0
}, {
"lookupListID": 4,
"lookupListName": "Status Type Patient",
"statusTypePatientID": "c8d63fae-592b-4c41-b37b-d9fd4a8864ca",
"statusTypePatientText": "Other",
"isActive": 1
}]
},
"metadata": []
}
Method Name - LookUpListDetailGet
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - LookUpListDetailGet LookUpListDetailGet will return a list of valid values for a specific LookUpListID. The values returned will be used in various API methods.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| LookuplistID | Int32 | Yes |
Look Up List Get
Example Request Body:
{
"MethodName": "LookUpListGet",
"Version": 1.0,
"ParameterCollection": [
]
}
Success Response:
StatusCode: 200
{
"results": {
"lookUpListTableContents": [
{
"lookupListID": 1,
"lookupListName": "Priority Type",
"lookupListDescription": "List of valid Priority Types"
},
{
"lookupListID": 2,
"lookupListName": "Phone Type",
"lookupListDescription": "List of valid Phone Types"
},
{
"lookupListID": 3,
"lookupListName": "Address Type",
"lookupListDescription": "List of valid Address Types"
},
{
"lookupListID": 4,
"lookupListName": "Status Type Patient",
"lookupListDescription": "List of valid Patient Status Types"
}
]
},
"metadata": []
}
Method Name - LookUpListGet
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - LookUpListGet LookUpListGet will return a list of all possiple lookup list that are required by various API methods. This list will grow as more API methods are added that require specific values.
Medication Get
Example Request Body:
{
"MethodName": "MedicationGet",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhard"
},
{
"Name": "MedicationID",
"Value": "150003"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"medication": [
{
"medicationID": 150003.0,
"medicationDescription": "erythromycin (bulk) powder"
}
]
},
"metadata": []
}
Method Name - MedicationGet
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - MedicationGet MedicationGet will return the Medication information. Normally from the MedicationId on the Rx.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| MedicationID | Int32 | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
Test
Example Request Body:
{
"MethodName": "Test",
"Version": "1.0",
"ParameterCollection": [
]
}
Method Name - Test
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - This is a test Description
Test Full
Example Request Body:
{
"MethodName": "TestFull",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "Date",
"Value": "11/24/2020"
},
{
"Name": "DecimalValue",
"Value": "95.46"
},
{
"Name": "String",
"Value": "Jeremiah"
},
{
"Name": "IntegerValue",
"Value": "7722"
},
{
"Name": "Char",
"Value": "NewRx"
},
{
"Name": "Binary",
"Value": "1"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"sample": [
{
"methodID": "d7245b8c-a7de-4570-9a5f-153fa355de26",
"methodName": "RxHardcopyImage",
"versionMajor": 1
},
{
"methodID": "58d4fa77-16fc-4161-8cea-65129af2c006",
"methodName": "Test",
"versionMajor": 1
},
{
"methodID": "a33e8f59-57de-401f-8dae-7b35012c91e9",
"methodName": "TestFull",
"versionMajor": 1
},
{
"methodID": "363224d6-6f5a-48a6-af27-e51e706a1a20",
"methodName": "ItemImageAndImprint",
"versionMajor": 1
}
],
"history": [
{
"methodRequestAuditID": 1,
"credentialMethodVersionID": "1c1fc0b4-ad2a-489f-9fd7-7a7731df4232",
"requestData": "{\n \"MethodName\": \"TestFull\",\n \"Version\": 1,\n \"ParameterCollection\": [\n {\n \"Name\": \"Date\",\n \"Value\": \"01/01/2020\"\n },\n {\n \"Name\": \"Guid\",\n \"Value\": \"4bc9cfdf-0afe-425d-b8ae-b509d06f7fe1\"\n },\n {\n \"Name\": \"DecimalValue\",\n \"Value\": 123.123\n },\n {\n \"Name\": \"IntegerValue\",\n \"Value\": 123\n },\n {\n \"Name\": \"Binary\",\n \"Value\": null\n },\n {\n \"Name\": \"Char\",\n \"Value\": \"12fdf\"\n },\n {\n \"Name\": \"String\",\n \"Value\": \"1234'; SELECT * FROM Api.MethodVersion --\"\n }\n ]\n}",
"requestTimestamp": "2020-01-31T20:12:00.643Z",
"requestSignature": "JjUxekrT1deXSbOMDT3rojbSd4ZfU9SG0Pay9UA9KDqjwRKbZPyuapM4BiwNaQT5G6m6YEQVwIhEDuFZNb7VGg==",
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.78 Safari/537.36",
"ipAddress": "fe80::2499:cfea:c75e:8647%20",
"durationMilliseconds": 20,
"wasSuccessful": 1,
"createdOn": "2020-01-31T14:12:13Z"
},
{
"methodRequestAuditID": 2,
"credentialMethodVersionID": "e2b639a8-51c8-4590-b3f2-eed56602e5ca",
"requestData": "{\n \"MethodName\": \"ItemImageAndImprint\",\n \"Version\": 1,\n \"ParameterCollection\": [\n {\n \"Name\": \"RxTransactionID\",\n \"Value\": \"BA5ACB99-A947-4EBE-908E-850E778A1F4B\"\n }\n ]\n}",
"requestTimestamp": "2020-01-31T20:14:01.420Z",
"requestSignature": "7xadvgtqOWAKLCJuE8sKPoEAPX53hWUcZ6ojxGeCplzH79Puh0UzqAFtWfn25iLGkhDeAQ1XzQIOtuGmJzhAFQ==",
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.78 Safari/537.36",
"ipAddress": "fe80::2499:cfea:c75e:8647%20",
"durationMilliseconds": 20,
"wasSuccessful": 1,
"createdOn": "2020-01-31T14:14:12Z"
}
]
},
"metadata": []
}
Method Name - TestFull
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| Char | StringFixedLength(5) | Yes | |
| Date | Date | Yes | |
| DecimalValue | Decimal | Yes | |
| IntegerValue | Int32 | Yes | |
| String | String(50) | String parameter that allows an alphanumeric sequence with a max length of 50 characters | Yes |
| Binary | Binary | No | |
| Guid | Guid | No |
Test Xml Parameters
Example Request Body:
{
"MethodName": "TestXmlParameters",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "PersonID",
"Value": "08cda14f-a019-4742-a2f5-8b118bef6f15"
},
{
"Name": "Test",
"Value": "1989"
}
]
}
Method Name - TestXmlParameters
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| Test | Int32 | Yes | |
| Number | Int32 | No |
Write Methods
Patient
Add Patient
Example Request Body:
{
"MethodName": "AddPatient",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "LastName",
"Value": "Archer"
},
{
"Name": "FirstName",
"Value": "Albert"
},
{
"Name": "DateOfBirth",
"Value": "4/24/1960"
},
{
"Name": "Gender",
"Value": "M"
},
{
"Name": "MiddleName",
"Value": "L"
},
{
"Name": "ExternalID",
"Value": "BR549"
},
{
"Name": "PrimaryPhoneNumber",
"Value": "3187971717"
},
{
"Name": "PrimaryPhoneTypeID",
"Value": "859C2036-74EC-44A6-AF73-F72F44C59791"
},
{
"Name": "PrimaryAddress",
"Value": "408 Kay Ln"
},
{
"Name": "PrimaryCity",
"Value": "Shreveport"
},
{
"Name": "PrimaryStateCode",
"Value": "LA"
},
{
"Name": "PrimaryZipCode",
"Value": "711151234"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"person": [{
"personID": "d5f3122a-9cb2-49e7-aa1c-3e8fbfe58592"
}]
},
"metadata": []
}
Method Name - AddPatient
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - AddPatient Besides the parameters that are required, PersonID is a parameter that may be also used if you would like to tell the API what guid you would like to use for the patient. If PersonID is not passed in, then the system generated guid will be returned in the result set.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| DateOfBirth | Date | Yes | |
| FirstName | AnsiString(50) | Yes | |
| Gender | AnsiStringFixedLength(1) | M, F, and other valid values can be found using the method LookUpListDetailGet, LookUpListID = 42, found under Read, Other. | Yes |
| LastName | AnsiString(50) | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| AdherenceDoNotPhone | Int32 | 0 or 1, default is 0. | No |
| AdherenceEmployeeID | Guid | Valid Employee, PersonID. This is commonly known as Health Coach. | No |
| AllergyStatusTypeID | Int32 | 0 or 1, default is 0. 0=Ask Patient? 1=No Known Allergies | No |
| AlternateID | AnsiString(50) | No | |
| AlternateIDTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 7, found under Read, Other. | No |
| AnimalFeedTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 15, found under Read, Other. | No |
| AnimalOwnerID | Guid | Valid Patient, PersonID | No |
| AnimalPerformanceTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 16, found under Read, Other. | No |
| AnimalSpeciesTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 14, found under Read, Other. | No |
| AutoFillModeTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 8, found under Read, Other. | No |
| BirthOrder | Int32 | No | |
| BirthStateCode | AnsiStringFixedLength(2) | No | |
| CallWhenReady | Int32 | 0 or 1, default is 0. | No |
| CcncID | AnsiString(50) | No | |
| CountyID | Guid | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 19, found under Read, Other. | No |
| CriticalComment | AnsiString | No | |
| DefaultPriorityTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 1, found under Read, Other. | No |
| DeliveryMethodComment | AnsiString | No | |
| DeliveryMethodID | Guid | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 9, found under Read, Other. | No |
| DeliveryPaymentTypeEnum | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 10, found under Read, Other. | No |
| DeliveryZoneID | Guid | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 11, found under Read, Other. | No |
| Diagnosis | AnsiString | No | |
| Diet | AnsiString | No | |
| DoNotEmail | Int32 | 0 or 1, default is 0. | No |
| DoNotFax | Int32 | 0 or 1, default is 0. | No |
| DoNotMail | Int32 | 0 or 1, default is 0. | No |
| DoNotPhone | Int32 | 0 or 1, default is 0. | No |
| DoNotText | Int32 | 0 or 1, default is 0. | No |
| DriversLicenseExpirationDate | Date | No | |
| DriversLicenseNumber | AnsiString(50) | No | |
| DriversLicenseStateCode | AnsiStringFixedLength(2) | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 5, found under Read, Other. | No |
| EmailAddress | AnsiString(255) | No | |
| EthnicityTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 13, found under Read, Other. | No |
| ExternalID | AnsiString(50) | No | |
| EZOpen | Int32 | 0 or 1, default is 0. | No |
| FacilityAllergyText | AnsiString | No | |
| GoGreenEnrolledOn | DateTime | No | |
| HearingImpaired | Int32 | 0 or 1, default is 0. | No |
| HeightInches | Int32 | No | |
| HiddenComment | AnsiString | No | |
| IdentificationExpirationDate | DateTime | No | |
| IgnoreACEIARB | Int32 | 0 or 1, default is 0. | No |
| IgnoreHRM | Int32 | 0 or 1, default is 0. | No |
| IgnorePregnancyPrecautions | Int32 | 0 or 1, default is 0. | No |
| ImmunizationRegistryID | AnsiString(50) | No | |
| InformationComment | AnsiString | No | |
| KloudScriptID | AnsiString(50) | No | |
| LanguageTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 17, found under Read, Other. | No |
| LoyaltyID | AnsiString(50) | No | |
| LoyaltyStartDate | DateTime | No | |
| MedConditionStatusTypeID | Int32 | 0 or 1, default is 0. 0=Ask Patient? 1=No Known Medical Conditions | No |
| MedicaidNumber | AnsiString(50) | No | |
| MedicareBeneficiaryID | AnsiString(11) | No | |
| MedicarePartANumber | AnsiString(50) | No | |
| MiddleName | AnsiString(30) | No | |
| MirixaID | AnsiString(50) | No | |
| MothersMaidenName | AnsiString(250) | No | |
| MultiDose | Int32 | 0 or 1, default is 0. | No |
| NoCheckPayment | Int32 | 0 or 1, default is 0. | No |
| OtherMedStatusTypeID | Int32 | 0 or 1, default is 0. 0=Ask Patient? 1=No Known Other Medications | No |
| OutcomesID | AnsiString(50) | No | |
| PassportTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 20, found under Read, Other. | No |
| PatientEducationID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 34, found under Read, Other. | No |
| PatientMeducationFontSizeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 37, found under Read, Other. | No |
| PatientMeducationLanguageID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 36, found under Read, Other. | No |
| PatientTierOverrideTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 21, found under Read, Other. | No |
| PersonID | Guid | If not provided, a guid will be generated by the system and returned in the results. | No |
| PreferBrand | Int32 | 0 or 1, default is 0. | No |
| PrimaryAddress | AnsiString(200) | No | |
| PrimaryCarePrescriberID | Guid | Valid Prescriber, PersonID | No |
| PrimaryCity | AnsiString(40) | No | |
| PrimaryCountry | AnsiString(50) | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 6, found under Read, Other. | No |
| PrimaryExtension | AnsiString(8) | No | |
| PrimaryPhoneNumber | AnsiString(15) | No | |
| PrimaryPhoneTypeID | Guid | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 2, found under Read, Other. | No |
| PrimaryStateCode | AnsiStringFixedLength(2) | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 5, found under Read, Other. | No |
| PrimaryStateName | AnsiString(50) | No | |
| PrimaryZipCode | AnsiString(15) | No | |
| PrintPatientEducationTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 35, found under Read, Other. | No |
| RaceTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 12, found under Read, Other. | No |
| RehabPotential | AnsiString | No | |
| RestrictCashOnlyPHI | Int32 | 0 or 1, default is 0. | No |
| RxNotifyTypeID | Int32 | 0 or 1, default is 0. 0=Ask Patient? 1=Do not notify | No |
| SaleComment | AnsiString | No | |
| Salutation | AnsiString(10) | No | |
| SSN | AnsiString(9) | No | |
| StateIssuedIDStateCode | AnsiStringFixedLength(2) | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 5, found under Read, Other. | No |
| Suffix | AnsiString(10) | No | |
| SyncStartDate | DateTime | No | |
| SyncStatusTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 22, found under Read, Other. | No |
| TranslationLanguageTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 18, found under Read, Other. | No |
| UnitDose | Int32 | 0 or 1, default is 0. | No |
| UsePatientAllergyOnMar | Int32 | 0 or 1, default is 0. | No |
| UsePatientDiagnosisOnMar | Int32 | 0 or 1, default is 0. | No |
| VaNumber | AnsiString(50) | No | |
| VisuallyImpaired | Int32 | 0 or 1, default is 0. | No |
| WeeklyPlanner | Int32 | 0 or 1, default is 0. | No |
| WeightOz | Int32 | No |
Add Patient Address
Example Request Body:
{
"MethodName": "AddPatientAddress",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmplyeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "da3dad36-47d9-421b-b6c6-cee86d9164e0"
},
{
"Name": "AddressTypeID",
"Value": "39860887-56AD-4FE8-8807-286F11C8A442"
},
{
"Name": "Address",
"Value": "408 Kay Lane"
},
{
"Name": "City",
"Value": "Shreveport"
},
{
"Name": "StateCode",
"Value": "LA"
},
{
"Name": "ZipCode",
"Value": "71115"
}
]
}
Success Response:
StatusCode: 200
{"results": {"address": [ {"addressID": "68ea4abb-9ba1-4a15-ab26-23ca3cb137bd"} ] }, "metadata": []}
Method Name - AddPatientAddress
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - AddPatientAddress Besides the parameters that are required, AddressID is a parameter that may be also used if you would like to tell the API what guid you would like to use for the address. If AddressID is not passed in, then the system generated guid will be returned in the result set.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| Address | String(200) | Yes | |
| AddressTypeID | Guid | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 3, found under Read, Other. | Yes |
| City | String(40) | Yes | |
| PersonID | Guid | Valid Patient, PersonID | Yes |
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| ZipCode | String(15) | Yes | |
| AddressID | Guid | If not provided, a guid will be generated by the system and returned in the results. | No |
| Country | String(50) | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 6, found under Read, Other. | No |
| SetDeliveryAddress | Boolean | No | |
| SetMailingAddress | Boolean | No | |
| SetPrimaryAddress | Boolean | No | |
| StateCode | String(2) | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 5, found under Read, Other. | No |
| StateName | String(40) | No |
Add Patient Auto Pay Credit Card
Example Request Body:
{
"MethodName": "AddPatientAutoPayCreditCard",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "CardFirstSix",
"Value": "default value"
},
{
"Name": "CardLastFour",
"Value": "default value"
},
{
"Name": "CreditCardToken",
"Value": "default value"
},
{
"Name": "CreditCardTypeID",
"Value": "2461"
},
{
"Name": "ExpMonth",
"Value": "629"
},
{
"Name": "ExpYear",
"Value": "7882"
},
{
"Name": "PersonID",
"Value": "b2fb20b4-1e5d-4fc4-a01c-1fd689a2a7fc"
},
{
"Name": "RequestedByEmployeeID",
"Value": "9934"
},
{
"Name": "TokenIssuedByProcessorID",
"Value": "1080"
}
]
}
Method Name - AddPatientAutoPayCreditCard
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| CardFirstSix | AnsiString(6) | Yes | |
| CardLastFour | AnsiString(4) | Yes | |
| CreditCardToken | AnsiString(100) | Yes | |
| CreditCardTypeID | Int32 | Yes | |
| ExpMonth | Int32 | Yes | |
| ExpYear | Int32 | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | Yes | |
| TokenIssuedByProcessorID | Int32 | Yes | |
| AutoPayCreditCardID | Guid | No | |
| BillingAddress | AnsiString(200) | No | |
| BillingCity | AnsiString(40) | No | |
| Comments | AnsiString | No | |
| CreditCardDescription | AnsiString(100) | No | |
| NameOnCard | AnsiString(150) | No | |
| StateCode | AnsiStringFixedLength(2) | No | |
| ZipCode | AnsiString(15) | No |
Add Patient Category
Example Request Body:
{
"MethodName": "AddPatientCategory",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "CategoryID",
"Value": "f47557ef-3d3d-4c38-a3c4-a1428ea7eb6d"
},
{
"Name": "PersonID",
"Value": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - AddPatientCategory
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - AddPatientCategory This method will place a patient in the desired category.If IsPrimaryCategory=1, this category will be designated the primary category for this patient.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| CategoryID | Guid | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 23, found under Read, Other. | Yes |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| IsPrimaryCategory | Int32 | 0 or 1, default is 0. | No |
Add Patient Pay Method
Example Request Body:
{
"MethodName": "AddPatientPayMethod",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098"
},
{
"Name": "ThirdPartyID",
"Value": "ca79388c-c607-493a-9ced-ab9fa063be11"
},
{
"Name": "StartDate",
"Value": "1/1/2021"
},
{
"Name": "ExpirationDate",
"Value": "12/31/2021"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"patientPayMethod": [{
"patientPayMethodID": "aba5a53f-eabf-4d4e-b71e-532ae86a89d7"
}]
},
"metadata": []
}
Method Name - AddPatientPayMethod
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - AddPatientPayMethod Besides the parameters that are required, PatientPayMethodID is a parameter that may be also used if you would like to tell the API what guid you would like to use for the patient pay method. If PatientPayMethodID is not passed in, then the system generated guid will be returned in the result set.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| ThirdPartyID | Guid | Valid Third Party ID. SearchThridParty can provide this ID. | Yes |
| CardHolderID | String(50) | No | |
| CardHolderPersonID | Guid | Valid PersonId. Only needed if the card holder is not the patient. | No |
| DisplayName | String(100) | No | |
| EligibilityClarificationTypeID | Int32 | Defaults to 0 - Not Specified Valid values can be found using the method LookUpListDetailGet, LookUpListID = 26, found under Read, Other. | No |
| ExpirationDate | DateTime | No | |
| GroupNumber | String(50) | No | |
| InformationalComment | String | No | |
| PatientLocationTypeID | Int32 | Defaults to 0 - Not Specified Valid values can be found using the method LookUpListDetailGet, LookUpListID = 27, found under Read, Other. | No |
| PatientPayMethodID | Guid | If not provided, a guid will be generated by the system and returned in the results. | No |
| PatientRelationshipTypeID | Int32 | Defaults to 0 - Not Specified Valid values can be found using the method LookUpListDetailGet, LookUpListID = 28, found under Read, Other. | No |
| Pcn | String(50) | No | |
| PlaceOfResidenceTypeID | Int32 | Defaults to 0 - Not Specified Valid values can be found using the method LookUpListDetailGet, LookUpListID = 29, found under Read, Other. | No |
| PlaceOfServiceTypeID | Int32 | Defaults to 1 - Pharmacy Valid values can be found using the method LookUpListDetailGet, LookUpListID = 30, found under Read, Other. | No |
| RelationCode | String(10) | No | |
| StartDate | DateTime | Defaults to current date if not passed. | No |
Add Patient Phone
Example Request Body:
{
"MethodName": "AddPatientPhone",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmplyeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "da3dad36-47d9-421b-b6c6-cee86d9164e0"
},
{
"Name": "PhoneNumber",
"Value": "3334447777"
},
{
"Name": "PhoneTypeID",
"Value": "E7EA71DA-F05C-4441-BDE4-33B4E30F8926"
}
]
}
Method Name - AddPatientPhone
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - AddPatientPhone Besides the parameters that are required, PhoneID is a parameter that may be also used if you would like to tell the API what guid you would like to use for the phone. If PHoneID is not passed in, then the system generated guid will be returned in the result set.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Valid Patient, PersonID | Yes |
| PhoneNumber | String(15) | 10 Digit phone number, no special characters. | Yes |
| PhoneTypeID | Guid | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 2, found under Read, Other. | Yes |
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| DialString | String(50) | No | |
| Extension | String(8) | No | |
| PhoneID | Guid | If not provided, a guid will be generated by the system and returned in the results. | No |
| SetPrimaryPhone | Boolean | No | |
| SetSmsPhone | Boolean | No |
Deactivate Patient Pay Method
Example Request Body:
{
"MethodName": "DeactivatePatientPayMethod",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098"
},
{
"Name": "PatientPayMethodID",
"Value": "23f39fce-5acf-4f96-acf5-d81d59165123"
}
]
}
Success Response:
StatusCode: 200
{
"results": {},
"metadata": []
}
Method Name - DeactivatePatientPayMethod
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - DeactivatePatientPayMethod This method will deactivate the desired pay method.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PatientPayMethodID | Guid | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
Delete Patient Address
Example Request Body:
{
"MethodName": "DeletePatientAddress",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "AddressID",
"Value": "5aeebd69-b41a-4d74-9ba5-b85f6c458e52"
},
{
"Name": "PersonID",
"Value": "fa6f4110-cd5e-4460-b6db-52ccfcd5d9ed"
},
{
"Name": "RequestedByEmployeeID",
"Value": "5201"
}
]
}
Method Name - DeletePatientAddress
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| AddressID | Guid | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes |
Delete Patient Auto Pay Credit Card
Example Request Body:
{
"MethodName": "DeletePatientAutoPayCreditCard",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "AutoPayCreditCardID",
"Value": "ac79de8c-df23-4867-acf8-bab310b37017"
},
{
"Name": "PersonID",
"Value": "7aff9999-759f-4e0c-b2c6-579985b062c9"
},
{
"Name": "RequestedByEmployeeID",
"Value": "5166"
}
]
}
Method Name - DeletePatientAutoPayCreditCard
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| AutoPayCreditCardID | Guid | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | Yes |
Delete Patient Category
Example Request Body:
{
"MethodName": "DeletePatientCategory",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "CategoryID",
"Value": "f47557ef-3d3d-4c38-a3c4-a1428ea7eb6d"
},
{
"Name": "PersonID",
"Value": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - DeletePatientCategory
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - DeletePatientCategory This method will remove a patient from the desired category.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| CategoryID | Guid | A list of categories a patient is current in can be found using the method GetPatientCategory, found under Read, Patient. | Yes |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
Delete Patient Phone
Example Request Body:
{
"MethodName": "DeletePatientPhone",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "PersonID",
"Value": "1b66a3b9-4e55-4e4b-91b2-519beb9268ff"
},
{
"Name": "PhoneID",
"Value": "5d57a937-0069-4fee-993d-52a7f085670e"
},
{
"Name": "RequestedByEmployeeID",
"Value": "8238"
}
]
}
Method Name - DeletePatientPhone
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| PhoneID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes |
Patient Document Add
Example Request Body:
{
"MethodName": "PatientDocumentAdd",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "181fd93b-372b-4ab8-8ac1-c6661bb2ee62"
},
{
"Name": "DocumentImage",
"Value": ""
},
{
"Name": "DocumentImageTypeID",
"Value": "26792ccf-5c52-43f3-8ad6-f85c354362e2"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"document": [{
"documentID": "72d888b7-09c8-4813-9fcb-769f940be583"
}]
}
, "metadata": []
}
Method Name - PatientDocumentAdd
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - PatientDocumentAdd This method will add a document to a patient.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| DocumentImage | AnsiString | This must be a valid base64 encoded string. The example body you see is just an example and not a valid value.
This will be a PDF,JPG,PNG,TIF,BMP document. We run it through a simple tool to validate it is a valid base64 encoded string. A good website for reference is:https://base64.guru/converter/encode or https://base64.guru/converter/decode or use this one for pdf, https://base64.guru/converter/decode/pdf | Yes |
| DocumentImageTypeID | Guid | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 53, found under Read, Other. | Yes |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| Description | AnsiString(100) | No | |
| DocumentFileName | AnsiString(1000) | This is just a reference to the file name that may have been used for this image. | No |
| DocumentID | Guid | If one is not passsed in, one will be created for you and passed back in the results. | No |
| DocumentName | AnsiString(100) | If not passed in, the value will be loaded from the LookUpListID = 53, DocumentImageTypeText. | No |
Set Patient Delivery Address
Example Request Body:
{
"MethodName": "SetPatientDeliveryAddress",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "AddressID",
"Value": "b82dd5d2-a068-4d9a-9c71-2bde70b8d7e9"
},
{
"Name": "PersonID",
"Value": "e2b98569-0bbe-42b4-9685-93694765bb9d"
},
{
"Name": "RequestedByEmployeeID",
"Value": "4308"
}
]
}
Method Name - SetPatientDeliveryAddress
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| AddressID | Guid | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | Yes |
Set Patient Mailing Address
Example Request Body:
{
"MethodName": "SetPatientMailingAddress",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "AddressID",
"Value": "4e59394e-8910-4248-844f-edb34cfabd0a"
},
{
"Name": "PersonID",
"Value": "d171704c-d72c-42fb-b403-5b7e721be0fc"
},
{
"Name": "RequestedByEmployeeID",
"Value": "5250"
}
]
}
Method Name - SetPatientMailingAddress
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| AddressID | Guid | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | Yes |
Set Patient Pay Method Billing Order
Example Request Body:
{
"MethodName": "SetPatientPayMethodBillingOrder",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098"
},
{
"Name": "PatientPayMethodID",
"Value": "aba5a53f-eabf-4d4e-b71e-532ae86a89d7"
},
{
"Name": "BillingOrder",
"Value": "P"
}
]
}
Success Response:
StatusCode: 200
{
"results": {},
"metadata": []
}
Method Name - SetPatientPayMethodBillingOrder
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - SetPatientPayMethodBillingOrder This method will set the desired pay method to the desired billing order. Example, if a pay method is now Other, you change it to Primary, the previous pay mehtod that was Primary will become Other. It is strongly recommended that you use the method GetPatient, prior to update, in order to insure that you have the latest information for your update. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| BillingOrder | AnsiStringFixedLength(1) | P-Primary S-Secondary O-Other | Yes |
| PatientPayMethodID | Guid | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
Set Patient Primary Address
Example Request Body:
{
"MethodName": "SetPatientPrimaryAddress",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "AddressID",
"Value": "3578e3d9-d268-414e-bffd-d31f1ed8c66e"
},
{
"Name": "PersonID",
"Value": "8c2f68b6-d203-4c23-80ea-1e79b834a4c2"
},
{
"Name": "RequestedByEmployeeID",
"Value": "7184"
}
]
}
Method Name - SetPatientPrimaryAddress
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| AddressID | Guid | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | Yes |
Set Patient Primary Phone
Example Request Body:
{
"MethodName": "SetPatientPrimaryPhone",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "PersonID",
"Value": "52af218c-815b-4a96-89a0-e1bb0c147731"
},
{
"Name": "PhoneID",
"Value": "2e8a00f6-0354-4c1b-b069-917ac9dc44b4"
},
{
"Name": "RequestedByEmployeeID",
"Value": "5193"
}
]
}
Method Name - SetPatientPrimaryPhone
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| PhoneID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | Yes |
Set Patient Sms Phone
Example Request Body:
{
"MethodName": "SetPatientSmsPhone",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "PersonID",
"Value": "9e00c62f-dbc5-4e31-901c-2430006a2e96"
},
{
"Name": "PhoneID",
"Value": "5b66a787-5fc2-4882-8db0-2802bc331332"
},
{
"Name": "RequestedByEmployeeID",
"Value": "1050"
}
]
}
Method Name - SetPatientSmsPhone
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| PhoneID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | Yes |
Update Patient Address
Example Request Body:
{
"MethodName": "UpdatePatientAddress",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "Address",
"Value": "text value"
},
{
"Name": "AddressID",
"Value": "b9e349ec-28e7-4c40-8093-1481b213e9ae"
},
{
"Name": "AddressTypeID",
"Value": "bb63c6fb-26b4-4e9b-9e8e-f21451e1fa85"
},
{
"Name": "City",
"Value": "text value"
},
{
"Name": "PersonID",
"Value": "747fa83b-85b8-4fb7-bb84-3ad442cf4857"
},
{
"Name": "RequestedByEmployeeID",
"Value": "2116"
},
{
"Name": "ZipCode",
"Value": "text value"
}
]
}
Method Name - UpdatePatientAddress
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| Address | String(200) | Yes | |
| AddressID | Guid | Yes | |
| AddressTypeID | Guid | Yes | |
| City | String(40) | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes | |
| ZipCode | String(15) | Yes | |
| Country | String(50) | No | |
| SetDeliveryAddress | Boolean | No | |
| SetMailingAddress | Boolean | No | |
| SetPrimaryAddress | Boolean | No | |
| StateCode | String(2) | No | |
| StateName | String(40) | No |
Update Patient Adherence Employee
Example Request Body:
{
"MethodName": "UpdatePatientAdherenceEmployee",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "c42c10c1-f0d9-4302-b5b9-468ab7b033e8"
},
{
"Name": "AdherenceEmployeeID",
"Value": "BD02DDC2-DBCC-4686-BE2F-0D9C0B50E6B0"
}
]
}
Success Response:
StatusCode: 200
{
"results": {},
"metadata": []
}
Method Name - UpdatePatientAdherenceEmployee
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdatePatientAdherenceEmployee This method will upate patient adherence employee, commonly referred to as health coach. It is strongly recommended that you use the method GetPatient, prior to update, in order to insure that you have the latest information for your update. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| AdherenceEmployeeID | Guid | Valid Employee, PersonID. This is commonly know as Health Coach. | No |
Update Patient Allergy Status Type
Example Request Body:
{
"MethodName": "UpdatePatientAllergyStatusType",
"Version": 2.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "3f4f3284-e9a5-4210-ac92-195cc656576c"
},
{
"Name": "AllergyStatusTypeID",
"Value": "1"
}
]
}
Success Response:
StatusCode: 200
{"results": {},"metadata": []}
Method Name - UpdatePatientAllergyStatusType
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdatePatientAllergyStatusType This method will update the patient allergy status.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| AllergyStatusTypeID | Int32 | 0=Ask Patient? 1=No Known Allergies | Yes |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
Update Patient Auto Pay Credit Card
Example Request Body:
{
"MethodName": "UpdatePatientAutoPayCreditCard",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "AutoPayCreditCardID",
"Value": "07380dc9-8a19-43bc-b328-d9f9dbb03b38"
},
{
"Name": "CardFirstSix",
"Value": "default value"
},
{
"Name": "CardLastFour",
"Value": "default value"
},
{
"Name": "CreditCardToken",
"Value": "default value"
},
{
"Name": "CreditCardTypeID",
"Value": "2554"
},
{
"Name": "ExpMonth",
"Value": "4569"
},
{
"Name": "ExpYear",
"Value": "959"
},
{
"Name": "PersonID",
"Value": "0bef1ac5-4709-4c65-b51c-aa6745f3029b"
},
{
"Name": "RequestedByEmployeeID",
"Value": "3620"
},
{
"Name": "TokenIssuedByProcessorID",
"Value": "3392"
}
]
}
Method Name - UpdatePatientAutoPayCreditCard
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| AutoPayCreditCardID | Guid | Yes | |
| CardFirstSix | AnsiString(6) | Yes | |
| CardLastFour | AnsiString(4) | Yes | |
| CreditCardToken | AnsiString(100) | Yes | |
| CreditCardTypeID | Int32 | Yes | |
| ExpMonth | Int32 | Yes | |
| ExpYear | Int32 | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | Yes | |
| TokenIssuedByProcessorID | Int32 | Yes | |
| BillingAddress | AnsiString(200) | No | |
| BillingCity | AnsiString(40) | No | |
| Comments | AnsiString | No | |
| CreditCardDescription | AnsiString(100) | No | |
| NameOnCard | AnsiString(150) | No | |
| StateCode | AnsiStringFixedLength(2) | No | |
| ZipCode | AnsiString(15) | No |
Update Patient Basic
Example Request Body:
{
"MethodName": "UpdatePatientBasic",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "c42c10c1-f0d9-4302-b5b9-468ab7b033e8"
},
{
"Name": "LastName",
"Value": "Rabbit"
},
{
"Name": "FirsName",
"Value": "Roger"
},
{
"Name": "DateOfBirth",
"Value": "4/24/1982"
},
{
"Name": "Gender",
"Value": "M"
}
]
}
Success Response:
StatusCode: 200
{
"results": {},
"metadata": []
}
Method Name - UpdatePatientBasic
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdatePatientBasic This method will upate basic patient information. It is strongly recommended that you use the method GetPatient, prior to update, in order to insure that you have the latest information for your update. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| DateOfBirth | Date | Yes | |
| FirstName | AnsiString(50) | Yes | |
| Gender | AnsiStringFixedLength(1) | M, F, and other valid values can be found using the method LookUpListDetailGet, LookUpListID = 43, found under Read, Other. | Yes |
| LastName | AnsiString(50) | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| EmailAddress | AnsiString(255) | No | |
| IgnorePregnancyPrecautions | Int32 | 0 or 1, default is 0. | No |
| MiddleName | AnsiString(30) | No | |
| Salutation | AnsiString(10) | No | |
| Suffix | AnsiString(10) | No |
Update Patient Comment
Example Request Body:
{
"MethodName": "UpdatePatientComment",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098"
},
{
"Name": "ActionType",
"Value": "1"
},
{
"Name": "CommentText",
"Value": "This is a new Informational comment"
},
{
"Name": "CommentTypeID",
"Value": "2"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - UpdatePatientComment
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdatePatientComment This method will add/replace, append or wipe out the specific comment on a patient. Passing in RTF or text formated comment will work when using Action type 1. Action type 2 is very specific at this time and will only append a true text comment to the end of a RTF comment.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| ActionType | Int32 | 1 Add/Replace 2 Append Text to existing RTF comment 3 WipeOut | Yes |
| CommentTypeID | Int32 | 1 Critical 2 Informational 3 Hidden 4 Sale | Yes |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| CommentText | AnsiString | No |
Update Patient Delivery
Example Request Body:
{
"MethodName": "UpdatePatientDelivery",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "c4e9338f-7e2d-44a7-9f90-67e9a7a7eaeb"
},
{
"Name": "DeliveryMethodID",
"Value": "7646e57a-9303-4ec8-a93f-e7fc5c545eb6"
},
{
"Name": "DeliveryZoneID",
"Value": "827fe986-d771-44bb-b7c3-54c80b6e39db"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - UpdatePatientDelivery
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdatePatientDelivery This method will update the patient delivery method. It is strongly recommended that you use the method GetPatient, prior to update, in order to insure that you have the latest information for your update. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| DeliveryMethodComment | AnsiString | No | |
| DeliveryMethodID | Guid | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 9, found under Read, Other. | No |
| DeliveryPaymentTypeEnum | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 10, found under Read, Other. | No |
| DeliveryZoneID | Guid | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 11, found under Read, Other. | No |
Update Patient Demographic
Example Request Body:
{
"MethodName": "UpdatePatientDemographic",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "c4e9338f-7e2d-44a7-9f90-67e9a7a7eaeb"
},
{
"Name": "RaceTypeID",
"Value": "1"
},
{
"Name": "LanguageTypeID",
"Value": "2"
},
{
"Name": "TranslationLanguageTypeID",
"Value": "85"
},
{
"Name": "HeightInches",
"Value": "68"
},
{
"Name": "WeightOz",
"Value": "2897"
},
{
"Name": "CountyID",
"Value": "75a0bac1-9dca-4450-a554-f9bb32a9ffa1"
},
{
"Name": "PatientBehaviorTypeID",
"Value": "4"
},
{
"Name": "EthnicityTypeID",
"Value": "3"
},
{
"Name": "MothersMaidenName",
"Value": "johnson"
},
{
"Name": "BirthStateCode",
"Value": "CA"
},
{
"Name": "BirthOrder",
"Value": "2"
},
{
"Name": "PatientEducationID",
"Value": "2"
},
{
"Name": "PatientMeducationLanguageID",
"Value": "1"
},
{
"Name": "PatientMeducationFontSizeID",
"Value": "2"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - UpdatePatientDemographic
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdatePatientDemographic This method will update the patient demographic information. It is strongly recommended that you use the method GetPatient, prior to update, in order to insure that you have the latest information for your update. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| BirthOrder | Int32 | No | |
| BirthStateCode | AnsiStringFixedLength(2) | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 5, found under Read, Other. | No |
| CountyID | Guid | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 19, found under Read, Other. | No |
| EthnicityTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 13, found under Read, Other. | No |
| HeightInches | Int32 | No | |
| LanguageTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 17, found under Read, Other. | No |
| MothersMaidenName | AnsiString(250) | No | |
| PatientBehaviorTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 38, found under Read, Other. | No |
| PatientEducationID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 35, found under Read, Other. | No |
| PatientMeducationFontSizeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 37, found under Read, Other. | No |
| PatientMeducationLanguageID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 36, found under Read, Other. | No |
| RaceTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 12, found under Read, Other. | No |
| TranslationLanguageTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 18, found under Read, Other. | No |
| WeightOz | Int32 | No |
Update Patient Identification
Example Request Body:
{
"MethodName": "UpdatePatientIdentification",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "c4e9338f-7e2d-44a7-9f90-67e9a7a7eaeb"
},
{
"Name": "ExternalID",
"Value": "BR549"
},
{
"Name": "SSN",
"Value": "123456789"
}
]
}
Success Response:
StatusCode: 200
{
"results": {},
"metadata": []
}
Method Name - UpdatePatientIdentification
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdatePatientIdentification This method will upate patient identification information. It is strongly recommended that you use the method GetPatient, prior to update, in order to insure that you have the latest information for your update. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| AlternateID | AnsiString(50) | No | |
| AlternateIDTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 7, found under Read, Other. | No |
| CcncID | AnsiString(50) | No | |
| DriversLicenseExpirationDate | Date | No | |
| DriversLicenseNumber | AnsiString(50) | No | |
| DriversLicenseStateCode | AnsiStringFixedLength(2) | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 5, found under Read, Other. | No |
| ExternalID | AnsiString(50) | No | |
| IdentificationExpirationDate | DateTime | No | |
| ImmunizationRegistryID | AnsiString(50) | No | |
| KloudScriptID | AnsiString(50) | No | |
| MedicaidNumber | AnsiString(50) | No | |
| MedicareBeneficiaryID | AnsiString(11) | No | |
| MedicarePartANumber | AnsiString(50) | No | |
| MirixaID | AnsiString(50) | No | |
| OutcomesID | AnsiString(50) | No | |
| PassportTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 20, found under Read, Other. | No |
| SSN | AnsiString(9) | No | |
| StateIssuedIDStateCode | AnsiStringFixedLength(2) | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 5, found under Read, Other. | No |
| VaNumber | AnsiString(50) | No |
Update Patient Loyalty
Example Request Body:
{
"MethodName": "UpdatePatientLoyalty",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "a40c4764-4771-44a8-a55f-904d62a45d84"
},
{
"Name": "LoyaltyID",
"Value": "BR549"
},
{
"Name": "LoyaltyStartDate",
"Value": "10/2/2021"
},
{
"Name": "PatientTierOverrideTypeID",
"Value": "2"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - UpdatePatientLoyalty
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdatePatientLoyalty This method will update the patient Loyalty information. It is strongly recommended that you use the method GetPatient, prior to update, in order to insure that you have the latest information for your update. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| LoyaltyID | AnsiString(50) | Commonly used for an external loyalty card. | No |
| LoyaltyStartDate | DateTime | Example values: "9/12/2021" | No |
| PatientTierOverrideTypeID | Int32 | AKA VIP status.
Valid values can be found using the method LookUpListDetailGet, LookUpListID = 21, found under Read, Other. | No |
Update Patient Med Sync
Example Request Body:
{
"MethodName": "UpdatePatientMedSync",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "c42c10c1-f0d9-4302-b5b9-468ab7b033e8"
},
{
"Name": "SyncStatusTypeID",
"Value": "2"
},
{
"Name": "SyncStartDate",
"Value": "9/11/2021"
},
{
"Name": "MedicationSynchronizationContactMethodID",
"Value": "1"
},
{
"Name": "NextCallDate",
"Value": "10/11/2021"
},
{
"Name": "SyncDate",
"Value": "10/20/2021"
},
{
"Name": "SyncDays",
"Value": "28"
},
{
"Name": "NextSyncDate",
"Value": "11/17/2021"
},
{
"Name": "AdherenceComments",
"Value": "Speak Loud, he is hard of hearing."
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - UpdatePatientMedSync
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdatePatientMedSync This method will update the patient Med Sync information. ***NOTE: The SyncDate + the SyncDays must always equal the NextSyncDate.*** It is HIGHLY RECOMMENDED, that you have full and complete understanding of how the Med Sync process works in PioneerRx before using this API. It is strongly recommended that you use the method GetPatient, prior to update, in order to insure that you have the latest information for your update. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| SyncStatusTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 22, found under Read, Other. | Yes |
| AdherenceComments | AnsiString | No | |
| MedicationSynchronizationContactMethodID | Int32 | 0 None, 1-Call, 2-Text Valid values can be found using the method LookUpListDetailGet, LookUpListID = 41, found under Read, Other. | No |
| NextCallDate | DateTime | If no time value passed in, will default to 08:00:00.000 as it does in the UI. Example values: "9/12/2021" or "9/12/2021 09:00:00" | No |
| NextSyncDate | DateTime | This is also nown as Next Pickup Date. Example value: "10/13/2021" | No |
| SyncDate | DateTime | This is also known as Pickup Date. Example value: "9/15/2021" | No |
| SyncDays | Int32 | Number of Days to sync. | No |
| SyncStartDate | DateTime | No |
Update Patient Med Sync Process Cycle
Example Request Body:
{
"MethodName": "UpdatePatientMedSyncProcessCycle",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "c07c425f-3b22-44b2-bf41-0bb7e6230465"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - UpdatePatientMedSyncProcessCycle
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdatePatientMedSyncProcessCycle This method will place all rxs that are set to Yes Cycle, for the patient, in the cycle fill queue. This method mimics the Process Cycle button on the Edit patient, profile tab in the UI. It is strongly recommended that you use the method GetPatient, prior to update, in order to insure that you have the latest information for your update. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
Update Patient Option
Example Request Body:
{
"MethodName": "UpdatePatientOption",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "c42c10c1-f0d9-4302-b5b9-468ab7b033e8"
},
{
"Name": "PreferBrand",
"Value": "0"
},
{
"Name": "EzOpen",
"Value": "1"
},
{
"Name": "DoNotText",
"Value": "0"
},
{
"Name": "DoNotEmail",
"Value": "1"
}
]
}
Success Response:
StatusCode: 200
{
"results": {},
"metadata": []
}
Method Name - UpdatePatientOption
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdatePatientOption This method will upate patient option information. It is strongly recommended that you use the method GetPatient, prior to update, in order to insure that you have the latest information for your update. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| AdherenceDoNotPhone | Int32 | 0 or 1, default is 0. | No |
| CallWhenReady | Int32 | 0 or 1, default is 0. | No |
| DoNotAllowScheduledDrugs | Int32 | 0 or 1, default is 0. | No |
| DoNotEmail | Int32 | 0 or 1, default is 0. | No |
| DoNotFax | Int32 | 0 or 1, default is 0. | No |
| DoNotMail | Int32 | 0 or 1, default is 0. | No |
| DoNotPhone | Int32 | 0 or 1, default is 0. | No |
| DoNotText | Int32 | 0 or 1, default is 0. | No |
| EzOpen | Int32 | 0 or 1, default is 0. | No |
| GoGreenEnrolledOn | DateTime | No | |
| HearingImpaired | Int32 | 0 or 1, default is 0. | No |
| IgnoreACEIARB | Int32 | 0 or 1, default is 0. | No |
| IgnoreHRM | Int32 | 0 or 1, default is 0. | No |
| MultiDose | Int32 | 0 or 1, default is 0. | No |
| NoCheckPayment | Int32 | 0 or 1, default is 0. | No |
| PreferBrand | Int32 | 0 or 1, default is 0. | No |
| PrintPatientEducationTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 34, found under Read, Other. | No |
| RestrictCashOnlyPHI | Int32 | 0 or 1, default is 0. | No |
| UnitDose | Int32 | 0 or 1, default is 0. | No |
| VisuallyImpaired | Int32 | 0 or 1, default is 0. | No |
| WeeklyPlanner | Int32 | 0 or 1, default is 0. | No |
Update Patient Pay Method
Example Request Body:
{
"MethodName": "UpdatePatientPayMethod",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098"
},
{
"Name": "PatientPayMethodID",
"Value": "aba5a53f-eabf-4d4e-b71e-532ae86a89d7"
},
{
"Name": "StartDate",
"Value": "1/27/2021"
},
{
"Name": "ExpirationDate",
"Value": "12/25/2021"
}
]
}
Success Response:
StatusCode: 200
{
"results": {},
"metadata": []
}
Method Name - UpdatePatientPayMethod
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdatePatientPayMethod This method will update patient pay method with desired values. It is strongly recommended that you use the method GetPatientPayMethod, prior to update, in order to insure that you have the latest information for your update. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PatientPayMethodID | Guid | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| CardHolderID | String(50) | No | |
| CardHolderPersonID | Guid | Valid PersonId. Only needed if the card holder is not the patient. | No |
| DisplayName | String(100) | No | |
| EligibilityClarificationTypeID | Int32 | Defaults to 0 - Not Specified Valid values can be found using the method LookUpListDetailGet, LookUpListID = 26, found under Read, Other. | No |
| ExpirationDate | DateTime | No | |
| GroupNumber | String(50) | No | |
| PatientLocationTypeID | Int32 | Defaults to 0 - Not Specified Valid values can be found using the method LookUpListDetailGet, LookUpListID = 27, found under Read, Other. | No |
| PatientRelationshipTypeID | Int32 | Defaults to 0 - Not Specified Valid values can be found using the method LookUpListDetailGet, LookUpListID = 28, found under Read, Other. | No |
| Pcn | String(50) | No | |
| PlaceOfResidenceTypeID | Int32 | Defaults to 0 - Not Specified Valid values can be found using the method LookUpListDetailGet, LookUpListID = 29, found under Read, Other. | No |
| PlaceOfServiceTypeID | Int32 | Defaults to 1 - Pharmacy Valid values can be found using the method LookUpListDetailGet, LookUpListID = 30, found under Read, Other. | No |
| RelationCode | String(10) | No | |
| StartDate | DateTime | Defaults to current date if not passed. | No |
Update Patient Pay Method Comment
Example Request Body:
{
"MethodName": "UpdatePatientPayMethodComment",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "ActionType",
"Value": "5025"
},
{
"Name": "InformationalComment",
"Value": "text value"
},
{
"Name": "PatientPayMethodID",
"Value": "b394320e-dcf8-44a5-ad11-908990dfa368"
},
{
"Name": "RequestedByEmployeeID",
"Value": "6920"
}
]
}
Method Name - UpdatePatientPayMethodComment
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| ActionType | Int32 | Yes | |
| InformationalComment | String | Yes | |
| PatientPayMethodID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes |
Update Patient Phone
Example Request Body:
{
"MethodName": "UpdatePatientPhone",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "PersonID",
"Value": "85aacf98-b600-40eb-acb7-800662b3ee6c"
},
{
"Name": "PhoneID",
"Value": "f291e334-f54a-40d1-b474-937bc083c8e5"
},
{
"Name": "PhoneNumber",
"Value": "text value"
},
{
"Name": "PhoneTypeID",
"Value": "9ddd9722-c702-4436-8064-b3ae17026801"
},
{
"Name": "RequestedByEmployeeID",
"Value": "9376"
}
]
}
Method Name - UpdatePatientPhone
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| PhoneID | Guid | Yes | |
| PhoneNumber | String(15) | Yes | |
| PhoneTypeID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes | |
| DialString | String(50) | No | |
| Extension | String(8) | No | |
| SetPrimaryPhone | Boolean | No | |
| SetSmsPhone | Boolean | No |
Update Patient Primary Category
Example Request Body:
{
"MethodName": "UpdatePatientPrimaryCategory",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "CategoryID",
"Value": "f47557ef-3d3d-4c38-a3c4-a1428ea7eb6d"
},
{
"Name": "PersonID",
"Value": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - UpdatePatientPrimaryCategory
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdatePatientPatientCategory This method will make the desired category the patient primary category. It is strongly recommended that you use the method GetPatient, prior to update, in order to insure that you have the latest information for your update. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| CategoryID | Guid | A list of categories a patient is current in can be found using the method GetPatientCategory, found under Read, Patient. | Yes |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
Update Patient Priority
Example Request Body:
{
"MethodName": "UpdatePatientPriority",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "c4e9338f-7e2d-44a7-9f90-67e9a7a7eaeb"
},
{
"Name": "DefaultPriorityTypeID",
"Value": "3"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - UpdatePatientPriority
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdatePatientPriority This method will update the patient defaul priority to the specific priority. It is strongly recommended that you use the method GetPatient, prior to update, in order to insure that you have the latest information for your update. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| DefaultPriorityTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 1, found under Read, Other. | No |
Update Patient Priority Todays
Example Request Body:
{
"MethodName": "UpdatePatientPriorityTodays",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "D38665FB-51AE-43AC-838C-B55E12ABDC13"
},
{
"Name": "TodaysPriorityTypeID",
"Value": "3"
},
{
"Name": "TodaysPriorityDateTime",
"Value": "2021-10-16 10:00"
},
{
"Name": "TodaysPriorityFillComment",
"Value": "Leave behind the big bush."
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - UpdatePatientPriorityTodays
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdatePatientPriorityTodays This method will update the patient defaul priority to the specific priority. It is strongly recommended that you use the method GetPatient, prior to update, in order to insure that you have the latest information for your update. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| TodaysPriorityDateTime | DateTime | AKA Promise Date Time Example values: "9/12/2021 10:00" | Yes |
| TodaysPriorityTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 1, found under Read, Other. | Yes |
| TodaysPriorityFillComment | AnsiString | No |
Update Patient Status Type
Example Request Body:
{
"MethodName": "UpdatePatientStatusType",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "460e97fc-1d4e-4e04-91b1-0dc6ca77f098"
},
{
"Name": "StatusTypePatientID",
"Value": "72d26425-0773-4fe7-b0d9-8356415041b0"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - UpdatePatientStatusType
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdatePatientStatusType This method will update the patient status to the specific status passed. The example body shows how to set a patient to Inactive. It is strongly recommended that you use the method GetPatient, prior to update, in order to insure that you have the latest information for your update. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| StatusTypePatientID | Guid | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 4, found under Read, Other. | Yes |
Employee
Add Employee Address
Example Request Body:
{
"MethodName": "AddEmployeeAddress",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "Address",
"Value": "text value"
},
{
"Name": "AddressTypeID",
"Value": "97ba4831-5e35-40b3-86ec-87aeafc3a31b"
},
{
"Name": "City",
"Value": "text value"
},
{
"Name": "PersonID",
"Value": "efc51afe-9e6e-4195-ae7f-cac619926e6d"
},
{
"Name": "RequestedByEmployeeID",
"Value": "7668"
},
{
"Name": "ZipCode",
"Value": "text value"
}
]
}
Method Name - AddEmployeeAddress
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| Address | String(200) | Yes | |
| AddressTypeID | Guid | Yes | |
| City | String(40) | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes | |
| ZipCode | String(15) | Yes | |
| AddressID | Guid | No | |
| Country | String(50) | No | |
| SetDeliveryAddress | Boolean | No | |
| SetMailingAddress | Boolean | No | |
| SetPrimaryAddress | Boolean | No | |
| StateCode | String(2) | No | |
| StateName | String(40) | No |
Add Employee Category
Example Request Body:
{
"MethodName": "AddEmployeeCategory",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "CategoryID",
"Value": "4daf3e5b-9d8d-4779-868e-1e1cf6ef2a2c"
},
{
"Name": "PersonID",
"Value": "a79cbc25-be23-4e59-b3a3-86add172aace"
},
{
"Name": "RequestedByEmployeeID",
"Value": "862"
}
]
}
Method Name - AddEmployeeCategory
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| CategoryID | Guid | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes |
Add Employee Phone
Example Request Body:
{
"MethodName": "AddEmployeePhone",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "PersonID",
"Value": "1bb08ace-0103-4976-80ad-6e1d2064b8a2"
},
{
"Name": "PhoneNumber",
"Value": "text value"
},
{
"Name": "PhoneTypeID",
"Value": "5daf2630-f68f-47fd-9b51-f60ff22dcc70"
},
{
"Name": "RequestedByEmployeeID",
"Value": "8549"
}
]
}
Method Name - AddEmployeePhone
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| PhoneNumber | String(15) | Yes | |
| PhoneTypeID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes | |
| DialString | String(50) | No | |
| Extension | String(8) | No | |
| PhoneID | Guid | No | |
| SetPrimaryPhone | Boolean | No |
Delete Employee Address
Example Request Body:
{
"MethodName": "DeleteEmployeeAddress",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "AddressID",
"Value": "a6a66cda-074a-460f-a27e-0e12d1d708c8"
},
{
"Name": "PersonID",
"Value": "91afef96-8b81-4557-ac37-ee873943cd08"
},
{
"Name": "RequestedByEmployeeID",
"Value": "3612"
}
]
}
Method Name - DeleteEmployeeAddress
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| AddressID | Guid | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes |
Delete Employee Category
Example Request Body:
{
"MethodName": "DeleteEmployeeCategory",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "CategoryID",
"Value": "37086025-15eb-4b6d-9fbe-39abe1b0fd92"
},
{
"Name": "PersonID",
"Value": "b7c02222-eca7-4169-a5e8-974cc983e7e1"
},
{
"Name": "RequestedByEmployeeID",
"Value": "481"
}
]
}
Method Name - DeleteEmployeeCategory
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| CategoryID | Guid | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes |
Delete Employee Phone
Example Request Body:
{
"MethodName": "DeleteEmployeePhone",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "PersonID",
"Value": "93058de9-18f8-4bfd-be54-9bd14c074aad"
},
{
"Name": "PhoneID",
"Value": "b877cf38-e032-46f8-8629-164b5fbc6152"
},
{
"Name": "RequestedByEmployeeID",
"Value": "4517"
}
]
}
Method Name - DeleteEmployeePhone
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| PhoneID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes |
Set Employee Delivery Address
Example Request Body:
{
"MethodName": "SetEmployeeDeliveryAddress",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "AddressID",
"Value": "ce67e12b-06d8-4a89-814d-724a19a6fe1d"
},
{
"Name": "PersonID",
"Value": "cacbd697-c912-4041-be0f-e67310c232df"
},
{
"Name": "RequestedByEmployeeID",
"Value": "6027"
}
]
}
Method Name - SetEmployeeDeliveryAddress
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| AddressID | Guid | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | Yes |
Set Employee Mailing Address
Example Request Body:
{
"MethodName": "SetEmployeeMailingAddress",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "AddressID",
"Value": "6ec9df6b-e450-429d-bd15-92b070b50948"
},
{
"Name": "PersonID",
"Value": "525aaaf3-d32f-428a-83fa-2ea7390496a3"
},
{
"Name": "RequestedByEmployeeID",
"Value": "7655"
}
]
}
Method Name - SetEmployeeMailingAddress
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| AddressID | Guid | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | Yes |
Set Employee Primary Address
Example Request Body:
{
"MethodName": "SetEmployeePrimaryAddress",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "AddressID",
"Value": "2dcff983-a42a-4382-8723-ef25d545c7ef"
},
{
"Name": "PersonID",
"Value": "642af66c-982c-4a7a-b10d-ca416958e86f"
},
{
"Name": "RequestedByEmployeeID",
"Value": "3031"
}
]
}
Method Name - SetEmployeePrimaryAddress
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| AddressID | Guid | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | Yes |
Set Employee Primary Phone
Example Request Body:
{
"MethodName": "SetEmployeePrimaryPhone",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "PersonID",
"Value": "05d5f613-5c95-48d4-ae4d-d335c6cffbb5"
},
{
"Name": "PhoneID",
"Value": "a6052744-fa2a-4513-b450-e605f843c39b"
},
{
"Name": "RequestedByEmployeeID",
"Value": "2487"
}
]
}
Method Name - SetEmployeePrimaryPhone
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| PhoneID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | Yes |
Update Employee Address
Example Request Body:
{
"MethodName": "UpdateEmployeeAddress",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "Address",
"Value": "text value"
},
{
"Name": "AddressID",
"Value": "4d5209df-4d55-4bef-a1f3-035f4c1ea974"
},
{
"Name": "AddressTypeID",
"Value": "e7774527-df3e-4cfe-9699-d8411c2f8c8b"
},
{
"Name": "City",
"Value": "text value"
},
{
"Name": "PersonID",
"Value": "18b1a19b-5456-41df-b14f-aa24f027719e"
},
{
"Name": "RequestedByEmployeeID",
"Value": "8432"
},
{
"Name": "ZipCode",
"Value": "text value"
}
]
}
Method Name - UpdateEmployeeAddress
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| Address | String(200) | Yes | |
| AddressID | Guid | Yes | |
| AddressTypeID | Guid | Yes | |
| City | String(40) | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes | |
| ZipCode | String(15) | Yes | |
| Country | String(50) | No | |
| SetDeliveryAddress | Boolean | No | |
| SetMailingAddress | Boolean | No | |
| SetPrimaryAddress | Boolean | No | |
| StateCode | String(2) | No | |
| StateName | String(40) | No |
Update Employee Phone
Example Request Body:
{
"MethodName": "UpdateEmployeePhone",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "PersonID",
"Value": "c2622e17-0fb8-4cb4-a74a-4cb547c009c0"
},
{
"Name": "PhoneID",
"Value": "8c09e132-f187-4042-a533-1ba3ec5c40ff"
},
{
"Name": "PhoneNumber",
"Value": "text value"
},
{
"Name": "PhoneTypeID",
"Value": "df78cc9b-bccd-40bc-9a53-e9680856ff09"
},
{
"Name": "RequestedByEmployeeID",
"Value": "2799"
}
]
}
Method Name - UpdateEmployeePhone
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| PhoneID | Guid | Yes | |
| PhoneNumber | String(15) | Yes | |
| PhoneTypeID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes | |
| DialString | String(50) | No | |
| Extension | String(8) | No | |
| SetPrimaryPhone | Boolean | No |
Prescriber
Add Prescriber Address
Example Request Body:
{
"MethodName": "AddPrescriberAddress",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "Address",
"Value": "text value"
},
{
"Name": "AddressTypeID",
"Value": "cb7d6527-a302-418b-86f1-c1fa161de465"
},
{
"Name": "City",
"Value": "text value"
},
{
"Name": "PersonID",
"Value": "a9f10e55-0778-4768-a370-28350d80515b"
},
{
"Name": "RequestedByEmployeeID",
"Value": "8328"
},
{
"Name": "ZipCode",
"Value": "text value"
}
]
}
Method Name - AddPrescriberAddress
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| Address | String(200) | Yes | |
| AddressTypeID | Guid | Yes | |
| City | String(40) | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes | |
| ZipCode | String(15) | Yes | |
| AddressID | Guid | No | |
| Country | String(50) | No | |
| SetDeliveryAddress | Boolean | No | |
| SetMailingAddress | Boolean | No | |
| SetPrimaryAddress | Boolean | No | |
| StateCode | String(2) | No | |
| StateName | String(40) | No |
Add Prescriber Category
Example Request Body:
{
"MethodName": "AddPrescriberCategory",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "CategoryID",
"Value": "1b959f80-f91d-48f8-b7ca-975ac5e0a550"
},
{
"Name": "PersonID",
"Value": "3d2418aa-78f2-4ccf-b8a8-3c844f9054a6"
},
{
"Name": "RequestedByEmployeeID",
"Value": "3918"
}
]
}
Method Name - AddPrescriberCategory
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| CategoryID | Guid | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes | |
| IsPrimaryCategory | Int32 | No |
Add Prescriber Phone
Example Request Body:
{
"MethodName": "AddPrescriberPhone",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "PersonID",
"Value": "846dbf9c-72aa-4d6e-8cee-f03fb40d546e"
},
{
"Name": "PhoneNumber",
"Value": "text value"
},
{
"Name": "PhoneTypeID",
"Value": "9c3038c7-cc52-4b89-8e60-8a999d6bafd2"
},
{
"Name": "RequestedByEmployeeID",
"Value": "4417"
}
]
}
Method Name - AddPrescriberPhone
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| PhoneNumber | String(15) | Yes | |
| PhoneTypeID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes | |
| DialString | String(50) | No | |
| Extension | String(8) | No | |
| PhoneID | Guid | No | |
| SetPrimaryFax | Boolean | No | |
| SetPrimaryPhone | Boolean | No |
Delete Prescriber Address
Example Request Body:
{
"MethodName": "DeletePrescriberAddress",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "AddressID",
"Value": "6c53443c-0f23-4e08-8ff4-f53f13ab01cb"
},
{
"Name": "PersonID",
"Value": "4d52a6b4-0842-4075-9f31-11ea1cebbf4c"
},
{
"Name": "RequestedByEmployeeID",
"Value": "1178"
}
]
}
Method Name - DeletePrescriberAddress
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| AddressID | Guid | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes |
Delete Prescriber Category
Example Request Body:
{
"MethodName": "DeletePrescriberCategory",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "CategoryID",
"Value": "b5a01ce5-19d6-40f1-8930-5b2a4a74c33a"
},
{
"Name": "PersonID",
"Value": "dbfdff54-af98-4b93-8e7f-6a48bd97c193"
},
{
"Name": "RequestedByEmployeeID",
"Value": "1033"
}
]
}
Method Name - DeletePrescriberCategory
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| CategoryID | Guid | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes |
Delete Prescriber Phone
Example Request Body:
{
"MethodName": "DeletePrescriberPhone",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "PersonID",
"Value": "ea7ad8e7-66ac-4683-b124-89984aabd12b"
},
{
"Name": "PhoneID",
"Value": "49d63909-0fee-4971-8f2e-d74f7db7f28e"
},
{
"Name": "RequestedByEmployeeID",
"Value": "1485"
}
]
}
Method Name - DeletePrescriberPhone
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| PhoneID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes |
Prescriber Add
Example Request Body:
{
"MethodName": "PrescriberAdd",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "PWELL"
},
{
"Name": "LastName",
"Value": "Walker"
},
{
"Name": "FirstName",
"Value": "Johnny"
},
{
"Name": "PrescriberTypeID",
"Value": "d139410d-1df9-4f25-afff-f6f35f4e4c30"
},
{
"Name": "PrimaryAddress",
"Value": "123 Mocking Bird Lane"
},
{
"Name": "PrimaryCity",
"Value": "Shreveport"
},
{
"Name": "PrimaryStateCode",
"Value": "LA"
},
{
"Name": "PrimaryZipCode",
"Value": "71115"
},
{
"Name": "PrimaryPhoneNumber",
"Value": "9998887777"
},
{
"Name": "PrimaryFaxPhoneNumber",
"Value": "0001112222"
},
{
"Name": "DEA",
"Value": "XX123456"
},
{
"Name": "NPI",
"Value": "1111111111"
},
{
"Name": "SureScriptSPI",
"Value": "2222222222001"
},
{
"Name": "InformationComment",
"Value": "Likes Wiskey"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"personID": [
{
"personID": "53c73271-85ae-41ad-b2b8-7062dea00850"
}
]
},
"metadata": []
}
Method Name - PrescriberAdd
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - PrescriberAdd Besides the parameters that are required, PersonID is a parameter that may be also used if you would like to tell the API what guid you would like to use for the prescriber. If PersonID is not passed in, then the system generated guid will be returned in the result set. This API does not check for duplicate prescribers, it is up to you to make sure the prescriber you are adding, is not already in the system.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| FirstName | AnsiString(50) | Yes | |
| LastName | AnsiString(50) | Yes | |
| PrescriberTypeID | Guid | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 58, found under Read, Other. | Yes |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| AlternateID | AnsiString(50) | No | |
| CriticalComment | AnsiString | No | |
| DEA | AnsiString(9) | No | |
| DEASuffix | AnsiString(10) | No | |
| DoNotEmail | Int32 | 0 or 1, default is 0. | No |
| DoNotFax | Int32 | 0 or 1, default is 0. | No |
| DoNotPhone | Int32 | 0 or 1, default is 0. | No |
| DPS | AnsiString(20) | No | |
| EmailAddress | AnsiString(255) | No | |
| ExternalID | AnsiString(50) | No | |
| HiddenComment | AnsiString | No | |
| InformationComment | AnsiString | No | |
| MarketerID | Guid | No | |
| MedicaidLicense | AnsiString(20) | No | |
| MiddleName | AnsiString(30) | No | |
| NPI | AnsiString(15) | No | |
| PersonID | Guid | If not provided, a guid will be generated by the system and returned in the results. | No |
| PrescriberGroup | AnsiString(20) | No | |
| PrescribesForID | Guid | No | |
| PrimaryAddress | AnsiString(200) | No | |
| PrimaryCity | AnsiString(40) | No | |
| PrimaryCountry | String(100) | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 6, found under Read, Other. | No |
| PrimaryExtension | AnsiString(8) | No | |
| PrimaryFaxExtension | AnsiString(8) | No | |
| PrimaryFaxPhoneNumber | AnsiString(15) | No | |
| PrimaryPhoneNumber | AnsiString(15) | No | |
| PrimaryPhoneTypeID | Guid | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 2, found under Read, Other. | No |
| PrimaryStateCode | AnsiStringFixedLength(2) | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 5, found under Read, Other. | No |
| PrimaryStateName | AnsiString(50) | No | |
| PrimaryZipCode | AnsiString(15) | No | |
| PrintName | AnsiString(50) | No | |
| RenewMethodTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 59, found under Read, Other. | No |
| SaleComment | AnsiString | No | |
| Salutation | AnsiString(10) | No | |
| StateLicense | AnsiString(20) | No | |
| SubmitRenewalRequestDaysBeforeSupplyEnds | Int32 | No | |
| SuboxoneDEA | AnsiString(9) | No | |
| SuboxoneDEASuffix | AnsiString(10) | No | |
| Suffix | AnsiString(10) | No | |
| SureScriptSPI | AnsiString(50) | No | |
| UPIN | AnsiString(10) | No | |
| WebSiteAddress | AnsiString(255) | No |
Set Prescriber Delivery Address
Example Request Body:
{
"MethodName": "SetPrescriberDeliveryAddress",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "AddressID",
"Value": "186654f7-21a8-45c3-b64f-0bc85ca868d4"
},
{
"Name": "PersonID",
"Value": "a1448f68-5408-4355-a74d-b11eb62b3522"
},
{
"Name": "RequestedByEmployeeID",
"Value": "2800"
}
]
}
Method Name - SetPrescriberDeliveryAddress
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| AddressID | Guid | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | Yes |
Set Prescriber Mailing Address
Example Request Body:
{
"MethodName": "SetPrescriberMailingAddress",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "AddressID",
"Value": "43a23deb-fa5e-4903-ab4b-484267f4a8c0"
},
{
"Name": "PersonID",
"Value": "1b21f07c-be46-49a5-8717-6b133ef75312"
},
{
"Name": "RequestedByEmployeeID",
"Value": "6008"
}
]
}
Method Name - SetPrescriberMailingAddress
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| AddressID | Guid | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | Yes |
Set Prescriber Primary Address
Example Request Body:
{
"MethodName": "SetPrescriberPrimaryAddress",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "AddressID",
"Value": "6122ae08-4d72-4fe6-8427-da94298a31f8"
},
{
"Name": "PersonID",
"Value": "748e7cce-59fd-472b-9240-2b8f81605278"
},
{
"Name": "RequestedByEmployeeID",
"Value": "1879"
}
]
}
Method Name - SetPrescriberPrimaryAddress
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| AddressID | Guid | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | Yes |
Set Prescriber Primary Fax
Example Request Body:
{
"MethodName": "SetPrescriberPrimaryFax",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "PersonID",
"Value": "c879c353-3726-4d00-b24d-bd537c18c12a"
},
{
"Name": "PhoneID",
"Value": "47f7f08a-a35c-4473-8e49-92245cee00b6"
},
{
"Name": "RequestedByEmployeeID",
"Value": "5064"
}
]
}
Method Name - SetPrescriberPrimaryFax
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| PhoneID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | Yes |
Set Prescriber Primary Phone
Example Request Body:
{
"MethodName": "SetPrescriberPrimaryPhone",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "PersonID",
"Value": "a602f168-c35f-46e4-9132-6ace919dcf9a"
},
{
"Name": "PhoneID",
"Value": "8b28dfcb-4a27-4ea6-9af1-4bea0ab2525d"
},
{
"Name": "RequestedByEmployeeID",
"Value": "4312"
}
]
}
Method Name - SetPrescriberPrimaryPhone
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| PhoneID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | Yes |
Update Prescriber Address
Example Request Body:
{
"MethodName": "UpdatePrescriberAddress",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "Address",
"Value": "text value"
},
{
"Name": "AddressID",
"Value": "4cdb0313-a5b2-4a65-9067-d4de6098e4da"
},
{
"Name": "AddressTypeID",
"Value": "23a14062-bce0-4147-a54d-ababd105c049"
},
{
"Name": "City",
"Value": "text value"
},
{
"Name": "PersonID",
"Value": "c002ed73-df9b-4b26-8525-a2cd5382d35d"
},
{
"Name": "RequestedByEmployeeID",
"Value": "3838"
},
{
"Name": "ZipCode",
"Value": "text value"
}
]
}
Method Name - UpdatePrescriberAddress
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| Address | String(200) | Yes | |
| AddressID | Guid | Yes | |
| AddressTypeID | Guid | Yes | |
| City | String(40) | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes | |
| ZipCode | String(15) | Yes | |
| Country | String(50) | No | |
| SetDeliveryAddress | Boolean | No | |
| SetMailingAddress | Boolean | No | |
| SetPrimaryAddress | Boolean | No | |
| StateCode | String(2) | No | |
| StateName | String(40) | No |
Update Prescriber Phone
Example Request Body:
{
"MethodName": "UpdatePrescriberPhone",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "PersonID",
"Value": "b4290902-f177-4d86-93af-71cea54f44a0"
},
{
"Name": "PhoneID",
"Value": "cff92a94-7b0a-423a-a8ef-5f397ff0bbab"
},
{
"Name": "PhoneNumber",
"Value": "text value"
},
{
"Name": "PhoneTypeID",
"Value": "934f1732-750c-4691-8307-592e9eb4b66c"
},
{
"Name": "RequestedByEmployeeID",
"Value": "5712"
}
]
}
Method Name - UpdatePrescriberPhone
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PersonID | Guid | Yes | |
| PhoneID | Guid | Yes | |
| PhoneNumber | String(15) | Yes | |
| PhoneTypeID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes | |
| DialString | String(50) | No | |
| Extension | String(8) | No | |
| SetPrimaryFax | Boolean | No | |
| SetPrimaryPhone | Boolean | No |
Update Prescriber Primary Category
Example Request Body:
{
"MethodName": "UpdatePrescriberPrimaryCategory",
"Version": "1.0",
"ParameterCollection": [
{
"Name": "CategoryID",
"Value": "3de943d6-c852-445d-955f-6a745e7d3ee8"
},
{
"Name": "PersonID",
"Value": "15a608a5-da5b-4988-ae20-b7826f63657d"
},
{
"Name": "RequestedByEmployeeID",
"Value": "4316"
}
]
}
Method Name - UpdatePrescriberPrimaryCategory
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
| Field Name | Type | Notes | Required |
|---|---|---|---|
| CategoryID | Guid | Yes | |
| PersonID | Guid | Yes | |
| RequestedByEmployeeID | String(20) | Yes |
RX
Request Refill
Example Request Body:
{
"MethodName": "RequestRefill",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "RxNumber",
"Value": "7515985"
},
{
"Name": "FillRequestMethodTypeID",
"Value": "5"
},
{
"Name": "FillRequestedPriorityTypeID",
"Value": "2"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - RequestRefill
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - RequestRefill Besides the other required parameters, at least RxNumber or RxID is required for this method. Passing in the RxNumber is the most common way used for this method.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| FillRequestedPriorityTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 1, found under Read, Other. The most commonly used value is a 2, meaning the patient will be returning. | Yes |
| FillRequestMethodTypeID | Int32 | 5=IVR 9=Batch 11=Unknown 15=App | Yes |
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| CallOn | DateTime | Date/Time in which the request was made. Defaults to current date/time. | No |
| FillRequestedComment | String(500) | No | |
| PickupRequestedOn | DateTime | Date/Time in which pickup is requested. This is sometimes referred to as the promise date/time. | No |
| RxID | Guid | If RxNumber is not used, then you must pass in RxID. | No |
| RxNumber | Int32 | Most commly used to request a refill. | No |
| StoreNumber | String(15) | No |
Rx Comment Update
Example Request Body:
{
"MethodName": "RxCommentUpdate",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "RxID",
"Value": "401D4216-A706-43FD-8A45-65CB5ADDCDED"
},
{
"Name": "ActionType",
"Value": "2"
},
{
"Name": "CommentText",
"Value": "{\rtf1\ansi}\par
Sale Line 1\par
Sale Line 2\par
Sale Line 3\par
Sale last line\par
}"
},
{
"Name": "CommentTypeID",
"Value": "1"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - RxCommentUpdate
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - RxUpdateComment This method will add/replace, append or wipe out the specific comment on a RxTransaction, aka Fill. The example shows appending the 4 lines of rtf formatted text to the existing comment. You do not have to use RTF formatted text.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| ActionType | Int32 | 1 Add/Replace 2 Append Text to existing RTF comment 3 WipeOut | Yes |
| CommentTypeID | Int32 | 1 Critical 2 Informational 3 Hidden 4 Sale | Yes |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| RxID | Guid | Yes | |
| CommentText | AnsiString | No |
Rx Document Add
Example Request Body:
{
"MethodName": "RxDocumentAdd",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "RxID",
"Value": "CB32799A-EAE6-4131-8458-D79892050FF1"
},
{
"Name": "DocumentImage",
"Value": "Your Base64 Image string goes here"
},
{
"Name": "DocumentImageTypeID",
"Value": "f6a5fc8e-086e-4cf8-b355-cd9900f0c827"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"document": [
{
"documentID": "aa1f2e7d-99cb-4fbd-9a5d-64783fb2f44a"
}
]
},
"metadata": []
}
Method Name - RxDocumentAdd
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - RxDocumentAdd This method will add a document to a Rx.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| DocumentImage | AnsiString | This must be a valid base64 encoded string. The example body you see is just an example and not a valid value.
This will be a PDF,JPG,PNG,TIF,BMP document. We run it through a simple tool to validate it is a valid base64 encoded string. A good website for reference is:https://base64.guru/converter/encode or https://base64.guru/converter/decode or use this one for pdf, https://base64.guru/converter/decode/pdf | Yes |
| DocumentImageTypeID | Guid | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 53, found under Read, Other. | Yes |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| RxID | Guid | Yes | |
| Description | AnsiString(100) | No | |
| DocumentFileName | AnsiString(1000) | This is just a reference to the file name that may have been used for this image. | No |
| DocumentID | Guid | If one is not passsed in, one will be created for you and passed back in the results. | No |
| DocumentName | AnsiString(100) | If not passed in, the value will be loaded from the LookUpListID = 53, DocumentImageTypeText. | No |
Rx Intake Add
Example Request Body:
{
"MethodName": "RxIntakeAdd",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "2005"
},
{
"Name": "PatientID",
"Value": "3f4f3284-e9a5-4210-ac92-195cc656576c"
},
{
"Name": "ScriptImage",
"Value": "YourBase64ImageStringGoesHere=="
},
{
"Name": "WrittenByID",
"Value": "489B90E8-BD23-4BF5-838B-003F0486C5A2"
},
{
"Name": "DateWritten",
"Value": "3/10/2024"
},
{
"Name": "OriginTypeID",
"Value": "2"
},
{
"Name": "MedicationNDC",
"Value": "30698006001"
},
{
"Name": "Quantity",
"Value": "30"
},
{
"Name": "QuantityTypeID",
"Value": "1"
},
{
"Name": "NumberOfRefillsAllowed",
"Value": "5"
},
{
"Name": "Directions",
"Value": "T1T QD"
},
{
"Name": "Icd10CodePrimary",
"Value": "D70.1"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"rxID": [{
"rxID": "9788ab94-0a48-4be4-8aaa-205f6a081399"
}]
}
, "metadata": []
}
Method Name - RxIntakeAdd
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - RxIntakeAdd This method will creates an Rx(aka what the prescriber has written), and it will show up in the Fill Request Queue as an Intake. It will return the RxID that it inserted in to the database. It does not create a rxtransaction(aka fill). This API method will mimic what happens in the UI when keying in the prescriber written protion of the script.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PatientID | Guid | Must be a valid PatientID and already exist. Can use SearchPatient lookup. | Yes |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| ScriptImage | AnsiString | This must be a valid base64 encoded string. The example body you see is just an example and not a valid value.
This will be a PDF,JPG,PNG,TIF,BMP document. We run it through a simple tool to validate it is a valid base64 encoded string. A good website for reference is:https://base64.guru/converter/encode or https://base64.guru/converter/decode or use this one for pdf, https://base64.guru/converter/decode/pdf | Yes |
| Acute | Int32 | 0-False or 1-True, default is 0. | No |
| AutoRefill | Int32 | 0-False or 1-True, default is 0. | No |
| AvailableForFillDate | DateTime | No | |
| CdtCode | AnsiString(10) | No | |
| CriticalComment | AnsiString | No | |
| CycleFill | Int32 | 0-False or 1-True, default is 0. aka "This is a MedSync Rx". | No |
| DateWritten | Date | No | |
| DiagnosisDiseaseID | Int32 | Must be valid FDB FMLDiseaseID. | No |
| DiagnosisICD9Code | AnsiString(20) | Must be valid ICD9 Code. | No |
| Directions | String | If is highly recommended that you your pharmacies common sig codes here so that the Days Supply will be computed for you. If you are going to free text and do not want this to be interpreted in any way, you should inclose the directions in [] just like they would do in the UI. | No |
| DispenseAsWritten | Int32 | 0-False or 1-True, default is 0. | No |
| EndDate | DateTime | No | |
| ExpirationDate | DateTime | No | |
| ForPain | Int32 | 0-False or 1-True, default is 0. | No |
| HiddenComment | AnsiString | No | |
| Icd10CodePrimary | AnsiString(50) | Must be a valid Icd10 Code. | No |
| Icd10CodeSecondary | AnsiString(50) | Must be a valid Icd10 Code. | No |
| Icd10CodeTertiary | AnsiString(50) | Must be a valid Icd10 Code. | No |
| InformationalComment | AnsiString | No | |
| IsPrn | Int32 | No | |
| MedicationID | Int32 | Must be a valid FDB MedicatonID. | No |
| MedicationNDC | AnsiString(11) | Must be a valid NDC in your Item file. Can use ItemSearch for lookup. Must commonly, be a valid NDC that is known by FDB. | No |
| NumberOfRefillsAllowed | Int32 | Number of Refills Prescribed. | No |
| OriginTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 55, found under Read, Other. | No |
| PmpTreatmentTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 57, found under Read, Other. | No |
| PrescribedItemID | Guid | Must be a valid ItemID and already exist. Can use ItemSearch for lookup. | No |
| PrescriberOrderNumber | String(100) | No | |
| PrintImageHardcopyWithRxLabel | Int32 | 0-False or 1-True, default is 0. | No |
| Quantity | Decimal | Prescribed Quantity. | No |
| QuantityTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 56, found under Read, Other. | No |
| RenewedFromRxID | Guid | This must be a valid RxID and already exist. It would be the RxID that this new RxID will be renewed from. This maintains the chain of renewas for an Rx. | No |
| RxID | Guid | If one is not passsed in, one will be created for you and passed back in the results. | No |
| SaleComment | AnsiString | No | |
| StartDate | DateTime | No | |
| SupervisorID | Guid | This is the surpervising prescriber, if needed. Must by a valid PrescriberID and already exsist. Can use PrescriberSearch for lookup. | No |
| TriplicateNumber | AnsiString(200) | No | |
| WrittenByID | Guid | Must by a valid PrescriberID and already exsist. Can use PrescriberSearch for lookup. | No |
Rx Transaction Comment Update
Example Request Body:
{
"MethodName": "RxTransactionCommentUpdate",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "RxTransactionID",
"Value": "401D4216-A706-43FD-8A45-65CB5ADDCDED"
},
{
"Name": "ActionType",
"Value": "2"
},
{
"Name": "CommentText",
"Value": "{\rtf1\ansi}\par
Sale Line 1\par
Sale Line 2\par
Sale Line 3\par
Sale last line\par
}"
},
{
"Name": "CommentTypeID",
"Value": "4"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - RxTransactionCommentUpdate
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - RxTransactionUpdateComment This method will add/replace, append or wipe out the specific comment on a RxTransaction, aka Fill. The example shows appending the 4 lines of rtf formatted text to the existing comment. You do not have to use RTF formatted text.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| ActionType | Int32 | 1 Add/Replace 2 Append Text to existing RTF comment 3 WipeOut | Yes |
| CommentTypeID | Int32 | 1 Critical 2 Informational 3 Hidden 4 Sale | Yes |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| RxTransactionID | Guid | Yes | |
| CommentText | AnsiString | No |
Rx Transaction Reverse Claims
Example Request Body:
{
"MethodName": "RxTransactionReverseClaims",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "ELOPEZ"
},
{
"Name": "WorkstationID",
"Value": "56398C56-F402-ED11-93EF-842B2B4A3DFF"
},
{
"Name": "RxTransactionID",
"Value": "CDF0C37D-F070-466A-BA51-4472401CF413"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - RxTransactionReverseClaims
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - RxTransactionReverseClaims This method will reverse all claims on the RxTransaction. There is no real way to use your testing credentials, to test this method with an rxtransaction(aka Fill) that has a paid claim on it. This is due to the fact that there is not a claim service setup to look at and process requested transmission that are in the testing area for APIs. This API will NOT change the RxTransaction Status(aka Fill). It only reverses the claims. *****NOTE****** This routine mimics the reverse of all claims on a transaciton in the UI, so if you are unsure about how this can work for you, please consult with Developer Support. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| RxTransactionID | Guid | Vailid RxTransactionID | Yes |
| WorkstationID | Guid | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 42, found under Read, Other. The workstationid will be used for the printing of labels, in the event you are cancelling the original rxtransaction(aka 0 fill), and your system settings call for a on hold label to print. Also this will be the workstationid that the claim aleart shows up on to reflect that there was an attempt for a reversal and the status of that attemp, accepted or rejected. | Yes |
Rx Update Set Deleted
Example Request Body:
{
"MethodName": "RxUpdateSetDeleted",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "RxID",
"Value": "064F6C4E-24F4-481C-819F-000807411548"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - RxUpdateSetDeleted
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - RxUpdateSetDeleted This method will delete an Rx. This method will mimic the UI. You can only delete an Rx when the status is OnHold, FillRequested(Escript/Intake).
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| RxID | Guid | Yes |
Rx Update Set Transfer In
Example Request Body:
{
"MethodName": "RxUpdateSetTransferIn",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "RxID",
"Value": "C7B52F99-A73C-4412-B79C-0005C10C0368"
},
{
"Name": "ExternalLocationID",
"Value": "0AE94F3C-2706-4E4F-BF4A-BBF7D02DB476"
},
{
"Name": "ExternalLocationPharmacistID",
"Value": "97DD2C6A-9813-4EEE-9FFA-4C603455AB27"
},
{
"Name": "PharmacistAcceptingTransferID",
"Value": "FF911A9A-1EB1-486E-86EF-B79E76A91A2B"
},
{
"Name": "OriginalRxNumber",
"Value": "1234567890"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - RxUpdateSetTransferIn
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - RxUpdateSetTransferIn This method will set an Rx to Transferred In. If already tranferred in, it will update the existing information.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| ExternalLocationID | Guid | You can use the ExternalLocationSearch method to find the location you desire. | Yes |
| ExternalLocationPharmacistID | Guid | You can use the ExternalLocationGet method to retrieve the information for the location and a list of their pharmacists. | Yes |
| PharmacistAcceptingTransferID | Guid | You can use the EmployeeSearch method to retrieve the list of your pharmacists, PersonIDs. | Yes |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| RxID | Guid | Yes | |
| Comment | AnsiString | No | |
| OriginalFirstFillDate | DateTime | No | |
| OriginalLastFillDate | DateTime | No | |
| OriginalNumberOfRefills | AnsiString(5) | No | |
| OriginalNumberOfRefillsRemaining | AnsiString(5) | No | |
| OriginalRxNumber | Int32 | No | |
| TransferDate | DateTime | No |
Rx Update Set Transfer Out
Example Request Body:
{
"MethodName": "RxUpdateSetTransferOut",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "RxID",
"Value": "064F6C4E-24F4-481C-819F-000807411548"
},
{
"Name": "ExternalLocationID",
"Value": "8A13A44C-7232-45CC-9FE0-0B9ED74BDF01"
},
{
"Name": "ExternalLocationPharmacistID",
"Value": "52090295-A113-4C1F-B2D6-82AFE94D0291"
},
{
"Name": "PharmacistSendingTransferID",
"Value": "0B144925-08DC-4501-9EDF-A136F0118219"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - RxUpdateSetTransferOut
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - RxUpdateSetTransferOut This method will set an Rx to Transferred Out. If already tranferred out, it will update the existing information.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| ExternalLocationID | Guid | You can use the ExternalLocationSearch method to find the location you desire. | Yes |
| ExternalLocationPharmacistID | Guid | You can use the ExternalLocationGet method to retrieve the information for the location and a list of their pharmacists. | Yes |
| PharmacistSendingTransferID | Guid | You can use the EmployeeSearch method to retrieve the list of your pharmacists, PersonIDs. | Yes |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| RxID | Guid | Yes | |
| Comment | AnsiString | No | |
| TransferDate | DateTime | No |
Update Rx Cycle Fill
Example Request Body:
{
"MethodName": "UpdateRxCycleFill",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "RxID",
"Value": "5ad360da-5bba-445a-b8fb-1934993557f9"
},
{
"Name": "CycleFill",
"Value": "1"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - UpdateRxCycleFill
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdateRxCycleFill This method will set the Cycle Fill on the Rx to 0-No, 1-Yes. It is strongly recommended that you use the method GetPatient, prior to update, in order to insure that you have the latest information for your update. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| CycleFill | Int32 | 0 or 1, default is 0. | Yes |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| RxID | Guid | Yes |
Update Rx Transaction Priority
Example Request Body:
{
"MethodName": "UpdateRxTransactionPriority",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "RxTransactionID",
"Value": "412ada2b-b815-411c-a5d9-648033db1fbd"
},
{
"Name": "PriorityTypeID",
"Value": "4"
},
{
"Name": "PromiseTime",
"Value": "3/25/2021 5:29:40 PM"
},
{
"Name": "Comment",
"Value": "Patient requested ship today."
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - UpdateRxTransactionPriority
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdateRxTransactionPriority This method will update the priority and promise time on a rxtransaction, commonly known as a fill. In the example body, the rxtransaction will be updated to the prioirty "Shipment". It is strongly recommended that you use the method GetRxTransaction, prior to update, in order to insure that you have the latest information for your update. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PriorityTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 1, found under Read, Other. | Yes |
| PromiseTime | DateTime | Yes | |
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| RxTransactionID | Guid | Yes | |
| Comment | String | This value will be inserted in the beginning of any Fill Critical Comment on the RxTransaction. | No |
Update Rx Transaction Purchase Order Number
Example Request Body:
{
"MethodName": "UpdateRxTransactionPurchaseOrderNumber",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "RxTransactionID",
"Value": "412ada2b-b815-411c-a5d9-648033db1fbd"
},
{
"Name": "PurchaseOrderNumber",
"Value": "BR549"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - UpdateRxTransactionPurchaseOrderNumber
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdateRxTransactionPurchaseOrderNumber This method will update the purchase order number on a rxtransaction, commonly known as a fill. It is strongly recommended that you use the method GetRxTransaction, prior to update, in order to insure that you have the latest information for your update. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | String(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| RxTransactionID | Guid | Yes | |
| PurchaseOrderNumber | String(20) | No |
Update Rx Transaction Set Cancelled
Example Request Body:
{
"MethodName": "UpdateRxTransactionSetCancelled",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "WorkstationID",
"Value": "cfd52050-de9f-ec11-93ef-842b2b4a3dff"
},
{
"Name": "RxTransactionID",
"Value": "C0B1BDC0-3F3C-452A-95A7-1A658BE64CAC"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - UpdateRxTransactionSetCancelled
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdateRxTransactionSetCancelled This method will Set the RxTransatoion Status to Cancelled. Note, if there is a paid claim, on the RxTransaction(aka Fill), it will be reversed. If the claim gets an accepted reversal, only then will the status be set to cancelled. There is no real way to use your testing credentials, to test this method with an rxtransaction(aka Fill) that has a paid claim on it. This is due to the fact that there is not claim service setup to look at and process requested transmission that are in the testing area for APIs. *****NOTE****** THis routine mimics the cancel of a transaciton in the UI, so if you are unsure about how this can work for you, please consult with Developer Support. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| RxTransactionID | Guid | Vailid RxTransactionID | Yes |
| WorkstationID | Guid | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 42, found under Read, Other. The workstationid will be used for the printing of labels, in the event you are cancelling the original rxtransaction(aka 0 fill), and your system settings call for a on hold label to print. Also this will be the workstationid that the claim aleart shows up on to reflect that there was an attempt for a reversal and the status of that attemp, accepted or rejected. | Yes |
Update Rx Transaction Set Checked
Example Request Body:
{
"MethodName": "UpdateRxTransactionSetChecked",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "RxTransactionID",
"Value": "F23FACF3-9BE0-4658-B498-71CEAC7C5B5E"
},
{
"Name": "UserVerificationMethodTypeID",
"Value": "0"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - UpdateRxTransactionSetChecked
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdateRxTransactionSetChecked This method will Set the RxTransatoion Status to Checked, just like it is done in the UI. *****NOTE****** This routine mimics the Check station functions in the UI, so if you are unsure about how this can work for you, please consult with Developer Support. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| RxTransactionID | Guid | Vailid RxTransactionID | Yes |
| UserVerificationMethodTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 54, found under Read, Other. | Yes |
| AutoBinOverrideID | Guid | No | |
| CriticalComment | AnsiString | No | |
| DoNotUseAfterDate | DateTime | No | |
| ItemVerifiedTypeAtFill | Int32 | 0-None(Default) 1-Verified 2-Manually Verified | No |
| LotExpirationDate | DateTime | No | |
| LotNumber | AnsiString(50) | No | |
| TotalPackages | Int32 | No | |
| UpdatePrecheckedInformation | Int32 | 0-No (Default) 1-Yes 2-Manually Verified | No |
Update Rx Transaction Set Complete
Example Request Body:
{
"MethodName": "UpdateRxTransactionSetComplete",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "RxTransactionID",
"Value": "E3237F2D-96C1-4F81-8F49-34166D80F023"
},
{
"Name": "CompletedOn",
"Value": "2021-08-21 10:20:43.237"
},
{
"Name": "HistoricallyPaid",
"Value": "1"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - UpdateRxTransactionSetComplete
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdateRxTransactionSetComplete This method will Set the RxTransatoion Status to Completed. The RxTransaction Status of the requested RxTransationID must be in one of the following status:Out For Delivery, Waiting For Pickup, To Be Put in Bin, Waiting for Check, Waiting for Fill, Waiting for Print. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| RxTransactionID | Guid | Yes | |
| CompletedOn | DateTime | Defaults to current date/time if not passed | No |
| HistoricallyPaid | Int32 | 0 or 1, default is 0. | No |
Update Rx Transaction Set Filled
Example Request Body:
{
"MethodName": "UpdateRxTransactionSetFilled",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "RxTransactionID",
"Value": "F23FACF3-9BE0-4658-B498-71CEAC7C5B5E"
},
{
"Name": "UserVerificationMethodTypeID",
"Value": "0"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - UpdateRxTransactionSetFilled
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdateRxTransactionSetFilled This method will Set the RxTransatoion Status to Filled, just like it is done in the UI. *****NOTE****** This routine mimics the Fill station functions in the UI, so if you are unsure about how this can work for you, please consult with Developer Support. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| RxTransactionID | Guid | Vailid RxTransactionID | Yes |
| UserVerificationMethodTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 54, found under Read, Other. | Yes |
| DoNotUseAfterDate | DateTime | No | |
| ItemVerifiedTypeAtFill | Int32 | 0-None(Default) 1-Verified 2-Manually Verified | No |
| LotExpirationDate | DateTime | No | |
| LotNumber | AnsiString(50) | No | |
| TotalPackages | Int32 | No |
Update Rx Transaction Set Prechecked
Example Request Body:
{
"MethodName": "UpdateRxTransactionSetPrechecked",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "PWELL"
},
{
"Name": "RxTransactionID",
"Value": "69F42236-21DB-47BE-B389-BE02872770C9"
},
{
"Name": "WorkstationID",
"Value": "B9F4FD9C-3365-ED11-93F1-842B2B4A3DFE"
},
{
"Name": "UserVerificationMethodTypeID",
"Value": "0"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - UpdateRxTransactionSetPrechecked
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdateRxTransactionSetPrechecked This method will Set the RxTransatoion Status to Prechecked, just like it is done in the UI. Note, if there is no paid claim, on the RxTransaction(aka Fill), it will be transmit for a paid response. If the claim gets an accepted paid, only then will the status be set to PreChecked. There is no real way to use your testing credentials, to test this method with an rxtransaction(aka Fill) that has a unpaid claim on it. This is due to the fact that there is not a claim service setup to look at and process requested transmission that are in the testing area for APIs. *****NOTE****** This routine mimics the Pre-Checked transaciton functions in the UI, so if you are unsure about how this can work for you, please consult with Developer Support. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| RxTransactionID | Guid | Vailid RxTransactionID | Yes |
| UserVerificationMethodTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 54, found under Read, Other. | Yes |
| WorkstationID | Guid | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 42, found under Read, Other. The workstationid will be used for the printing of labels, in the event you are adjudicating claims after pre-check and you are not using the print queue. Also this will be the workstationid that the claim aleart shows up on to reflect that there was an attempt for a paid claim and the status of that attemp, accepted or rejected. | Yes |
Third-Party
Third Party Add From Directory
Example Request Body:
{
"MethodName": "ThirdPartyAddFromDirectory",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PlanID",
"Value": "58d04c47-c9d7-4ad8-8cf4-267ca5df520a"
},
{
"Name": "ThirdPartyName",
"Value": "MyAPI Medicaid"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"thirdParty": [
{"thirdPartyID": "a17125d5-a484-43c8-948e-21a0885eefe8"}
]},
"metadata": []
}
Method Name - ThirdPartyAddFromDirectory
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - ThirdPartyAddFromDirectory This will add a Third Party from the Third Party Directory.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PlanID | Guid | This will be the PlanID you get from the result set after using the ThirdPartySearchDirectory API. | Yes |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| ThirdPartyID | Guid | If not provide, a GUID will be generated for you and then returned in the successful result set. | No |
| ThirdPartyName | AnsiString(100) | If you do not like the name that we use in the ThirdPartySearchDirectory list, you can overrirde it. | No |
| ThirdPartyPrintName | AnsiString(100) | No |
Facility
Admit Patient Facility Wing
Example Request Body:
{
"MethodName": "AdmitPatientFacilityWing",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PersonID",
"Value": "c4e9338f-7e2d-44a7-9f90-67e9a7a7eaeb"
},
{
"Name": "FacilityID",
"Value": "9FA1A48B-9B66-41AB-96E2-2C19237AA29D"
},
{
"Name": "FacilityWingID",
"Value": "07547924-2748-4173-9B77-A371344BD4A4"
},
{
"Name": "AdmittedOn",
"Value": "7/14/2021"
},
{
"Name": "RoomNumber",
"Value": "RM12"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"patientFacility": [{
"patientFacilityID": "19129398-a82c-4ba2-9c8d-4ee5a412ead0"
}]
},
"metadata": []
}
Method Name - AdmitPatientFacilityWing
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - AdmitPatientFacilityWing Admit a patient into a facility/wing. Besides the parameters that are required, FacilityPatientID is a parameter that may be also used if you would like to tell the API what guid you would like to use for the FacilityPatientID. If FacilityPatientID is not passed in, then the system generated guid will be returned in the result set.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| FacilityID | Guid | Valid Facility, FacilityID | Yes |
| FacilityWingID | Guid | Valid Facility Wing, FacilityWingID | Yes |
| PersonID | Guid | Valid Patient, PersonID | Yes |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| AdmittedOn | DateTime | Defaults to current date if not passed. | No |
| Bed | AnsiString(50) | No | |
| FacilityCycleFillID | Guid | No | |
| LevelOfCare | AnsiString(200) | No | |
| MedicalRecordNumber | AnsiString(200) | No | |
| PatientFacilityID | Guid | If not provided, a guid will be generated by the system and returned in the results. | No |
| PrescriberIDAlternate | Guid | Valid Prescriber, PersonID | No |
| PrescriberIDPrimary | Guid | Valid Prescriber, PersonID | No |
| RoomNumber | AnsiString(200) | No |
Discharge Patient Facility Wing
Example Request Body:
{
"MethodName": "DischargePatientFacilityWing",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PatientFacilityID",
"Value": "19129398-a82c-4ba2-9c8d-4ee5a412ead0"
}
]
}
Success Response:
StatusCode: 200
{
"results": {},
"metadata": []
}
Method Name - DischargePatientFacilityWing
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - DischargePatientFacilityWing Discharge a patient from a facility/wing.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| PatientFacilityID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| DischargedOn | DateTime | Defaults to current date 23:59:00 if not passed. | No |
Facility Delivery Update Manifest Post Scan
Example Request Body:
{
"MethodName": "FacilityDeliveryUpdateManifestPostScan",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "FacilityDeliveryID",
"Value": "cc384509-1b94-41c3-95f0-327af6df1b52"
},
{
"Name": "ProofOfDeliveryDocument",
"Value": "Your Base64 encoded string goes here"
}
]
}
Success Response:
StatusCode: 200
{"results": {},"metadata": []}
Method Name - FacilityDeliveryUpdateManifestPostScan
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - FacilityDeliveryUpdateManifestPostScan This method will update the manifest delivery document for the facility delivery. This method is intended to mimic the Facility Delivery Post Scan process in the UI. It is highly recommended to discuss your use of this method with Developer Support if you are unclear as to how this method works or can work for your situation.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| FacilityDeliveryDocumentImage | AnsiString | This must be a valid base64 encoded string. The example body you see is just an example and not a valid value.
This will be a PDF,JPG,PNG,TIF,BMP document. We run it through a simple tool to validate it is a valid base64 encoded string. A good website for reference is:https://base64.guru/converter/encode/image or https://base64.guru/converter/decode/image or use this one for pdf, https://base64.guru/converter/decode/pdf | Yes |
| FacilityDeliveryID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| DeliveryReceivedByFirstName | AnsiString(50) | No | |
| DeliveryReceivedByIdentificationIssuingState | AnsiStringFixedLength(2) | No | |
| DeliveryReceivedByIdentificationNumber | AnsiString(128) | No | |
| DeliveryReceivedByIdentificationTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 60, found under Read, Other. | No |
| DeliveryReceivedByLastName | AnsiString(50) | No | |
| DeliveryReceivedByMiddleName | AnsiString(30) | No | |
| DeliveryReceivedByPatientRelationshipTypeID | Int32 | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 61, found under Read, Other. | No |
| DeliveryReceivedBySalutation | AnsiString(10) | No | |
| DeliveryReceivedBySuffix | AnsiString(10) | No |
Update Patient Facility Wing
Example Request Body:
{
"MethodName": "UpdatePatientFacilityWing",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "PatientFacilityID",
"Value": "19129398-a82c-4ba2-9c8d-4ee5a412ead0"
},
{
"Name": "AdmittedOn",
"Value": "7/14/2021"
},
{
"Name": "RoomNumber",
"Value": "RM13"
},
{
"Name": "Bed",
"Value": "Window"
}
]
}
Success Response:
StatusCode: 200
{
"results": {},
"metadata": []
}
Method Name - UpdatePatientFacilityWing
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - UpdatePatientFacilityWing Update a information on the facility/wing. It is strongly recommended that you use the method GetPatientFacilityWing, prior to update, in order to insure that you have the latest information for your update. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| AdmittedOn | DateTime | Yes | |
| PatientFacilityID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| Bed | AnsiString(50) | No | |
| DischargedOn | DateTime | No | |
| FacilityCycleFillID | Guid | No | |
| LevelOfCare | AnsiString(200) | No | |
| MedicalRecordNumber | AnsiString(200) | No | |
| PrescriberIDAlternate | Guid | Valid Prescriber, PersonID | No |
| PrescriberIDPrimary | Guid | Valid Prescriber, PersonID | No |
| RoomNumber | AnsiString(200) | No |
PointOfSale
Sale Transaction Update Proof Of Delivery
Example Request Body:
{
"MethodName": "SaleTransactionUpdateProofOfDelivery",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "SaleTransactionID",
"Value": "cc384509-1b94-41c3-95f0-327af6df1b52"
},
{
"Name": "ShipmentID",
"Value": "b9eeb2ec-0e86-44eb-a31f-9586e981a5df"
},
{
"Name": "ShipperStatusTypeID",
"Value": "10"
},
{
"Name": "ProofOfDeliveryDocument",
"Value": "Your Base64 encoded string goes here"
}
]
}
Success Response:
StatusCode: 200
{"results": {},"metadata": []}
Method Name - SaleTransactionUpdateProofOfDelivery
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - SaleTransactionUpdateProofOfDelivery This method will update the document image provided for the Sale Transaction, and update the status of the delivery if needed, and update the shipment status if needed. This method is intended to mimic the integration between PioneerRx and Fedex, UPS, USPS(Endica) as close as possible in order for the pharmacy programming staff to use this for mail order, delivery services, courier services, to name a few. It is highly recommended to discuss your use of this method with Developer Support if you are unclear as to how this method works or can work for your situation.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| ProofOfDeliveryDocument | AnsiString | This must be a valid base64 encoded string. The example body you see is just an example and not a valid value.
This will be a PDF,JPG,PNG,TIF,BMP document. We run it through a simple tool to validate it is a valid base64 encoded string. A good website for reference is:https://base64.guru/converter/encode/image or https://base64.guru/converter/decode/image or use this one for pdf, https://base64.guru/converter/decode/pdf | Yes |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| SaleTransactionID | Guid | Yes | |
| DeliveryReceivedByFirstName | String(50) | No | |
| DeliveryReceivedByIdentificationIssuingState | String(2) | No | |
| DeliveryReceivedByIdentificationNumber | String(128) | No | |
| DeliveryReceivedByIdentificationTypeID | Int32 | No | |
| DeliveryReceivedByLastName | String(50) | No | |
| DeliveryReceivedByMiddleName | String(30) | No | |
| DeliveryReceivedByPatientRelationshipTypeID | Int32 | No | |
| DeliveryReceivedBySalutation | String(10) | No | |
| DeliveryReceivedBySuffix | String(10) | No | |
| ShipmentID | Guid | No | |
| ShipperStatusTypeID | Int32 | 8=Delivered 10=Delivery_And_Signature | No |
Shipping
Shipment Add
Example Request Body:
{
"MethodName": "ShipmentAdd",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "SaleTransactionID",
"Value": "be5f38d9-5af8-45bf-849b-9251a129f9cb"
},
{
"Name": "TrackingNumber",
"Value": "BR549_01282022"
},
{
"Name": "ShipperName",
"Value": "Fly By Night"
},
{
"Name": "ShipperStatusTypeID",
"Value": "1"
},
{
"Name": "ManualEntry",
"Value": "0"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"shipment": [
{
"shipmentID": "384d030a-6040-4021-af43-b823d5b3b452"
}
]
},
"metadata": []
}
Method Name - ShipmentAdd
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - ShipmentAdd Adds a shipment record. This method mimics the adding of the tracking information used by UPS, FedEx and USPS(Endcia) integration with PioneerRx.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| SaleTransactionID | Guid | Must be a valid guid. You can use SaleTransactionSearch to find ID | Yes |
| ShipperName | AnsiString(15) | Yes | |
| TrackingNumber | AnsiString(40) | Yes | |
| ManualEntry | Int32 | 0 or 1, default is 0. 0=Means it was imported in by a service, aka your API. This is also how it is marked in our integration with UPS, FedEx and USPS(Endcia). 1=Means it was updated/changed by the UI. | No |
| ShipmentID | Guid | If not provided, a guid will be generated by the system and returned in the results. | No |
| ShipperStatusTypeID | Int32 | 1 or 5, default is 1. 1=Unknown 5=Pending | No |
Shipment Update
Example Request Body:
{
"MethodName": "ShipmentUpdate",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "ShipmentID",
"Value": "384d030a-6040-4021-af43-b823d5b3b452"
},
{
"Name": "TrackingNumber",
"Value": "BR549_01282022"
},
{
"Name": "ShipperName",
"Value": "Fly By Night"
},
{
"Name": "ShipperStatusTypeID",
"Value": "5"
},
{
"Name": "ManualEntry",
"Value": "0"
}
]
}
Success Response:
StatusCode: 200
{
"results": {},
"metadata": []
}
Method Name - ShipmentUpdate
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - ShipmentUpdate This method will update the shipment information. It is strongly recommended that you use the method ShipmentGet, prior to update, in order to insure that you have the latest information for your update. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| ManualEntry | Int32 | 0 or 1, default is 0. 0=Means it was imported in by a service, aka your API. This is also how it is marked in our integration with UPS, FedEx and USPS(Endcia). 1=Means it was updated/changed by the UI. | Yes |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| ShipmentID | Guid | If not provided, a guid will be generated by the system and returned in the results. | Yes |
| ShipperName | AnsiString(15) | Yes | |
| ShipperStatusTypeID | Int32 | 1,5,6 default is 1. 1=Unknown 5=Pending 6=Transit | Yes |
| TrackingNumber | AnsiString(40) | Yes |
Item
Item Inventory Group Adjustment Add
Example Request Body:
{
"MethodName": "ItemInventoryGroupAdjustmentAdd",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "InventoryGroupID",
"Value": "CFA6D4A4-F9F7-4DA1-AF71-99A1C7DC1744"
},
{
"Name": "InventoryAdjustmentTypeID",
"Value": "1"
},
{
"Name": "OnHandQuantityAdjustment",
"Value": "-10"
},
{
"Name": "ReasonForAdjustment",
"Value": "Dropped pills on floor."
}
]
}
Method Name - ItemInventoryGroupAdjustmentAdd
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - ItemInventoryGroupAdjustmentAdd This method will adjust the requested Item Inventory Group Balance on Hand or On Order Quantity + or -. Remember, it does not set the balance on hand or on order quantity, it adjusts then.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| InventoryAdjustmentTypeID | Int32 | 1 is for a Manual Adjustment and is the only option for now. | Yes |
| InventoryGroupID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| OnHandQuantityAdjustment | Decimal | No | |
| OnOrderQuantityAdjustment | Decimal | No | |
| ReasonForAdjustment | AnsiString | No |
Item Update Status Type
Example Request Body:
{
"MethodName": "ItemUpdateStatusType",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "ItemID",
"Value": "F467F99F-EB3D-4950-8AD9-865D320A7F54"
},
{
"Name": "StatusTypeID",
"Value": "4BB15042-80F2-4C25-BCDD-3F24E436646B"
}
]
}
Success Response:
StatusCode: 200
{ "results": {}, "metadata": [] }
Method Name - ItemUpdateStatusType
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - ItemUpdateStatusType This method will update the item status to the specific status passed. The example body shows how to set an item status to Active. It is strongly recommended that you use the method ItemGet, prior to update, in order to insure that you have the latest information for your update. **Note, as in any update, if values are not passed, the field will be cleared/emptied/wiped/reset to default value.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| ItemID | Guid | Yes | |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| StatusTypeID | Guid | Valid values can be found using the method LookUpListDetailGet, LookUpListID = 50, found under Read, Other. | Yes |
Other
Incoming Document Image Add
Example Request Body:
{
"MethodName": "RxDocumentAdd",
"Version": 1.0,
"ParameterCollection": [
{
"Name": "RequestedByEmployeeID",
"Value": "dhart"
},
{
"Name": "DocumentImage",
"Value": "Your Base64 Image string goes here"
}
]
}
Success Response:
StatusCode: 200
{
"results": {
"incomingDocumentImageID": [
{
"incomingDocumentImageID": "aa1f2e7d-99cb-4fbd-9a5d-64783fb2f44a"
}
]
},
"metadata": []
}
Method Name - IncomingDocumentImageAdd
Version - 1.0
POST - Used to execute method using parameter collection.
https://{API URL}/api/enterprise/method/process
Description - IncomingDocumentImageAdd This method will add a document to the incoming document queue.
| Field Name | Type | Notes | Required |
|---|---|---|---|
| IncomingDocumentImage | AnsiString | This must be a valid base64 encoded string. The example body you see is just an example and not a valid value.
This will be a PDF,JPG,PNG,TIF,BMP document. We run it through a simple tool to validate it is a valid base64 encoded string. A good website for reference is:https://base64.guru/converter/encode or https://base64.guru/converter/decode or use this one for pdf, https://base64.guru/converter/decode/pdf | Yes |
| RequestedByEmployeeID | AnsiString(20) | This is labeled Employee ID in the PioneerRx UI | Yes |
| IncomingDocumentDescription | AnsiString(100) | No | |
| IncomingDocumentFileExtension | AnsiString(20) | No | |
| IncomingDocumentFileName | AnsiString(1000) | No | |
| IncomingDocumentImageID | Guid | No | |
| IncomingDocumentName | AnsiString(100) | No | |
| NumberOfPages | Int32 | No | |
| OriginatingPhoneNumber | AnsiString(50) | No |