APIKey | string | Optional field that can be used for authentication purposes. It’s up to the third party partner whether this field will be required or not. |
PharmacyNumber | string | Number to help identify the pharmacy the data is coming from. By default BestRx will send the NPI number, but that can be changed if requested by the receiving partner. |
PharmacyNumber_Alt | string | An alternate pharmacy identifier can be provided if needed. Most integrations will not need this value. |
transaction_id | string | Unique identifier for the particular fill of the prescription. This value should be used when considering whether to add a new record or update an existing one. |
transaction_date | string | Date transaction is sent in YYYY-MM-DD format. This value is sent as the UTC date. |
transaction_time | string | Time transaction is sent in HH:MM:SS (24 hour) format. This value is sent as the UTC time. |
transaction_time_fraction | string | Time fraction transaction is sent, with 7 decimal places |
rx_number | string | Prescription number |
patient_id | integer | Unique identifier of the patient in the BestRx system. |
patient_last_name | string | Patient’s last name |
patient_first_name | string | Patient’s first name |
patient_middle_name | string | Patient’s middle name |
patient_prefix | string | Prefix to patient’s name (ie Mr. Mrs., etc) |
patient_suffix | string | Suffix to patient’s name (ie Jr, III, etc) |
patient_address1 | string | Patient street address line 1 |
patient_address2 | string | Patient street address line 2 ( ie Unit Number or other identifying info) |
patient_city | string | Patient’s city portion of address |
patient_state | string | Patient’s state portion of address |
patient_zip | string | Patient’s zip code |
patient_home_phone | string | Patient’s home phone number |
patient_cell_phone | string | Patient’s cell phone number |
patient_work_phone | string | Patient’s work phone number |
patient_dob | string | Patient date of birth in YYYY-MM-DD format |
patient_gender | string | Patient’s gender (M/F/N) **N=Non-Binary |
patient_email | string | Patient’s email address |
patient_group | array | Array of groups that the patient is linked to. This is a repeating field. Please refer to the Groups section of this document for more info. |
family_email | string | Family’s shared email address |
patient_short_remark | string | Short remark relating to the patient |
patient_remark | string | Long remark relating to the patient |
family_remark | string | Shared remark relating to entire family |
patient_shipto_organization | string | Ship To organization name |
patient_shipto_last_name | string | Ship To last name |
patient_shipto_first_name | string | Ship To first name |
patient_shipto_careof | string | Ship To “care of” name |
patient_shipto_address1 | string | Ship To street address line 1 |
patient_shipto_address2 | string | Ship To street address line 2 |
patient_shipto_city | string | Ship To City |
patient_shipto_state | string | Ship To state |
patient_shipto_zip | string | Ship To zip code |
patient_shipto_phone | string | Phone number related to the Ship To Address |
is_deactivated | boolean | Indicated whether the prescription was deactivated by the pharmacy (true/false) |
transferred_out | boolean | Indicates whether the prescription was transferred out to another pharmacy (true/false) |
transferred_pharmacy | string | Name of the pharmacy the prescription was transferred to |
transferred_pharmacy_address1 | string | Address line 1 of the pharmacy the prescription was transferred to |
transferred_pharmacy_address2 | string | Address line 2 of the pharmacy the prescription was transferred to |
transferred_pharmacy_city | string | City of the pharmacy the prescription was transferred to |
transferred_pharmacy_state | string | State of the pharmacy the prescription was transferred to |
transferred_pharmacy_zip | string | Zip code of the pharmacy the prescription was transferred to |
transferred_pharmacy_phone | string | Phone number of the pharmacy the prescription was transferred to |
transferred_pharmacy_fax | string | Fax number |
transferred_pharmacy_ncpdp | string | NCPDP number of the pharmacy the prescription was transferred to |
transferred_pharmacy_npi | string | NPI number of the pharmacy the prescription was transferred to |
transferred_pharmacy_dea | string | DEA number of the pharmacy the prescription was transferred to |
transfer_date | string | The date the prescription was transferred |
transfer_contact_name | string | The contact name of the person at the pharmacy the prescription was transferred to |
transfer_rph_initials | string | Initials of the pharmacist at your pharmacy that handled the transfer |
transfer_rph_user_id | string | BestRx User ID of the pharmacist at your pharmacy that handled the transfer |
transfer_rph_last_name | string | Last Name of the pharmacist at your pharmacy that handled the transfer |
transfer_rph_first_name | string | First Name of the pharmacist at your pharmacy that handled the transfer |
transferfrom_pharmacy | object | Information about the pharmacy that transferred the prescription to this pharmacy. Please see the Pharmacy Info section for more details |
bill_status | string | Coded value for the Billing Status of the prescription. Please refer to Appendix A for a list of bill status codes and their descriptions. |
bill_status_text | string | Text Description for the billing status of this prescription. |
workflow_status | string | Coded value for the Workflow Status of the prescription. Please refer to Appendix B for a list of workflow statuses and their descriptions. |
workflow_status_text | string | Text Description for the workflow status of the prescription |
workflow_queues | array | Array of workflow queues the prescription is in. This is a repeating field. Please refer to the Workflow Queues section of this document for more info. |
fill_number | string | Fill Number of the prescription (1 = original, 2 = first refill, 3 = second refill, etc). |
fill_date | string | Date the prescription was filled. Also knows as Date of Service. Value will be in YYYY-MM-DD format. |
fill_time | string | Time prescription was entered into the system. Value will be in HH:MM:SS (24 hour) format. |
picked_up | string | Indicates if the prescription was picked up (true/false) |
delivered | string | Indicates if the prescription was delivered (true/false) |
qty_ordered | string | Quantity that the doctor prescribed for each fill |
qty_filled | string | Quantity that was dispensed for this fill |
days_supply | string | Days supply dispensed for this fill |
refills_authorized | string | Number of refills authorized by the doctor |
refills_remaining | string | Number of refills that are remaining for this prescription. This could be a decimal value if there were partial fills involved. |
refill_number | string | Refill number of the prescription (0 = original, 1 = first refill, 2 = second refill, etc). |
refill_exp_date | string | Latest date at which the prescription can still be refilled. |
item_upc_code | string | For OTC items, the UPC code of the item |
drug_ndc | string | The NDC of the dispensed drug. |
drug_ndc_10digit | string | The NDC of the dispensed drug in 10-digit format without dashes. |
drug_ndc_10digit_formatted | string | The NDC of the dispensed drug in 10-digit format with dashes. |
drug_gpi | string | The GPI of the dispensed drug. The GPI allows you to check if drugs with different NDC’s are therapeutically equivalent or related.Please see Appendix C for more info about GPI values. |
drug_name | string | The name of the dispensed drug |
drug_strength | string | The strength of the drug (ie “20 MG”) |
drug_mfg | string | The manufacturer of the drug |
drug_schedule | string | The DEA control schedule of the dispensed drug. |
drug_is_generic | string | Indicates if the drug is generic (true/false) |
drug_brand_name | string | For generic drugs, the brand drug name |
drug_package_size | string | The package size of the drug when purchased from the drug wholesaler |
drug_form | string | The form that the drug comes in. Ex: Tablet, Capsule, Gram, ML, etc. |
drug_color | string | The color of the drug |
drug_shape | string | The shape of the drug |
drug_front_imprint | string | The imprint or markings on the front of the drug |
drug_back_imprint | string | The imprint or markings on the back of the drug |
drug_misc_info | string | Miscellaneous info that can help with identifying the drug |
lot_number | string | Lot number of the dispensed drug |
lot_exp_date | string | Lot expiration date of the dispensed drug (YYYY-MM-DD) |
retail | string | The amount the pharmacy normally would charge for this prescription if the patient was to pay cash. Also knows as Usual & Customary Charges. |
billed | string | Amount that was billed to the insurance. |
payers | array | Array of insurance payers linked to this prescription. This is a repeating field. Please refer to the Payers section of this document for more info. |
cost | string | The acquisition cost of this drug for the quantity dispensed. |
patient_amount_due | string | The total amount that the patient is responsible for this prescription. This includes all copays, deductibles, coinsurances, etc from all of the patient’s insurances that have been billed. |
due_from_insurance | string | The total amount due from insurance from all of the patient’s insurances that have been billed. |
total_paid | string | The total amount the pharmacy can expect to receive for the prescription. This includes anything the insurance will pay as well as anything the patient will pay. |
margin | string | The profit margin made on this prescription. Essentially it will be the same as total_paid - cost. |
margin_percent | string | Profit margin percentage |
| | (100 * ((total_paid - cost) / cost) |
is340b | string | Indicates if it’s a 340B prescription (true/false) |
dispense_as_written | string | “true” or “false” value indicating DAW |
daw_code | string | DAW code of the prescription |
date_rx_written | string | Date the doctor wrote the prescription |
signature | string | The SIG directions of the prescription (ie TAKE 1 TABLET DAILY) |
dosage_info | array | Array of dosage info linked to this prescription. This is a repeating field. Please refer to the Dosage Info section of this document for more info. |
rx_source | string | How the prescription reached the pharmacy 1 = Written 2 = Telephone 3 = Electronic 4 = Fax 5 = Generated by Pharmacy or Transferred to Pharmacy |
rph_initials | string | Initials of the registered pharmacist that filled or verified the prescription |
tech_initials | string | Initials of the technician that helped to fill the prescription |
rx_serial_number | string | The serial number of the prescription from the doctor’s prescription pad |
submission_clar_code | string | Submission Clarification Code used to override a reject during insurance billing |
other_coverage_code | string | Other Coverage Code used to bill insurance to a secondary or tertiary payer |
horizon_graveyard_code | string | Codified reason a prescription was not filled. Only used for pharmacies that report data to Horizon |
diagnosis | array | Array of diagnosis code linked to this prescription. This is a repeating field. Please refer to the Diagnosis section of this document for more info. |
doctor_id | integer | Unique identifier of the prescriber in the BestRx system. |
doctor_last_name | string | Prescriber’s last name |
doctor_first_name | string | Prescriber’s first name |
doctor_middle_name | string | Prescriber’s middle name |
doctor_prefix | string | Prefix to prescriber’s name (ie Mr. Mrs., etc) |
doctor_suffix | string | Suffix to prescriber’s name (ie MD, DO, etc) |
doctor_npi | string | Prescriber’s NPI number |
doctor_dea | string | Prescriber’s DEA number |
doctor_state_licno | string | Prescriber's State License number |
doctor_dps_no | string | Prescriber's DPS number |
doctor_medicaid_no | string | Prescriber's Medicaid number |
doctor_upin | string | Prescriber's UPIN number |
doctor_address1 | string | Prescriber’s street address line 1 |
doctor_address2 | string | Prescriber’s street address line 1 (ie Suite Number or other identifying info) |
doctor_city | string | Prescriber’s city portion of the address |
doctor_state | string | Prescriber’s state portion of the address |
doctor_zip | string | Prescriber’s zip code |
doctor_phone | string | Prescriber’s office phone number |
doctor_fax | string | Prescriber’s fax number |
doctor_email | string | Prescriber’s email address |
doctor_remark | string | Remarks associated with the prescribers |
doctor_profession_code | string | Prescriber's Profession Code |
doctor_profession_desc | string | Prescriber's Profession Code Description |
doctor_ama_specialty_code | string | Prescriber's AMA Specialty Code |
doctor_ama_grouping | string | Prescriber's AMA Grouping |
doctor_ama_classification | string | Prescriber's AMA Classification |
doctor_ama_specialization | string | Prescriber's AMA Specialization |
doctor_surescripts_service_level | string | The service levels that this prescriber is enabled for with Surescripts. Possible values are New, Refill, Change, RxFill, Cancel, MedHistory, Eligibility, Resupply, Census, CCR, Controlled Substances, RxFill Indicator Change, Long Term Care, CI Message, CI Event, ePA, RLE, Medication Adherence, High Risk Medication, Missing Medication, PDC, MmpocMpiSearch, Disposition Request, Disposition Acknowledgement, Patient Med Benefit Check, and Specialty Patient Onboard |
next_refill_date | string | Date that the next refill is due for the prescription |
drug_therapeutic_class | string | Therapeutic class of the drug (at this time this field will not be populated) |
prescribed_drug | string | Drug that was prescribed by the doctor |
filled_by | string | The person at the pharmacy that “filled’ the prescription |
erx_message_id | string | Message ID from the e-prescription message |
erx_prescriber_order_no | string | Prescriber Order Number from the e-prescription message |
rx_remark | string | Remarks associated with the prescription |
erx_pharmacy_remark | string | Pharmacy related remarks related to the e-prescription message for this prescription |
erx_prescriber_remark | string | Prescriber related remarks related to the e-prescription message for this prescription |
erx_drug_notes | string | The medication notes sent by the prescriber in the e-prescription message for this prescription |
written_date_remark | string | Remarks related to the written date for this prescription (ie why was prescription filled after normal allowable time after written date) |
inactivate_rx_remark | string | Remarks related to explaining why a prescription was deactivated |
shipping_provider | string | Shipping provider used to ship prescription to patient. Current support values are “FedEx”, “UPS” and “USPS”. |
shipping_tracking_number | string | Tracking number of shipment the prescription was a part of |
dispense_using | string | Lets you know what type of packing the prescription will use (ie Safety Caps, Easy Caps, Bubble Packs, Pouch, etc) |
is_medsync_shortfill | boolean | Indicates if this is a MedSync short fill |
claim_reject_info | array | Array of reject codes and descriptions associated with the claim transmittal. This is a repeating field. Please refer to the Claim Reject Info section of this document for more info. |
pbm_message | string | Message sent from the PBM in the NCPDP field 504-F4 |
claim_additional_messages | array | Array of messages sent back in the NCPDP field 526-FQ. This is a repeating field. Please refer to the Claim Additional Messages section of this document for more info. |