BestRx APIs
Contact Us
  1. Patient API
  • Introduction - BestRx APIs
  • Patient API
    • Overview
    • Error Codes
    • Add Patient
      POST
    • Update Patient
      POST
    • Get Patient
      POST
    • Submit Charge Account Payment
      POST
  • Drug API
    • Overview
    • Error Codes
    • Get Drug Information
      POST
  • Prescription API
    • Overview
    • Error Codes
    • Submit Rx Transfer Request
      POST
    • Return to Stock
      POST
    • Save Rx Signature
      POST
  • Refill API
    • Overview
    • Error Codes
    • GetPatientProfile
      POST
    • Send Refill Request
      POST
  • BestPOS API
    • Overview
    • Error Codes
    • Create POS Transaction
      POST
    • Get POS Transaction Status
      POST
    • Get Item Details
      POST
  • Delivery/Shipping Provider API
    • Overview
    • Error Codes
    • Address Validation
    • Create Order
    • Update Order Status
    • Cancel Order
  • Realtime Data Feed Specification
    • Overview
    • Patient Update Callback
    • E-Prescription Notification Callback
    • Prescription Update Callback
  1. Patient API

Get Patient

POST
https://dataservice.bestrxconnect.com/patient/getpatient
INFO
This endpoint is used to get the Patient Information from the BestRx System.

Request

Body Params application/json
unique_patient_id
integer  | null 
required
Patient Record Number. Either "unique_patient_id" OR "last_name, first_name, dob, zipcode and gender" is required to get the patient information.
Example:
123456
last_name
string  | null 
required
Patient Last Name
Example:
Kennedy
first_name
string  | null 
required
Patient First Name
Example:
John
dob
string  | null 
required
Patient Date of Birth (YYYY-MM-DD or ISO 8601 Format)
Examples:
1917-05-291917-05-29T00:00:00
zipcode
string  | null 
required
Patient Zip Code (5 or 9 Digits without Hyphen '-')
Examples:
60523605231234
Match pattern:
0-9
gender
enum<string>  | enum<null> 
required
Patient Gender
Allowed values:
MF12
Example:
M
PharmacyNumber
string  | null 
required
Pharmacy NPI Number. Either 'PharmacyNumber' OR 'PharmacyNCPDP' is required.
Example:
1234567890
PharmacyNCPDP
string  | null 
required
Pharmacy NCPDP Number. Either 'PharmacyNumber' OR 'PharmacyNCPDP' is required.
Example:
1234567
Example
{
    "unique_patient_id": 123456,
    "last_name": "Kennedy",
    "first_name": "John",
    "dob": "1917-05-29T00:00:00",
    "zipcode": "60523",
    "gender": "M",
    "PharmacyNumber": "1234567890",
    "PharmacyNCPDP": "1234567"
}

Responses

🟢200OK
application/json
Body
Data
object 
required
insurance_plans
array [object {22}]  | null 
required
unique_patient_id
integer 
required
allow_duplicate
boolean 
required
relates_to_patient_id
integer  | null 
required
last_name
string 
required
middle_name
string 
required
first_name
string 
required
name_prefix
string 
required
name_suffix
string 
required
dob
string 
required
gender
integer 
required
address1
string 
required
address2
string 
required
city
string 
required
state
string 
required
county
null 
required
zipcode
string 
required
country_code
string 
required
home_phone
string 
required
work_phone
string 
required
cell_phone
string 
required
fax_number
string 
required
family_email
string 
required
patient_email
string 
required
marital_status
string  | null 
required
bill_last_name
string 
required
bill_first_name
string 
required
bill_address_careof
string 
required
bill_address1
string 
required
bill_address2
string 
required
bill_address_city
string 
required
bill_address_state
string 
required
bill_address_zipcode
string 
required
bill_phone
string 
required
patient_id_qualifier
string 
required
patient_id
string 
required
social_security_number
string 
required
smoker
boolean  | null 
required
loyalty_number
string 
required
residence_code
string 
required
dispense_by
string  | null 
required
340B_patient
boolean 
required
is_pet
boolean 
required
pet_name
string 
required
patient_short_remark
string 
required
patient_remark
string 
required
family_remark
string 
required
is_active
boolean 
required
is_deceased
boolean 
required
language
integer 
required
patient_race
integer 
required
patient_ethnicity
integer 
required
allergies
array [object {3}]  | null 
required
PharmacyNumber
string  | null 
required
PharmacyNCPDP
null 
required
IsValid
boolean 
required
Messages
array[string]
required
Example
{
    "Data": {
        "insurance_plans": [
            {
                "ins_bin": "610084",
                "ins_pcn": "DRTXPROD",
                "ins_code": "BCBSIL",
                "ins_name": "BLUE CROSS BLUE SHIELD OF ILLINOIS",
                "ins_address1": "1234 SOME STREET",
                "ins_address2": "SUITE 3",
                "ins_city": "CHICAGO",
                "ins_state": "IL",
                "ins_zipcode": "605231234",
                "ins_phone": "1234567890",
                "ins_remark": "Insurance Test Remark",
                "ins_fax_number": "1234567890",
                "ins_alternate_phone": "1234567890",
                "ins_email": "insurance@email.com",
                "ins_seq_no": 1,
                "ins_cardholder_id": "1234567890",
                "ins_person_code": "01",
                "ins_relation_code": "1",
                "ins_group": "DRS879",
                "ins_is_primary": true,
                "IsValid": true,
                "Messages": []
            }
        ],
        "unique_patient_id": 123456,
        "allow_duplicate": false,
        "relates_to_patient_id": 12345,
        "last_name": "KENNEDY",
        "middle_name": "FITZGERALD",
        "first_name": "JOHN",
        "name_prefix": "MR",
        "name_suffix": "JR",
        "dob": "1917-05-29T00:00:00",
        "gender": 1,
        "address1": "1234, FIRST STREET",
        "address2": "APT 107",
        "city": "OAK BROOK",
        "state": "IL",
        "county": null,
        "zipcode": "60523",
        "country_code": "US",
        "home_phone": "9876543210",
        "work_phone": "9876543210",
        "cell_phone": "9876543210",
        "fax_number": "9876543210",
        "family_email": "family@email.com",
        "patient_email": "patient@email.com",
        "marital_status": "S",
        "bill_last_name": "KENNEDY",
        "bill_first_name": "JOHN",
        "bill_address_careof": "JOHN F. KENNEDY",
        "bill_address1": "3423, FIRST STREET",
        "bill_address2": "APT 107",
        "bill_address_city": "OAK BROOK",
        "bill_address_state": "IL",
        "bill_address_zipcode": "605231234",
        "bill_phone": "9876543210",
        "patient_id_qualifier": "01",
        "patient_id": "P123-4567-8900",
        "social_security_number": "123456789",
        "smoker": true,
        "loyalty_number": "123456",
        "residence_code": "01",
        "dispense_by": "P",
        "340B_patient": true,
        "is_pet": false,
        "pet_name": "",
        "patient_short_remark": "Test Short Remark",
        "patient_remark": "Patient Remark",
        "family_remark": "Family Remark",
        "is_active": true,
        "is_deceased": false,
        "language": 0,
        "patient_race": 0,
        "patient_ethnicity": 0,
        "allergies": [
            {
                "alg_qualifier": "MSKDC",
                "alg_code": "00032",
                "alg_description": "Aloprim"
            }
        ],
        "PharmacyNumber": "1234567890",
        "PharmacyNCPDP": "1234567"
    },
    "IsValid": true,
    "Messages": []
}
🟠400Bad Request
Modified at 2024-07-25 19:50:12
Previous
Update Patient
Next
Submit Charge Account Payment