BestRx Routing Service

https://developer.bestrxconnect.com/TestRoutingService

POST - AddUpdateAppointment

POST /AppointmentInvitation/AddUpdateAppointment

POST - GetAppointment

POST /AppointmentInvitation/GetAppointment

POST - ValidateAppointment

POST /AppointmentInvitation/ValidateAppointment

POST - SetAppointment

POST /AppointmentInvitation/SetAppointment

POST - CancelAppointment

POST /AppointmentInvitation/CancelAppointment

POST - PullAppointments

POST /AppointmentInvitation/PullAppointments

POST - UpdateAppointmentStatus

POST /AppointmentInvitation/UpdateAppointmentStatus

POST /AppointmentInvitation/AddUpdateAppointment

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

application/json

text/json

application/xml

text/xml

application/x-www-form-urlencoded

BestRx.Schedule.Common.Model.AppointmentInvitation.AddUpdateAppointmenRequestModel

Example:

{
    "PharmacyNumber": "",
    "Appointments": [
        {
            "AppointmentID": "",
            "RegistrationID": "",
            "RegistrationSource": "MakePlans",
            "PatientRecNo": 1,
            "LastName": "",
            "FirstName": "",
            "PatientDOB": "",
            "Address1": "",
            "Address2": "",
            "City": "",
            "State": "",
            "Zip": "",
            "Phone": "",
            "PatientEmail": "",
            "Language": "",
            "LinkExpDays": 1,
            "AppointmentStatus": "None"
        }
    ]
}

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BCSWeb.Model.ResponseGenericInfo[System.Collections.Generic.List[BestRx.Schedule.Common.Model.AppointmentInvitation.AddUpdateAppointmenResponseModel]]

Example:

{
    "Data": [
        {
            "IsAddUpdate": true,
            "AppointmentID": "",
            "RegistrationID": "",
            "RegistrationSource": "None",
            "PatientRecNo": 1,
            "ErrorMessage": ""
        }
    ],
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Error"
        }
    ]
}

POST /AppointmentInvitation/GetAppointment

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

application/json

text/json

application/xml

text/xml

application/x-www-form-urlencoded

BestRx.Schedule.Common.Model.AppointmentInvitation.AppointmentRequestModel

Example:

{
    "PharmacyNumber": "",
    "AppointmentID": "",
    "Language": ""
}

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BCSWeb.Model.ResponseGenericInfo[BestRx.Schedule.Common.Model.AppointmentInvitation.AppointmentResponseModel]

Example:

{
    "Data": {
        "AppointmentID": "",
        "PharmacyRecNo": 1,
        "PatientRecNo": 1,
        "RegistrationID": "",
        "RegistrationSource": "MakePlans",
        "PatientName": "",
        "LastName": "",
        "FirstName": "",
        "PatientDOB": "",
        "Address2": "",
        "Address1": "",
        "City": "",
        "State": "",
        "Zip": "",
        "Phone": "",
        "PatientEmail": "",
        "LinkExpiredDate": "",
        "AppointmentDate": "",
        "Language": "",
        "AppointmentStatus": "LinkSent"
    },
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Unknown"
        }
    ]
}

POST /AppointmentInvitation/ValidateAppointment

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

application/json

text/json

application/xml

text/xml

application/x-www-form-urlencoded

BestRx.Schedule.Common.Model.AppointmentInvitation.ValidateAppointmentRequestModel

Example:

{
    "LastName": "",
    "PatientDOB": "",
    "PharmacyNumber": "",
    "AppointmentID": "",
    "Language": ""
}

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BCSWeb.Model.ResponseGenericInfo[BestRx.Schedule.Common.Model.AppointmentInvitation.AppointmentResponseModel]

Example:

{
    "Data": {
        "AppointmentID": "",
        "PharmacyRecNo": 1,
        "PatientRecNo": 1,
        "RegistrationID": "",
        "RegistrationSource": "MakePlans",
        "PatientName": "",
        "LastName": "",
        "FirstName": "",
        "PatientDOB": "",
        "Address2": "",
        "Address1": "",
        "City": "",
        "State": "",
        "Zip": "",
        "Phone": "",
        "PatientEmail": "",
        "LinkExpiredDate": "",
        "AppointmentDate": "",
        "Language": "",
        "AppointmentStatus": "CancelAppointment"
    },
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Information"
        }
    ]
}

POST /AppointmentInvitation/SetAppointment

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

application/json

text/json

application/xml

text/xml

application/x-www-form-urlencoded

BestRx.Schedule.Common.Model.AppointmentInvitation.SetAppointmentRequestModel

Example:

{
    "BookingID": 1,
    "Covid19ServiceID": 1,
    "PharmacyNumber": "",
    "ResourceId": 1,
    "AppointmentID": "",
    "PatientRecNo": 1,
    "FirstName": "",
    "LastName": "",
    "BookingEmailID": "",
    "AppointmentFromDate": "",
    "AppointmentToDate": "",
    "SchedulingProvInfo": {
        "Provider": "MakePlans",
        "URL": "",
        "APIUser": "",
        "APIKey": "",
        "COVID19ServiceID": "",
        "COVID19PrivateServiceID": "",
        "UseCOVID19ServiceID": true,
        "Status": "InActive",
        "AllowWaitingList": true,
        "SignatureRequired": true,
        "LinkExpiryInDays": 1,
        "CAMyTurnEnable": true,
        "CAMYTurnLocationID": "",
        "PreferredVaccineOption": "AskButNotRequired",
        "PreferredVaccineLst": ""
    },
    "Language": ""
}

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BCSWeb.Model.ResponseGenericInfo[System.Int32]

Example:

{
    "Data": 1,
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Unknown"
        }
    ]
}

POST /AppointmentInvitation/CancelAppointment

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

application/json

text/json

application/xml

text/xml

application/x-www-form-urlencoded

BestRx.Schedule.Common.Model.AppointmentInvitation.AppointmentRequestModel

Example:

{
    "PharmacyNumber": "",
    "AppointmentID": "",
    "Language": ""
}

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BCSWeb.Model.ResponseGenericInfo[System.Boolean]

Example:

{
    "Data": true,
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Success"
        }
    ]
}

POST /AppointmentInvitation/PullAppointments

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

application/json

text/json

application/xml

text/xml

application/x-www-form-urlencoded

BestRxModel.PullAppointmenRequestModel

Example:

{
    "PharmacyNumber": "",
    "NoOfMessages": 1
}

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BCSWeb.Model.ResponseGenericInfo[System.Collections.Generic.List[BestRxModel.PullAppointmentResponseModel]]

Example:

{
    "Data": [
        {
            "AppointmentID": "",
            "RegistrationID": "",
            "SchedulingProvider": 1,
            "PatientRecNo": 1,
            "AppointmentStatus": "LinkOpened",
            "AppointmentDate": "",
            "SchedulingID": "",
            "Covid19ServiceID": 1,
            "Language": ""
        }
    ],
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Success"
        }
    ]
}

POST /AppointmentInvitation/UpdateAppointmentStatus

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

application/json

text/json

application/xml

text/xml

application/x-www-form-urlencoded

BestRxModel.UpdateAppointmentStatusRequestModel

Example:

{
    "PharmacyNumber": "",
    "Appointments": [
        {
            "AppointmentID": "",
            "IsUpdatedToPharmacy": true,
            "ErrorMessage": ""
        }
    ]
}

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BCSWeb.Model.ResponseGenericInfo[System.Boolean]

Example:

{
    "Data": true,
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Error"
        }
    ]
}

POST - CreatePatientMessage

POST /Message/CreatePatientMessage

POST - PullPatientMessages

POST /Message/PullPatientMessages

POST - UpdateMessageStatus

POST /Message/UpdateMessageStatus

POST - GetComorbidityStatuses

GET /Message/GetComorbidityStatuses

POST - GetQuestionnaires

GET /Message/GetQuestionnaires

POST /Message/CreatePatientMessage

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

application/json

text/json

application/x-www-form-urlencoded

BestRxRoutingService.Model.Message.CreatePatientMessageRequestInfo

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BestRxModel.ResponseGenericInfo[System.Boolean]

POST /Message/PullPatientMessages

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

application/json

text/json

application/xml

text/xml

application/x-www-form-urlencoded

BestRxModel.PullMsgListRequest

Responses

200 200

OK

Body

application/json

text/json

BestRxModel.ResponseGenericInfo[System.Collections.Generic.List[BestRxModel.PullPatientMessageInfo]]

POST /Message/UpdateMessageStatus

Request parameters

NPI

string required

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

application/json

text/json

application/xml

text/xml

application/x-www-form-urlencoded

Array of BestRxModel.UpdateMessageRequestInfo

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BestRxModel.ResponseGenericInfo[BestRxModel.UpdateMessageStatusResponse]

GET /Message/GetComorbidityStatuses

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BestRxModel.ResponseGenericInfo[System.Collections.Generic.List[BestRxRoutingService.Model.ComorbidityStatusInfo]]

GET /Message/GetQuestionnaires

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BestRxModel.ResponseGenericInfo[System.Collections.Generic.List[BestRxRoutingService.Model.QuestionnairesResponse]]

POST - PullMessages

POST /api/Pharmacy/PullMessages

POST - SendResponseToPrescriber

POST /api/Pharmacy/SendResponseToPrescriber

POST - SendResponseToWenoPrescriber

POST /api/Pharmacy/SendResponseToWenoPrescriber

POST - UpdateMyTurnInfo

POST /api/Pharmacy/UpdateMyTurnInfo

POST /api/Pharmacy/PullMessages

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

application/json

text/json

application/xml

text/xml

application/x-www-form-urlencoded

BestRxModel.eRxRoutingPullMsgRequest

Example:

{
    "NPI": "",
    "LastReadMsgID": 1,
    "eRxServiceProvider": "PrescriberConnection"
}

Responses

200 200

OK

Body

application/json

text/json

Object

POST /api/Pharmacy/SendResponseToPrescriber

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

Responses

200 200

OK

Body

application/json

text/json

Object

POST /api/Pharmacy/SendResponseToWenoPrescriber

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

Responses

200 200

OK

Body

application/json

text/json

Object

POST /api/Pharmacy/UpdateMyTurnInfo

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

application/json

text/json

application/xml

text/xml

application/x-www-form-urlencoded

BestRx.Schedule.Common.Model.UpdayeMyTurnInfoRequest

Example:

{
    "PharmacyNumber": "",
    "LocationId": "",
    "ExcludeFromSearch": true
}

Responses

200 200

OK

Body

application/json

text/json

Object

POST - GetMessage

POST /api/PrescriberConnection

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

Responses

200 200

OK

Body

application/json

text/json

Object

POST - IsSchedulingServiceActive

POST /Scheduler/IsSchedulingServiceActive

POST - GetService

POST /Scheduler/GetService

POST - GetAvailableTimeSlot

POST /Scheduler/GetAvailableTimeSlot

POST - GetAppointmentDays

POST /Scheduler/GetAppointmentDays

POST - SetAppointment

POST /Scheduler/SetAppointment

POST - UpdateAppointment

POST /Scheduler/UpdateAppointment

POST - ConfirmAppointment

POST /Scheduler/ConfirmAppointment

POST - CancelAppointment

POST /Scheduler/CancelAppointment

POST - CancelOldBooking

POST /Scheduler/CancelOldBooking

POST /Scheduler/IsSchedulingServiceActive

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

application/json

text/json

application/xml

text/xml

application/x-www-form-urlencoded

BCSWeb.Model.AppointmentProviderRequestInfo

Example:

{
    "Provider": "MakePlans",
    "URL": "",
    "APIUser": "",
    "APIKey": "",
    "COVID19ServiceID": "",
    "COVID19PrivateServiceID": "",
    "UseCOVID19ServiceID": true,
    "Status": "InActive",
    "AllowWaitingList": true,
    "SignatureRequired": true,
    "LinkExpiryInDays": 1,
    "CAMyTurnEnable": true,
    "CAMYTurnLocationID": "",
    "PreferredVaccineOption": "AskAndRequired",
    "PreferredVaccineLst": ""
}

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BCSWeb.Model.ResponseGenericInfo[System.Boolean]

Example:

{
    "Data": true,
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Information"
        }
    ]
}

POST /Scheduler/GetService

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

application/json

text/json

application/xml

text/xml

application/x-www-form-urlencoded

BCSWeb.Model.AppointmentProviderRequestInfo

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BCSWeb.Model.ResponseGenericInfo[System.Collections.Generic.List[BestRx.Schedule.Common.Model.ServiceResponseModel]]

Example:

{
    "Data": [
        {
            "service": {
                "id": 1,
                "title": ""
            }
        }
    ],
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Error"
        }
    ]
}

POST /Scheduler/GetAvailableTimeSlot

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

application/json

text/json

application/xml

text/xml

application/x-www-form-urlencoded

BestRx.Schedule.Common.Model.AvailableSlotTimeRequestModel

Example:

{
    "schedulingprovinfo": {
        "Provider": "MakePlans",
        "URL": "",
        "APIUser": "",
        "APIKey": "",
        "COVID19ServiceID": "",
        "COVID19PrivateServiceID": "",
        "UseCOVID19ServiceID": true,
        "Status": "Active",
        "AllowWaitingList": true,
        "SignatureRequired": true,
        "LinkExpiryInDays": 1,
        "CAMyTurnEnable": true,
        "CAMYTurnLocationID": "",
        "PreferredVaccineOption": "DonotAsk",
        "PreferredVaccineLst": ""
    },
    "fromdate": "",
    "todate": "",
    "selectedresources": ""
}

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BCSWeb.Model.ResponseGenericInfo[BestRx.Schedule.Common.Model.AvailableSlotTimeResponseModel]

Example:

{
    "Data": {
        "listslot": [
            {
                "resource_id": "",
                "dtstarttimeslot": "",
                "dtendtimeslot": ""
            }
        ]
    },
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Warning"
        }
    ]
}

POST /Scheduler/GetAppointmentDays

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

application/json

text/json

application/xml

text/xml

application/x-www-form-urlencoded

BestRx.Schedule.Common.Model.AvailableSlotTimeRequestModel

Example:

{
    "schedulingprovinfo": {
        "Provider": "MakePlans",
        "URL": "",
        "APIUser": "",
        "APIKey": "",
        "COVID19ServiceID": "",
        "COVID19PrivateServiceID": "",
        "UseCOVID19ServiceID": true,
        "Status": "InActive",
        "AllowWaitingList": true,
        "SignatureRequired": true,
        "LinkExpiryInDays": 1,
        "CAMyTurnEnable": true,
        "CAMYTurnLocationID": "",
        "PreferredVaccineOption": "AskAndRequired",
        "PreferredVaccineLst": ""
    },
    "fromdate": "",
    "todate": "",
    "selectedresources": ""
}

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BCSWeb.Model.ResponseGenericInfo[System.Collections.Generic.List[System.String]]

Example:

{
    "Data": [
        ""
    ],
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Information"
        }
    ]
}

POST /Scheduler/SetAppointment

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

application/json

text/json

application/xml

text/xml

application/x-www-form-urlencoded

BestRx.Schedule.Common.Model.BookingRequestModel

Example:

{
    "pharmacynumber": "",
    "schedulingprovinfo": {
        "Provider": "MakePlans",
        "URL": "",
        "APIUser": "",
        "APIKey": "",
        "COVID19ServiceID": "",
        "COVID19PrivateServiceID": "",
        "UseCOVID19ServiceID": true,
        "Status": "Active",
        "AllowWaitingList": true,
        "SignatureRequired": true,
        "LinkExpiryInDays": 1,
        "CAMyTurnEnable": true,
        "CAMYTurnLocationID": "",
        "PreferredVaccineOption": "AskButNotRequired",
        "PreferredVaccineLst": ""
    },
    "SchedulingId": "",
    "makeplanbookingrequestmodel": {
        "booking[resource_id]": 1,
        "booking[service_id]": 1,
        "booking[booked_from]": "",
        "booking[booked_to]": "",
        "booking[person_attributes][id]": 1,
        "booking[person_attributes][name]": "",
        "booking[person_attributes][email]": "",
        "booking[person_attributes][phone_number]": "",
        "booking[person_attributes][phone_number_formatted]": "",
        "booking[person_attributes][date_of_birth]": "",
        "booking[person_attributes][street]": "",
        "booking[person_attributes][city]": "",
        "booking[person_attributes][postal_code]": "",
        "booking[person_attributes][state]": "",
        "booking[person_attributes][country_code]": "",
        "booking[person_attributes][notes]": "",
        "booking[public_booking]": true,
        "confirm": true
    }
}

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BCSWeb.Model.ResponseGenericInfo[BestRx.Schedule.Common.Model.BookingResponseModel]

Example:

{
    "Data": {
        "sessionid": "",
        "booking": {
            "id": 1,
            "service_id": 1,
            "person_id": 1,
            "booked_from": "",
            "booked_to": "",
            "created_at": "",
            "updated_at": "",
            "verification_code": {},
            "expires_at": {},
            "count": 1,
            "notes": {},
            "resource_id": 1,
            "reminder_at": {},
            "reminded_at": {},
            "paid_at": {},
            "external_id": {},
            "created_by": {},
            "updated_by": {},
            "state": "",
            "verification_method": {},
            "custom_data": {},
            "revision_count": 1,
            "paid_amount": {},
            "event_id": {},
            "collection_id": {},
            "invoiced_at": {},
            "title": {},
            "active": true,
            "person": {
                "id": 1,
                "email": "",
                "phonenumber": {},
                "created_at": "",
                "updated_at": "",
                "name": "",
                "custom_data": {},
                "date_of_birth": {},
                "external_id": {},
                "national_id_no": {},
                "street": {},
                "city": {},
                "postal_code": {},
                "state": {},
                "country_code": {},
                "notes": {},
                "phone_number": {}
            },
            "resource": {
                "id": 1,
                "title": "",
                "created_at": "",
                "updated_at": "",
                "capacity": 1,
                "opening_hours_mon": [
                    ""
                ],
                "opening_hours_tue": [
                    ""
                ],
                "opening_hours_wed": [
                    ""
                ],
                "opening_hours_thu": [
                    ""
                ],
                "opening_hours_fri": [
                    ""
                ],
                "opening_hours_sat": [
                    ""
                ],
                "opening_hours_sun": {},
                "custom_data": {},
                "open_0": "",
                "close_0": "",
                "open_1": "",
                "close_1": "",
                "open_2": "",
                "close_2": "",
                "open_3": "",
                "close_3": "",
                "open_4": "",
                "close_4": "",
                "open_5": "",
                "close_5": "",
                "open_6": {},
                "close_6": {}
            },
            "service": {
                "id": 1,
                "title": ""
            }
        }
    },
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Success"
        }
    ]
}

POST /Scheduler/UpdateAppointment

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

application/json

text/json

application/xml

text/xml

application/x-www-form-urlencoded

BestRx.Schedule.Common.Model.BookingRequestModel

Example:

{
    "pharmacynumber": "",
    "schedulingprovinfo": {
        "Provider": "None",
        "URL": "",
        "APIUser": "",
        "APIKey": "",
        "COVID19ServiceID": "",
        "COVID19PrivateServiceID": "",
        "UseCOVID19ServiceID": true,
        "Status": "InActive",
        "AllowWaitingList": true,
        "SignatureRequired": true,
        "LinkExpiryInDays": 1,
        "CAMyTurnEnable": true,
        "CAMYTurnLocationID": "",
        "PreferredVaccineOption": "AskButNotRequired",
        "PreferredVaccineLst": ""
    },
    "SchedulingId": "",
    "makeplanbookingrequestmodel": {
        "booking[resource_id]": 1,
        "booking[service_id]": 1,
        "booking[booked_from]": "",
        "booking[booked_to]": "",
        "booking[person_attributes][id]": 1,
        "booking[person_attributes][name]": "",
        "booking[person_attributes][email]": "",
        "booking[person_attributes][phone_number]": "",
        "booking[person_attributes][phone_number_formatted]": "",
        "booking[person_attributes][date_of_birth]": "",
        "booking[person_attributes][street]": "",
        "booking[person_attributes][city]": "",
        "booking[person_attributes][postal_code]": "",
        "booking[person_attributes][state]": "",
        "booking[person_attributes][country_code]": "",
        "booking[person_attributes][notes]": "",
        "booking[public_booking]": true,
        "confirm": true
    }
}

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BCSWeb.Model.ResponseGenericInfo[BestRx.Schedule.Common.Model.BookingResponseModel]

Example:

{
    "Data": {
        "sessionid": "",
        "booking": {
            "id": 1,
            "service_id": 1,
            "person_id": 1,
            "booked_from": "",
            "booked_to": "",
            "created_at": "",
            "updated_at": "",
            "verification_code": {},
            "expires_at": {},
            "count": 1,
            "notes": {},
            "resource_id": 1,
            "reminder_at": {},
            "reminded_at": {},
            "paid_at": {},
            "external_id": {},
            "created_by": {},
            "updated_by": {},
            "state": "",
            "verification_method": {},
            "custom_data": {},
            "revision_count": 1,
            "paid_amount": {},
            "event_id": {},
            "collection_id": {},
            "invoiced_at": {},
            "title": {},
            "active": true,
            "person": {
                "id": 1,
                "email": "",
                "phonenumber": {},
                "created_at": "",
                "updated_at": "",
                "name": "",
                "custom_data": {},
                "date_of_birth": {},
                "external_id": {},
                "national_id_no": {},
                "street": {},
                "city": {},
                "postal_code": {},
                "state": {},
                "country_code": {},
                "notes": {},
                "phone_number": {}
            },
            "resource": {
                "id": 1,
                "title": "",
                "created_at": "",
                "updated_at": "",
                "capacity": 1,
                "opening_hours_mon": [
                    ""
                ],
                "opening_hours_tue": [
                    ""
                ],
                "opening_hours_wed": [
                    ""
                ],
                "opening_hours_thu": [
                    ""
                ],
                "opening_hours_fri": [
                    ""
                ],
                "opening_hours_sat": [
                    ""
                ],
                "opening_hours_sun": {},
                "custom_data": {},
                "open_0": "",
                "close_0": "",
                "open_1": "",
                "close_1": "",
                "open_2": "",
                "close_2": "",
                "open_3": "",
                "close_3": "",
                "open_4": "",
                "close_4": "",
                "open_5": "",
                "close_5": "",
                "open_6": {},
                "close_6": {}
            },
            "service": {
                "id": 1,
                "title": ""
            }
        }
    },
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Unknown"
        }
    ]
}

POST /Scheduler/ConfirmAppointment

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

application/json

text/json

application/xml

text/xml

application/x-www-form-urlencoded

BestRx.Schedule.Common.Model.BookingRequestModel

Example:

{
    "pharmacynumber": "",
    "schedulingprovinfo": {
        "Provider": "MakePlans",
        "URL": "",
        "APIUser": "",
        "APIKey": "",
        "COVID19ServiceID": "",
        "COVID19PrivateServiceID": "",
        "UseCOVID19ServiceID": true,
        "Status": "InActive",
        "AllowWaitingList": true,
        "SignatureRequired": true,
        "LinkExpiryInDays": 1,
        "CAMyTurnEnable": true,
        "CAMYTurnLocationID": "",
        "PreferredVaccineOption": "AskAndRequired",
        "PreferredVaccineLst": ""
    },
    "SchedulingId": "",
    "makeplanbookingrequestmodel": {
        "booking[resource_id]": 1,
        "booking[service_id]": 1,
        "booking[booked_from]": "",
        "booking[booked_to]": "",
        "booking[person_attributes][id]": 1,
        "booking[person_attributes][name]": "",
        "booking[person_attributes][email]": "",
        "booking[person_attributes][phone_number]": "",
        "booking[person_attributes][phone_number_formatted]": "",
        "booking[person_attributes][date_of_birth]": "",
        "booking[person_attributes][street]": "",
        "booking[person_attributes][city]": "",
        "booking[person_attributes][postal_code]": "",
        "booking[person_attributes][state]": "",
        "booking[person_attributes][country_code]": "",
        "booking[person_attributes][notes]": "",
        "booking[public_booking]": true,
        "confirm": true
    }
}

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BCSWeb.Model.ResponseGenericInfo[BestRx.Schedule.Common.Model.BookingResponseModel]

Example:

{
    "Data": {
        "sessionid": "",
        "booking": {
            "id": 1,
            "service_id": 1,
            "person_id": 1,
            "booked_from": "",
            "booked_to": "",
            "created_at": "",
            "updated_at": "",
            "verification_code": {},
            "expires_at": {},
            "count": 1,
            "notes": {},
            "resource_id": 1,
            "reminder_at": {},
            "reminded_at": {},
            "paid_at": {},
            "external_id": {},
            "created_by": {},
            "updated_by": {},
            "state": "",
            "verification_method": {},
            "custom_data": {},
            "revision_count": 1,
            "paid_amount": {},
            "event_id": {},
            "collection_id": {},
            "invoiced_at": {},
            "title": {},
            "active": true,
            "person": {
                "id": 1,
                "email": "",
                "phonenumber": {},
                "created_at": "",
                "updated_at": "",
                "name": "",
                "custom_data": {},
                "date_of_birth": {},
                "external_id": {},
                "national_id_no": {},
                "street": {},
                "city": {},
                "postal_code": {},
                "state": {},
                "country_code": {},
                "notes": {},
                "phone_number": {}
            },
            "resource": {
                "id": 1,
                "title": "",
                "created_at": "",
                "updated_at": "",
                "capacity": 1,
                "opening_hours_mon": [
                    ""
                ],
                "opening_hours_tue": [
                    ""
                ],
                "opening_hours_wed": [
                    ""
                ],
                "opening_hours_thu": [
                    ""
                ],
                "opening_hours_fri": [
                    ""
                ],
                "opening_hours_sat": [
                    ""
                ],
                "opening_hours_sun": {},
                "custom_data": {},
                "open_0": "",
                "close_0": "",
                "open_1": "",
                "close_1": "",
                "open_2": "",
                "close_2": "",
                "open_3": "",
                "close_3": "",
                "open_4": "",
                "close_4": "",
                "open_5": "",
                "close_5": "",
                "open_6": {},
                "close_6": {}
            },
            "service": {
                "id": 1,
                "title": ""
            }
        }
    },
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Error"
        }
    ]
}

POST /Scheduler/CancelAppointment

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

application/json

text/json

application/xml

text/xml

application/x-www-form-urlencoded

BestRx.Schedule.Common.Model.CancelBookingRequestModel

Example:

{
    "pharmacynumber": "",
    "schedulingprovinfo": {
        "Provider": "None",
        "URL": "",
        "APIUser": "",
        "APIKey": "",
        "COVID19ServiceID": "",
        "COVID19PrivateServiceID": "",
        "UseCOVID19ServiceID": true,
        "Status": "InActive",
        "AllowWaitingList": true,
        "SignatureRequired": true,
        "LinkExpiryInDays": 1,
        "CAMyTurnEnable": true,
        "CAMYTurnLocationID": "",
        "PreferredVaccineOption": "AskButNotRequired",
        "PreferredVaccineLst": ""
    },
    "schedulingid": ""
}

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BCSWeb.Model.ResponseGenericInfo[BestRx.Schedule.Common.Model.BookingResponseModel]

Example:

{
    "Data": {
        "sessionid": "",
        "booking": {
            "id": 1,
            "service_id": 1,
            "person_id": 1,
            "booked_from": "",
            "booked_to": "",
            "created_at": "",
            "updated_at": "",
            "verification_code": {},
            "expires_at": {},
            "count": 1,
            "notes": {},
            "resource_id": 1,
            "reminder_at": {},
            "reminded_at": {},
            "paid_at": {},
            "external_id": {},
            "created_by": {},
            "updated_by": {},
            "state": "",
            "verification_method": {},
            "custom_data": {},
            "revision_count": 1,
            "paid_amount": {},
            "event_id": {},
            "collection_id": {},
            "invoiced_at": {},
            "title": {},
            "active": true,
            "person": {
                "id": 1,
                "email": "",
                "phonenumber": {},
                "created_at": "",
                "updated_at": "",
                "name": "",
                "custom_data": {},
                "date_of_birth": {},
                "external_id": {},
                "national_id_no": {},
                "street": {},
                "city": {},
                "postal_code": {},
                "state": {},
                "country_code": {},
                "notes": {},
                "phone_number": {}
            },
            "resource": {
                "id": 1,
                "title": "",
                "created_at": "",
                "updated_at": "",
                "capacity": 1,
                "opening_hours_mon": [
                    ""
                ],
                "opening_hours_tue": [
                    ""
                ],
                "opening_hours_wed": [
                    ""
                ],
                "opening_hours_thu": [
                    ""
                ],
                "opening_hours_fri": [
                    ""
                ],
                "opening_hours_sat": [
                    ""
                ],
                "opening_hours_sun": {},
                "custom_data": {},
                "open_0": "",
                "close_0": "",
                "open_1": "",
                "close_1": "",
                "open_2": "",
                "close_2": "",
                "open_3": "",
                "close_3": "",
                "open_4": "",
                "close_4": "",
                "open_5": "",
                "close_5": "",
                "open_6": {},
                "close_6": {}
            },
            "service": {
                "id": 1,
                "title": ""
            }
        }
    },
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Success"
        }
    ]
}

POST /Scheduler/CancelOldBooking

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

Responses

200 200

OK

Body

application/json

text/json

application/xml

text/xml

BCSWeb.Model.ResponseGenericInfo[System.Boolean]

Example:

{
    "Data": true,
    "IsValid": true,
    "Messages": [
        {
            "MessageCode": "",
            "Message": "",
            "MessageType": "Information"
        }
    ]
}

POST - SubmitRequest

POST /Surescripts/SubmitRequest

POST - SubmitRTPBRequest

POST /Surescripts/SubmitRTPBRequest

POST /Surescripts/SubmitRequest

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

Responses

200 200

OK

Body

application/json

text/json

Object

POST /Surescripts/SubmitRTPBRequest

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

Responses

200 200

OK

Body

application/json

text/json

Object

POST - GetMessage

POST /api/WenoExchange

Request headers

Authorization

string optional

Basic Auth

x-access-token

string optional

Access Token

x-device-serial-no

string optional

Device Serial Number

Request body

Responses

200 200

OK

Body

application/json

text/json

Object

PharmacyNumber

string

Appointments

Array of BestRx.Schedule.Common.Model.AppointmentModel

Object

AppointmentID

string

RegistrationID

string

RegistrationSource

string

Enumeration:

None

MakePlans

PatientRecNo

integer int32

LastName

string

FirstName

string

PatientDOB

string date-time

Address1

string

Address2

string

City

string

State

string

Zip

string

Phone

string

PatientEmail

string

Language

string

LinkExpDays

integer int32

AppointmentStatus

string

Enumeration:

None

LinkSent

LinkReSent

LinkOpened

Scheduled

CancelAppointment

LinkExpired

Object

Data

Array of BestRx.Schedule.Common.Model.AppointmentInvitation.AddUpdateAppointmenResponseModel

IsValid

boolean

Messages

Array of BCSWeb.Model.MessageInfo

Object

IsAddUpdate

boolean

AppointmentID

string

RegistrationID

string

RegistrationSource

string

Enumeration:

None

MakePlans

PatientRecNo

integer int32

ErrorMessage

string

Object

MessageCode

string

Message

string

MessageType

string

Enumeration:

Information

Warning

Error

Success

Unknown

Object

PharmacyNumber

string

AppointmentID

string

Language

string

Object

Data

BestRx.Schedule.Common.Model.AppointmentInvitation.AppointmentResponseModel

IsValid

boolean

Messages

Array of BCSWeb.Model.MessageInfo

Object

AppointmentID

string

PharmacyRecNo

integer int32

PatientRecNo

integer int32

RegistrationID

string

RegistrationSource

string

Enumeration:

None

MakePlans

PatientName

string

LastName

string

FirstName

string

PatientDOB

string date-time

Address2

string

Address1

string

City

string

State

string

Zip

string

Phone

string

PatientEmail

string

LinkExpiredDate

string date-time

AppointmentDate

string date-time

Language

string

AppointmentStatus

string

Enumeration:

None

LinkSent

LinkReSent

LinkOpened

Scheduled

CancelAppointment

LinkExpired

Object

LastName

string

PatientDOB

string date-time

PharmacyNumber

string

AppointmentID

string

Language

string

Object

BookingID

integer int32

Covid19ServiceID

integer int32

PharmacyNumber

string

ResourceId

integer int32

AppointmentID

string

PatientRecNo

integer int32

FirstName

string

LastName

string

BookingEmailID

string

AppointmentFromDate

string date-time

AppointmentToDate

string date-time

SchedulingProvInfo

BCSWeb.Model.AppointmentProviderRequestInfo

Language

string

Object

Provider

string

Enumeration:

None

MakePlans

URL

string

APIUser

string

APIKey

string

COVID19ServiceID

string

COVID19PrivateServiceID

string

UseCOVID19ServiceID

boolean

Status

string

Enumeration:

InActive

Active

AllowWaitingList

boolean

SignatureRequired

boolean

LinkExpiryInDays

integer int32

CAMyTurnEnable

boolean

CAMYTurnLocationID

string

PreferredVaccineOption

string

Enumeration:

DonotAsk

AskButNotRequired

AskAndRequired

PreferredVaccineLst

string

Object

Data

integer int32

IsValid

boolean

Messages

Array of BCSWeb.Model.MessageInfo

Object

Data

boolean

IsValid

boolean

Messages

Array of BCSWeb.Model.MessageInfo

Object

PharmacyNumber

string

NoOfMessages

integer int32

Object

Data

Array of BestRxModel.PullAppointmentResponseModel

IsValid

boolean

Messages

Array of BCSWeb.Model.MessageInfo

Object

AppointmentID

string

RegistrationID

string

SchedulingProvider

integer int32

PatientRecNo

integer int32

AppointmentStatus

string

Enumeration:

None

LinkSent

LinkReSent

LinkOpened

Scheduled

CancelAppointment

LinkExpired

AppointmentDate

string date-time

SchedulingID

string

Covid19ServiceID

integer int32

Language

string

Object

PharmacyNumber

string

Appointments

Array of BestRxModel.UpdateAppointmentstatusInfo

Object

AppointmentID

string

IsUpdatedToPharmacy

boolean

ErrorMessage

string

Object

NPI

string

RequestType

string

Enumeration:

None

PatientService

PatientInfo

BestRx.DataService.Model.RequestModel.COVIDImmunizationRegistrationInfo

Object

patient_comorbidities

Array of BestRx.DataService.Model.ResponseModel.ComorbidityStatusOptionInfo

patient_category

string

Enumeration:

EssentialWorker

FirstResponder

HealthcareWorker

PersonWithChronicCondition

ResidentOfACareFacilityOrOtherGroupSetting

IAmOver65

NoOfTheAbove

contact_choice

string

Enumeration:

Email

Phone

Both

patient_requested_dose

integer int32

preferred_vaccine_name

string

patient_vaccine_name

string

patient_second_dose_date

string date-time

appointmentfrom

string date-time

appointmentto

string date-time

Consent

boolean

patient_authorize_bill

boolean

patient_privacy_acknowledgement

boolean

questionnaires

Array of BestRxModel.COVIDQuestionaire

signature

string

language

string

signature_jsondata

string

PharmacyUniqueId

string

SchedulingID

string

SessionID

string

BookingEmailID

string

ResourceId

integer int32

StateAgeLimit

integer int32

SchedulingProvInfo

BCSWeb.Model.AppointmentProviderRequestInfo

GuardianMiddleName

string

GuardianFirstName

string

GuardianLastName

string

GuardianDateOfBirth

string date-time

GuardianGender

string

SameAsPatientAddress

boolean

GuardianAddress1

string

GuardianAddress2

string

GuardianCity

string

GuardianState

string

GuardianZip

string

GuardianType

string

GuardianPhone

string

PatientQueueRemarks

string

insurance_plans

Array of BestRx.DataService.Model.RequestModel.PatientInsuranceRequestModel

unique_patient_id

integer int32

allow_duplicate

boolean

relates_to_patient_id

integer int32

last_name

string

middle_name

string

first_name

string

name_prefix

string

name_suffix

string

dob

string date-time

gender

string

Enumeration:

M

F

address1

string

address2

string

city

string

state

string

county

string

zipcode

string

country_code

string

home_phone

string

work_phone

string

cell_phone

string

fax_number

string

family_email

string

patient_email

string

marital_status

string

Enumeration:

S

M

W

D

bill_last_name

string

bill_first_name

string

bill_address_careof

string

bill_address1

string

bill_address2

string

bill_address_city

string

bill_address_state

string

bill_address_zipcode

string

bill_phone

string

patient_id_qualifier

string

patient_id

string

social_security_number

string

smoker

boolean

loyalty_number

string

residence_code

string

dispense_by

string

Enumeration:

P

D

M

340B_patient

boolean

is_pet

boolean

pet_name

string

patient_short_remark

string

patient_remark

string

family_remark

string

is_active

boolean

is_deceased

boolean

patient_race

string

Enumeration:

Indigenous

Asian

AfricanAmerican

PacificIslander

White

Other

patient_ethnicity

string

Enumeration:

Hispanic

NonHispanic

Unknown

PharmacyNumber

string

PharmacyNCPDP

string

Object

comorbidity_status_selected

boolean

comorbidity_status

string

Enumeration:

Asthma

SeriousHeartCondition

LiverDisease

ChronicLungDisease

ChronicKidneyDisease

Diabetes

SevereObesity

Immunocompromised

Other

NoExistingConditions

other_comorbidity_detail

string

Object

QuestionUniqueID

string

QuestionText

string

QuestionType

string

Enumeration:

Screening

Immunization

QuestionSequence

integer int32

Answer

string

Enumeration:

DonotKnow

Yes

No

Object

ins_bin

string

ins_pcn

string

ins_code

string

ins_name

string

ins_address1

string

ins_address2

string

ins_city

string

ins_state

string

ins_zipcode

string

ins_phone

string

ins_remark

string

ins_fax_number

string

ins_alternate_phone

string

ins_email

string

ins_insurancegroupname

string

ins_seq_no

integer int32

ins_cardholder_id

string

ins_person_code

string

ins_relation_code

string

ins_group

string

ins_is_primary

boolean

Object

Data

boolean

IsValid

boolean

Messages

Array of BestRxModel.MessageInfo

Object

MessageCode

string

Message

string

MessageType

string

Enumeration:

Information

Warning

Error

Success

Unknown

Object

NPI

string

NoOfMessages

integer int32

RequestType

string

Enumeration:

None

PatientService

Object

Data

Array of BestRxModel.PullPatientMessageInfo

IsValid

boolean

Messages

Array of BestRxModel.MessageInfo

Object

MessageId

integer int64

PatientInfo

BestRxModel.PatientInfoRequestModel

Attempt

integer int32

Object

PAT_RECNO

integer int32

PAT_ParentRecordNo

integer int32

PAT_FamilyModel

BestRxModel.FamilyInfoRequestModel

PAT_LNAME

string

PAT_FMNAME

string

PAT_EMAIL

string

PAT_QCODE

string

PAT_DOB

string date-time

DOB

string date-time

PAT_GENDER

string

PAT_FAM_ZIP

string

PAT_MARITAL_STATUS

string

PAT_LOC_CD

string

PAT_SMOKER_IND

string

PAT_DISC_PCT

integer int32

PAT_ALG_CD2

integer int32

PAT_PRICE_CD

integer int32

PAT_REMARK1

string

PAT_REMARK2

string

PAT_WORK_PHONE

string

PAT_CELL_PHONE

string

PAT_DELIVERY

string

PAT_ID_QUAL

string

PAT_ID

string

PAT_SOC_SEC_NO

string

PAT_340B_IND

string

PAT_LOYALTY_NO

string

PAT_RESIDENCE_CODE

string

PAT_ALG_CD1

boolean

PAT_ANIMAL_NAME

string

PAT_MNAME

string

PAT_NAME_PREFIX

string

PAT_NAME_SUFFIX

string

AllowDuplicate

boolean

PAT_ACTIVE_IND

string

PAT_LANGUAGE

integer int32

PAT_FAM_BILLING_ADDRESS

BestRxModel.FamilyBillingRequestModel

PAT_PatientInsuranceModel

Array of BestRxModel.PatientInsuranceRequestModel

PAT_MSG_CD5

integer int32

PAT_PatientNHInfoModel

BestRxModel.PatientNHInfoRequestModel

PAT_RACE

integer int32

PAT_ETHNICITY

integer int32

PAT_COVIDImmunizationInfo

BestRxModel.COVIDImmunizationExtraInfo

ServiceProvider

string

IsValid

boolean

Messages

Array of BestRxModel.MessageInfo

Object

FAM_RECNO

integer int32

FAM_ISNEWRECORD

boolean

FAM_LNAME

string

FAM_FMNAME

string

FAM_ADDR

string

FAM_CITY

string

FAM_STATE

string

FAM_COUNTY

string

FAM_ZIP

string

FAM_COUNTRY

string

FAM_PHONE

string

FAM_FAX

string

FAM_EMAIL

string

FAM_ADDR2

string

FAM_REMARK

string

IsValid

boolean

Messages

Array of BestRxModel.MessageInfo

Object

FAMBIL_RECNO

integer int32

FAMBIL_LNAME

string

FAMBIL_FMNAME

string

FAMBIL_CARE_OF

string

FAMBIL_ADDR

string

FAMBIL_ADDR2

string

FAMBIL_CITY

string

FAMBIL_STATE

string

FAMBIL_ZIP

string

FAMBIL_PHONE

string

FAMBIL_CC_NO

string

FAMBIL_CC_EXPDT

string

IsValid

boolean

Messages

Array of BestRxModel.MessageInfo

Object

InsurancePlanModel

BestRxModel.InsurancePlanRequestModel

PATINS_PLAN_SEQNO

string

PATINS_CARD_ID

string

PATINS_PERSON_CD

string

PATINS_RELATION

string

PATINS_GROUP

string

PATINS_DEP_ELG

string

PATINS_COPAY_BRAND

number double

PATINS_COPAY_GEN

number double

PATINS_PLAN_ID

string

PATINS_FACILLITY_ID

string

PATINS_PRIMARY_IND

string

PATINS_OP_ID_QUAL

string

PATINS_OP_ID

string

IsValid

boolean

Messages

Array of BestRxModel.MessageInfo

Object

PATNH_RECNO

integer int32

PATNH_CODE

string

PATNH_FLOOR

string

PATNH_ROOM

string

PATNH_BED

string

PATNH_DOC_RECNO

integer int32

PATNH_ALLERGY

string

PATNH_DIAG

string

PATNH_DIET

string

PATNH_HEIGHT_FT

integer int32

PATNH_HEIGHT_IN

integer int32

PATNH_WEIGHT

integer int32

PATNH_ALT_DOC_RECNO

integer int32

PATNH_ADM_DT

string date-time

PATNH_DSCHG_DT

string date-time

PATNH_STANDING_ORDR1

string

PATNH_STANDING_ORDR2

string

PATNH_READMIT_DT

string date-time

Object

patient_comorbidities

Array of BestRxModel.ComorbidityStatusInfo

PatientCategory

string

Enumeration:

EssentialWorker

FirstResponder

HealthcareWorker

PersonWithChronicCondition

ResidentOfACareFacilityOrOtherGroupSetting

IAmOver65

NoOfTheAbove

ContactChoice

string

Enumeration:

Email

Phone

Both

PatientRequestedDose

integer int32

AppointmentDate

string date-time

Consent

string

PatientAuthorizeBill

string

PatientPrivacyAcknowledgement

string

Questionnaires

Array of BestRxModel.COVIDQuestionaire

Signature

string

Language

string

PatientQueueRemarks

string

PatientQueueMisc1

string

SchedulingID

string

SchedulingProvider

integer int32

StateAgeLimit

integer int32

Collection

Object

string

GuardianRecNo

integer int32

GuardianFirstName

string

GuardianLastName

string

GuardianDateOfBirth

string date-time

GuardianGender

string

SameAsPatientAddress

boolean

GuardianAddress1

string

GuardianAddress2

string

GuardianCity

string

GuardianState

string

GuardianZip

string

GuardianPhone

string

GuardianType

string

Object

INSPLAN_RECNO

integer int32

INSPLAN_CODE

string

INSPLAN_NAME

string

INSPLAN_ADDR

string

INSPLAN_CITY

string

INSPLAN_STATE

string

INSPLAN_ZIP

string

INSPLAN_PHONE

string

INSPLAN_PHARMACY_NO

string

INSPLAN_NCPDP_VER

string

INSPLAN_BIN_NO

string

INSPLAN_PROC_CNTL

string

INSPLAN_REMARK

string

INSPLAN_MULT_CLAIMS

boolean

INSPLAN_FAX

string

INSPLAN_ALT_PHONE1

string

INSPLAN_ALT_PHONE2

string

INSPLAN_EMAIL

string

INSPLAN_CASH_IND

boolean

INSPLAN_PROV_ID_QUAL

string

INSPLAN_GROUP

string

INSPLAN_ADDR2

string

IsValid

boolean

Messages

Array of BestRxModel.MessageInfo

Object

comorbidity_status

string

Enumeration:

Asthma

SeriousHeartCondition

LiverDisease

ChronicLungDisease

ChronicKidneyDisease

Diabetes

SevereObesity

Immunocompromised

Other

NoExistingConditions

other_comorbidity_detail

string

Object

MessageId

integer int64

IsUpdatedSuccessfully

boolean

ErrorMessage

string

Object

Data

BestRxModel.UpdateMessageStatusResponse

IsValid

boolean

Messages

Array of BestRxModel.MessageInfo

Object

IsMessageUpdate

boolean

IsMoreDataAvailable

boolean

Object

Data

Array of BestRxRoutingService.Model.ComorbidityStatusInfo

IsValid

boolean

Messages

Array of BestRxModel.MessageInfo

Object

Status

string

Enumeration:

Asthma

SeriousHeartCondition

LiverDisease

ChronicLungDisease

ChronicKidneyDisease

Diabetes

SevereObesity

Immunocompromised

Other

NoExistingConditions

Name

string

Object

Data

Array of BestRxRoutingService.Model.QuestionnairesResponse

IsValid

boolean

Messages

Array of BestRxModel.MessageInfo

Object

QuestionType

string

Enumeration:

Screening

Immunization

QuestionTypeText

string

Questionnaires

Array of BestRxModel.COVIDQuestionaire

Object

NPI

string

LastReadMsgID

integer int32

eRxServiceProvider

string

Enumeration:

PrescriberConnection

WenoExchange

Object

PharmacyNumber

string

LocationId

string

ExcludeFromSearch

boolean

Object

Data

Array of BestRx.Schedule.Common.Model.ServiceResponseModel

IsValid

boolean

Messages

Array of BCSWeb.Model.MessageInfo

Object

service

BestRx.Schedule.Common.Model.Service

Object

id

integer int64

title

string

Object

schedulingprovinfo

BCSWeb.Model.AppointmentProviderRequestInfo

fromdate

string date-time

todate

string date-time

selectedresources

string

Object

Data

BestRx.Schedule.Common.Model.AvailableSlotTimeResponseModel

IsValid

boolean

Messages

Array of BCSWeb.Model.MessageInfo

Object

listslot

Array of BestRx.Schedule.Common.Model.SlotDateTime

Object

resource_id

string

dtstarttimeslot

string date-time

dtendtimeslot

string date-time

Object

Data

Array of string

IsValid

boolean

Messages

Array of BCSWeb.Model.MessageInfo

Object

pharmacynumber

string

schedulingprovinfo

BCSWeb.Model.AppointmentProviderRequestInfo

SchedulingId

string

makeplanbookingrequestmodel

BestRx.Schedule.Common.Model.MakePlanBookingRequestModel

Object

booking[resource_id]

integer int32

booking[service_id]

integer int32

booking[booked_from]

string date-time

booking[booked_to]

string date-time

booking[person_attributes][id]

integer int32

booking[person_attributes][name]

string

booking[person_attributes][email]

string

booking[person_attributes][phone_number]

string

booking[person_attributes][phone_number_formatted]

string

booking[person_attributes][date_of_birth]

string

booking[person_attributes][street]

string

booking[person_attributes][city]

string

booking[person_attributes][postal_code]

string

booking[person_attributes][state]

string

booking[person_attributes][country_code]

string

booking[person_attributes][notes]

string

booking[public_booking]

boolean

confirm

boolean

Object

Data

BestRx.Schedule.Common.Model.BookingResponseModel

IsValid

boolean

Messages

Array of BCSWeb.Model.MessageInfo

Object

sessionid

string

booking

BestRx.Schedule.Common.Model.Booking

Object

id

integer int32

service_id

integer int32

person_id

integer int32

booked_from

string date-time

booked_to

string date-time

created_at

string date-time

updated_at

string date-time

verification_code

Object

expires_at

Object

count

integer int32

notes

Object

resource_id

integer int32

reminder_at

Object

reminded_at

Object

paid_at

Object

external_id

Object

created_by

Object

updated_by

Object

state

string

verification_method

Object

custom_data

Object

revision_count

integer int32

paid_amount

Object

event_id

Object

collection_id

Object

invoiced_at

Object

title

Object

active

boolean

person

BestRx.Schedule.Common.Model.Person

resource

BestRx.Schedule.Common.Model.Resource

service

BestRx.Schedule.Common.Model.Service

Object

id

integer int32

email

string

phonenumber

Object

created_at

string date-time

updated_at

string date-time

name

string

custom_data

Object

date_of_birth

Object

external_id

Object

national_id_no

Object

street

Object

city

Object

postal_code

Object

state

Object

country_code

Object

notes

Object

phone_number

Object

Object

id

integer int64

title

string

created_at

string date-time

updated_at

string date-time

capacity

integer int64

opening_hours_mon

Array

string date-time

opening_hours_tue

Array

string date-time

opening_hours_wed

Array

string date-time

opening_hours_thu

Array

string date-time

opening_hours_fri

Array

string date-time

opening_hours_sat

Array

string date-time

opening_hours_sun

Object

custom_data

Object

open_0

string date-time

close_0

string date-time

open_1

string date-time

close_1

string date-time

open_2

string date-time

close_2

string date-time

open_3

string date-time

close_3

string date-time

open_4

string date-time

close_4

string date-time

open_5

string date-time

close_5

string date-time

open_6

Object

close_6

Object

Object

pharmacynumber

string

schedulingprovinfo

BCSWeb.Model.AppointmentProviderRequestInfo

schedulingid

string