INFO

Used to sync patient data in BestRx with a TPP’s external environment. BestRx sends data to TPP anytime a patient is created, updated, or deleted in the BestRx system.

Root Fields

Field Name	Type	Type
APIKey	string	Optional field that can be used for authentication purposes. It’s up to the receiving 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.
transaction_action	string	When a patient is created or updated, a value of “updated” will be sent. When a patient is deleted, a value of “deleted” will be sent.
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.
unique_patient_id	integer	Unique identifier of the patient in the BestRx system.
last_name	string	Patient’s last name
middle_name	string	Patient’s middle name
first_name	string	Patient’s first name
name_prefix	string	Prefix to patient’s name (ie Mr. Mrs., etc)
name_suffix	string	Suffix to patient’s name (ie Jr, III, etc)
dob	string	Patient date of birth in YYYY-MM-DD format
gender	string	Patient’s gender (M/F/N) **N=Non-Binary
address1	string	Patient street address line 1
address2	string	Patient street address line 2 ( ie Unit Number or other identifying info)
city	string	Patient’s city portion of address
state	string	Patient’s state portion of address
zipcode	string	Patient’s zip code
home_phone	string	Patient’s home phone number
work_phone	string	Patient’s work phone number
cell_phone	string	Patient’s cell phone number
patient_email	string	Patient’s email address
family_email	string	Family’s shared email address
social_security_number	string	Patient’s social security number
is_active	string	Indicates whether this is an active patient within BestRx (true/false)
is_deceased	string	Indicates whether the patient is deceased or not (true/false)
is_pet	string	Indicates whether the patient is an animal (true/false)
language	string	Indicates the preferred language for the patient (English, Spanish, Russian, Chinese, etc)
nursing_home_unique_id	integer	Unique ID in BestRx for Nursing home or LTC facility the patient is linked to
nursing_home	string	Nursing home or LTC facility the patient is linked to
nursing_home_facility_code	string	Nursing home or LTC facility’s code
nursing_home_facility_id	string	Nursing home or LTC facility’s ID
nursing_home_contact_name	string	Nursing home or LTC facility’s contact person
nursing_home_address1	string	Nursing home or LTC facility’s street address line 1
nursing_home_address2	string	Nursing home or LTC facility’s street address line 2
nursing_home_city	string	Nursing home or LTC facility’s city
nursing_home_state	string	Nursing home or LTC facility’s state
nursing_home_zip	string	Nursing home or LTC facility’s zip code
nursing_home_phone	string	Nursing home or LTC facility’s phone number
nursing_home_fax	string	Nursing home or LTC facility’s fax number
nursing_home_alt_phone1	string	Nursing home or LTC facility’s alternate phone number
nursing_home_alt_phone2	string	Nursing home or LTC facility’s alternate phone number
insurance_plans	array	Array of insurance plans linked to this patient. This is a repeating field. Please refer to the Insurance Plans section of this document for more info.
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.
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
allergies	array	Array of allergies linked to this patient. This is a repeating field. Please refer to the Allergies section of this document for more info.

Insurance Plans

Field Name	Type	Notes
ins_seq_no	integer	Sequence number of the insurance plans as they are listed in the BestRx system. First value will be 1.
ins_name	string	The name of the insurance plan
ins_code	string	The code of the insurance plan. The code is assigned by the pharmacy and has no significance in terms of actual billing purposes.
ins_is_primary	boolean	Indicates if this is the patient’s primary plan (true/false)
ins_bin	string	The BIN of the insurance plan
ins_pcn	string	The Processor Control Number of the insurance plan
ins_cardholder_id	string	The patient’s Cardholder ID for this plan
ins_person_code	string	The patient’s Person Code for this plan
ins_group	string	The patient’s Group Number for this plan
ins_relation_code	string	The patient’s Relationship Code for this plan
ins_cardholder_first_name	string	The Cardholder First Name for this plan. Most of the time it will be the same as the Patient’s First Name, but could be different if the patient’s spouse, parent, or other family member is the primary account holder of the insurance plan.
ins_cardholder_last_name	string	The Cardholder Last Name for this plan. Most of the time it will be the same as the Patient’s Last Name, but could be different if the patient’s spouse, parent, or other family member is the primary account holder of the insurance plan.

Groups

Field Name	Type	Notes
group_code	string	Internal code of the group in the BestRx system.
group_name	string	Name of the group.

Allergies

Field Name	Type	Notes
alg_code	string	Allergy code from Compendia database (currently using MediSpan)
alg_description	string	User-friendly allergy description

Example

{
    "APIKey": "",
    "PharmacyNumber": "1234567890",
    "transaction_action": "update",
    "transaction_date": "2019-03-15",
    "transaction_time": "22:34:45",
    "unique_patient_id": 25731,
    "last_name": "DOE",
    "middle_name": "WAYNE",
    "first_name": "JOHN",
    "name_prefix": "",
    "name_suffix": "",
    "dob": "1980-04-23",
    "gender": "M",
    "address1": "167 W GRAND AVE",
    "address2": "UNIT 1408",
    "city": "CHICAGO",
    "state": "IL",
    "zipcode": "60654",
    "home_phone": "3129555555",
    "work_phone": "6308935555",
    "cell_phone": "6304005555",
    "patient_email": "johndoe@gmail.com",
    "family_email": "",
    "social_security_number": "111223333",
    "is_active": "true",
    "is_deceased": "false",
    "is_pet": "false",
    "language": "Spanish",
    "nursing_home": "JOSEPH REHABILITATION CENTER",
    "insurance_plans": [
        {
            "ins_seq_no": 1,
            "ins_name": "WORKCOMP",
            "ins_code": "WCOMP",
            "ins_is_primary": true,
            "ins_bin": "123456",
            "ins_pcn": "",
            "ins_cardholder_id": "44444444",
            "ins_person_code": "01",
            "ins_group": "ASD0W9U43",
            "ins_relation_code": "1 - Cardholder",
            "ins_cardholder_first_name": "JOHN",
            "ins_cardholder_last_name": "DOE"
        }
      ],
    "patient_group": [
        {
          "group_code": "1",
          "group_name": "TEST GROUP 1"
        },
        {
          "group_code": "2",
          "group_name": "TEST GROUP 2"
        }
      ],
    "patient_short_remark": "Test short remark",
    "patient_remark": "",
    "family_remark": ""
}

Patient Update Callback

Root Fields#

Insurance Plans#

Groups#

Allergies#

Example#

Root Fields

Insurance Plans

Groups

Allergies

Example