GetPatientProfile - BestRx APIs

INFO

This endpoint it used to get the patient's Rx profile details.

Request

Header Params

Content-Type

string

optional

Example:

application/json; charset=utf-8

Body Params application/json

Username

string

optional

Username is provided by BestRx. Only required for Technology Partners working with multiple pharmacies.

Example:

Telecom

APIKey

string

required

API Key is assigned by BestRx to Each Pharmacy or Technology Partners.

Example:

1abc2d3e4fghi5jklm6nopq7rstu890vwxyz

PharmacyNumber

string

required

Pharmacy NPI Number

Example:

1234567890

LastName

string

optional

Patient’s Last Name. 'LastName' is optional if 'ReturnOnlyQueriedRx' parameter value set to 'Y'.

Example:

SMITH

DOB

string

required

Patient’s Date of Birth (YYYY-MM-DD or ISO 8601 Format)

Examples:

1990-12-312023-12-31T23:59:59Z

BestRxPatientID

number

required

Unique Patient Identification Number (Patient Record Number). Either 'RxNumber' OR 'BestRxPatientID' is required.

Example:

12345

RxNumber

number

required

Prescription Number. Either 'RxNumber' OR 'BestRxPatientID' is required.

Example:

100001

IncludeHoldRx

enum<string>

optional

Include Hold Prescriptions or Not.

Allowed values:

Default:

Example:

IncludeUnbilledRx

enum<string>

optional

Include Unbilled Prescriptions or Not.

Allowed values:

Default:

Example:

ReturnOnlyQueriedRx

enum<string>

optional

Retrieve only Requested Prescriptions or Not. 'LastName' is optional when this parameter value is set to “Y”.

Allowed values:

Default:

Example:

Example

{
    "userName": "Telecom",
    "APIKey": "1abc2d3e4fghi5jklm6nopq7rstu890vwxyz",
    "PharmacyNumber": "1234567890",
    "LastName": "Smith",
    "DOB": "1990-12-31",
    "RxNumber": 100001,
    "BestRxPatientID": "12345",
    "IncludeHoldRx": "Y",
    "IncludeUnbilledRx": "Y",
    "ReturnOnlyQueriedRx": "Y"
}

Responses

🟢200OK

application/json

Body

PatientID

integer

required

PatientLastName

string

required

PatientFirstName

string

required

DOB

string

required

Gender

string

required

Address1

string

required

Address2

string

required

City

string

required

State

string

required

Zipcode

string

required

HomePhone

string

required

WorkPhone

string

required

CellPhone

string

required

RxDetail

array [object {26}]

required

RxNumber

number

required

WrittenDate

string

required

LastFilledDate

string

required

Drug

string

required

DrugNDC

string

required

QtyOrdered

integer

required

QtyFilled

integer

required

RefillAuthorized

integer

required

RefillRemaining

integer

required

RefillDueDate

string

required

Days

integer

required

SigDirection

string

required

DoctorLastName

string

required

DoctorFirstName

string

required

DoctorAddress1

string

required

DoctorAddress2

string

required

DoctorCity

string

required

DoctorState

string

required

DoctorZipcode

string

required

DoctorPhone

string

required

DoctorFax

string

required

RxStatus

string

required

PatientPay

number

required

Total

number

required

WorkflowStatus

enum<integer>

required

Allowed values:

-101234567891011121314151617181920212223242526272829303334

Example:

WorkflowStatusText

string

required

Example:

Ready for Pickup

Example

{
    "PatientID": 12345,
    "PatientLastName": "SMITH",
    "PatientFirstName": "JOHN",
    "DOB": "1990-12-31T00:00:00Z",
    "Gender": "M",
    "Address1": "2625 BUTTERFIELD ROAD",
    "Address2": "SUITE 200S",
    "City": "OAK BROOK",
    "State": "IL",
    "Zipcode": "60523",
    "HomePhone": "6303393171",
    "WorkPhone": "8777775758",
    "CellPhone": "8777775758",
    "RxDetail": [
        {
            "RxNumber": 100001,
            "WrittenDate": "2024-05-15T00:00:00Z",
            "LastFilledDate": "2024-05-15T00:00:00Z",
            "Drug": "ALENDRONATE SOD TAB 5MG MYL",
            "DrugNDC": "00378-3566-01",
            "QtyOrdered": 30,
            "QtyFilled": 30,
            "RefillAuthorized": 5,
            "RefillRemaining": 5,
            "RefillDueDate": "2024-06-09T00:00:00Z",
            "Days": 30,
            "SigDirection": "TAKE 1 TABLET DAILY",
            "DoctorLastName": "ROBERT",
            "DoctorFirstName": "GRIFFIN",
            "DoctorAddress1": "1234 INDIGO LN SUITE 303",
            "DoctorAddress2": "SUITE 123",
            "DoctorCity": "WOODSTOCK",
            "DoctorState": "IL",
            "DoctorZipcode": "60098-3608",
            "DoctorPhone": "630-555-2222",
            "DoctorFax": "866-264-4132",
            "RxStatus": "Transmitted",
            "PatientPay": null,
            "Total": null,
            "WorkflowStatus": 1,
            "WorkflowStatusText": "Ready for Pickup"
        },
        {
            "RxNumber": 100002,
            "WrittenDate": "2024-05-15T00:00:00Z",
            "LastFilledDate": "2024-05-15T00:00:00Z",
            "Drug": "LISINOPRIL 10MG TABP",
            "DrugNDC": "63304-0533-01",
            "QtyOrdered": 30,
            "QtyFilled": 30,
            "RefillAuthorized": 5,
            "RefillRemaining": 5,
            "RefillDueDate": "2024-06-09T00:00:00Z",
            "Days": 30,
            "SigDirection": "TAKE 1 TABLET DAILY",
            "DoctorLastName": "ROBERT",
            "DoctorFirstName": "GRIFFIN",
            "DoctorAddress1": "1234 INDIGO LN SUITE 303",
            "DoctorAddress2": "SUITE 123",
            "DoctorCity": "WOODSTOCK",
            "DoctorState": "IL",
            "DoctorZipcode": "60098-3608",
            "DoctorPhone": "630-555-2222",
            "DoctorFax": "866-264-4132",
            "RxStatus": "Unbilled",
            "PatientPay": null,
            "Total": null,
            "WorkflowStatus": 0,
            "WorkflowStatusText": "Entered into System"
        },
        {
            "RxNumber": 100003,
            "WrittenDate": "2024-05-15T00:00:00Z",
            "LastFilledDate": "2024-05-15T00:00:00Z",
            "Drug": "METFORMIN 500MG TAB",
            "DrugNDC": "62037-0674-01",
            "QtyOrdered": 60,
            "QtyFilled": 60,
            "RefillAuthorized": 5,
            "RefillRemaining": 5,
            "RefillDueDate": "2024-07-09T00:00:00Z",
            "Days": 60,
            "SigDirection": "TAKE 1 TABLET DAILY",
            "DoctorLastName": "ROBERT",
            "DoctorFirstName": "GRIFFIN",
            "DoctorAddress1": "1234 INDIGO LN SUITE 303",
            "DoctorAddress2": "SUITE 123",
            "DoctorCity": "WOODSTOCK",
            "DoctorState": "IL",
            "DoctorZipcode": "60098-3608",
            "DoctorPhone": "630-555-2222",
            "DoctorFax": "866-264-4132",
            "RxStatus": "Hold",
            "PatientPay": null,
            "Total": null,
            "WorkflowStatus": 24,
            "WorkflowStatusText": "On Hold"
        },
        {
            "RxNumber": 100004,
            "WrittenDate": "2024-05-15T00:00:00Z",
            "LastFilledDate": "2024-05-15T00:00:00Z",
            "Drug": "SIMVASTATIN TABS 10 MG ACC",
            "DrugNDC": "16729-0004-17",
            "QtyOrdered": 30,
            "QtyFilled": 30,
            "RefillAuthorized": 5,
            "RefillRemaining": 5,
            "RefillDueDate": "2024-06-09T00:00:00Z",
            "Days": 30,
            "SigDirection": "TAKE 1 TABLET DAILY",
            "DoctorLastName": "ROBERT",
            "DoctorFirstName": "GRIFFIN",
            "DoctorAddress1": "1234 INDIGO LN SUITE 303",
            "DoctorAddress2": "SUITE 123",
            "DoctorCity": "WOODSTOCK",
            "DoctorState": "IL",
            "DoctorZipcode": "60098-3608",
            "DoctorPhone": "630-555-2222",
            "DoctorFax": "866-264-4132",
            "RxStatus": "Paid - Cash",
            "PatientPay": null,
            "Total": null,
            "WorkflowStatus": 3,
            "WorkflowStatusText": "Picked Up"
        }
    ]
}

🟠400Bad Request