QCF Web API Guide

Quantum Communications Framework (QCF) Web API Guide

QS/1 Data Systems provides access to QS/1 NRx and PrimeCare pharmacy data via a set of RESTful HTTP services.

API Modules

Basic APIs
Premium APIs

Facility

Method	API	Description
GET	api/Facility/{systemID}/FacilityQuery?facilityID={facilityID}	Query the pharmacy system for detailed information for a facility

Pharmacy

Method	API	Description
GET	api/Pharmacy/{systemID}	[System Version] Retrieves the current version of the QS/1 pharmacy system
GET	api/Pharmacy/{systemID}/ConnectionInfo	Retrieves Pharmacy Connection Information
GET	api/Pharmacy/{systemID}/SiteData?storeNumber={storeNumber}	[Site Data] Retrieves site data from the QS/1 pharmacy system (Medical Expense Data)
GET	api/Pharmacy/{systemID}/Prescribers?doctorCode={doctorCode}&lastName={lastName}&firstName={firstName}	[Prescriber Query] Retrieves list of prescribers matching the given values. (Patient Profile)
GET	api/Pharmacy/{systemID}/PricePlans?Description={Description}&BIN={BIN}&PCN={PCN}	[Price Plan Query] Retrieves price plans from the QS/1 pharmacy system (Insurance). At least one filter/parameter must be specified.
GET	api/Pharmacy/{systemID}/Employees?lastName={lastName}&firstName={firstName}	[Employee Query] Search and retrieve all employee records matching given filters/parameters (partials allowed)

Patient

Method	API	Description
GET	api/Patient/{systemID}/Search?lastName={lastName}&firstName={firstName}&medicalRecNum={medicalRecNum}&dateOfBirth={dateOfBirth}	Search and retrieve all patient records matching given filters/parameters (partials allowed)
GET	api/Patient/{systemID}/Query?lastName={lastName}&medicalRecNum={medicalRecNum}&dateOfBirth={dateOfBirth}&SSN={SSN}	Query for a specific patient record. Input filters/parameters must match exactly - at least one filter must be specified*
POST	api/Patient/{systemID}/AdvancedQuery	Advanced query for a specific patient record. Any Input filters/parameters must match exactly. Set parameters to blank to exclude from query

RxProfile

Method	API	Description
GET	api/Patient/{systemID}/RxProfile?patientID={patientID}&daysInHistory={daysInHistory}&ActiveScriptsOnly={ActiveScriptsOnly}&IncludeShortTerm={IncludeShortTerm}	Retrieve listing of prescriptions on patient profile

RxQuery

Method	API	Description
GET	api/Orders/{systemID}/RxQuery	Query the pharmacy system for detailed information for one or more prescriptions (up to 35) for a single patient.

RxRequest

Method	API	Description
POST	api/Orders/{systemID}/RxRequest	Submit one or more prescription refill requests (up to 35).

Facility

Method	API	Description
GET	api/Facility/{systemID}/FacilityQuery?facilityID={facilityID}	Query the pharmacy system for detailed information for a facility

Pharmacy

Method	API	Description
GET	api/Pharmacy/{systemID}	[System Version] Retrieves the current version of the QS/1 pharmacy system
GET	api/Pharmacy/{systemID}/ConnectionInfo	Retrieves Pharmacy Connection Information
GET	api/Pharmacy/{systemID}/SiteData?storeNumber={storeNumber}	[Site Data] Retrieves site data from the QS/1 pharmacy system (Medical Expense Data)
GET	api/Pharmacy/{systemID}/Prescribers?doctorCode={doctorCode}&lastName={lastName}&firstName={firstName}	[Prescriber Query] Retrieves list of prescribers matching the given values. (Patient Profile)
GET	api/Pharmacy/{systemID}/PricePlans?Description={Description}&BIN={BIN}&PCN={PCN}	[Price Plan Query] Retrieves price plans from the QS/1 pharmacy system (Insurance). At least one filter/parameter must be specified.
GET	api/Pharmacy/{systemID}/Employees?lastName={lastName}&firstName={firstName}	[Employee Query] Search and retrieve all employee records matching given filters/parameters (partials allowed)

Patient

Method	API	Description
GET	api/Patient/{systemID}/Search?lastName={lastName}&firstName={firstName}&medicalRecNum={medicalRecNum}&dateOfBirth={dateOfBirth}	Search and retrieve all patient records matching given filters/parameters (partials allowed)
GET	api/Patient/{systemID}/Query?lastName={lastName}&medicalRecNum={medicalRecNum}&dateOfBirth={dateOfBirth}&SSN={SSN}	Query for a specific patient record. Input filters/parameters must match exactly - at least one filter must be specified*
POST	api/Patient/{systemID}/AdvancedQuery	Advanced query for a specific patient record. Any Input filters/parameters must match exactly. Set parameters to blank to exclude from query

RxProfile

Method	API	Description
GET	api/Patient/{systemID}/RxProfile?patientID={patientID}&daysInHistory={daysInHistory}&ActiveScriptsOnly={ActiveScriptsOnly}&IncludeShortTerm={IncludeShortTerm}	Retrieve listing of prescriptions on patient profile

RxQuery

Method	API	Description
GET	api/Orders/{systemID}/RxQuery	Query the pharmacy system for detailed information for one or more prescriptions (up to 35) for a single patient.

RxRequest

Method	API	Description
POST	api/Orders/{systemID}/RxRequest	Submit one or more prescription refill requests (up to 35).

OrderStatus

Method	API	Description
GET	api/Orders/{systemID}?patientID={patientID}&daysToReview={daysToReview}&rxNumber={rxNumber}&batchNumber={batchNumber}&includeProfiled={includeProfiled}	Get the Order Status for one or more orders using PatientID, RxNumber or Batch Number. [At least one must be specified]

RxUpdate

Method	API	Description
POST	api/Orders/{systemID}/RxUpdate	Updates Prescription on file.

PatientNotes

Method	API	Description
GET	api/Patient/{systemID}/PatientNotes?patientID={patientID}	Get list of patient notes for given patient.
POST	api/Patient/{systemID}/PatientNotes?patientID={patientID}	Add patient note for given patient.
PUT	api/Patient/{systemID}/PatientNotes/UpdateNote?patientID={patientID}&noteID={noteID}	Update patient note for given patient.
PUT	api/Patient/{systemID}/PatientNotes/DeactivatePatientNote?patientID={patientID}&noteID={noteID}	Deactivate patient note for patient.
PUT	api/Patient/{systemID}/PatientNotes/ReactivatePatientNote?patientID={patientID}&noteID={noteID}	Reactivate patient note for patient.

DrugQuery

Method	API	Description
GET	api/Clinical/{systemID}/DrugQuery?drugName={drugName}&drugNDC={drugNDC}&bShowActiveOnly={bShowActiveOnly}&bExcludeControlledDrugs={bExcludeControlledDrugs}	Retrieves list of drugs matching the drugname or NDC number.
GET	api/Clinical/{systemID}/DrugQuery/GetMonograph?drugCode={drugCode}&langCode={langCode}	Retrieves monograph that corresponds to the submitted Drug Code

Profile

Method	API	Description
GET	api/Patient/{systemID}/Profile?patientID={patientID}	Retrieve patient profile
POST	api/Patient/{systemID}/Profile	Create patient profile
PUT	api/Patient/{systemID}/Profile?patientID={patientID}	Update an existing patient profile

ExtendedProfile

Method	API	Description
GET	api/Patient/{systemID}/ExtendedProfile?patientID={patientID}	Retrieve extended patient profile

Allergies

Method	API	Description
GET	api/Patient/{systemID}/Profile/Allergies?patientID={patientID}	Retrieve listing of patient allergies on file

MedicalConditions

Method	API	Description
GET	api/Patient/{systemID}/Profile/MedicalConditions?patientID={patientID}&icdCode={icdCode}	Retrieve listing of patient medical conditions on file

Ancillary

Method	API	Description
GET	api/Patient/{systemID}/Profile/Ancillary?patientID={patientID}	Retrieve listing of ancillary records on file for a patient

Addresses

Method	API	Description
GET	api/Patient/{systemID}/Addresses?patientID={patientID}	Retrieve listing of patient delivery addresses on file
POST	api/Patient/{systemID}/Addresses	Creates a delivery address for a specific patient
PUT	api/Patient/{systemID}/Addresses	Updates a single delivery address for a specific patient

Insurance

Method	API	Description
GET	api/Patient/{systemID}/Insurance?patientID={patientID}	Retrieve listing of patient insurances on file
POST	api/Patient/{systemID}/Insurance	Add a new insurance method for a specific patient
PUT	api/Patient/{systemID}/Insurance	Update a single insurance policy for a specific patient

Household

Method	API	Description
GET	api/Patient/{systemID}/Household?patientID={patientID}	Retrieve Head of Household profile for a specific patient

Spouse

Method	API	Description
PUT	api/Patient/{systemID}/Household/Spouse	Update spouse profile on Head of Household record
POST	api/Patient/{systemID}/Household/Spouse	Add spouse profile to Head of Household record
DELETE	api/Patient/{systemID}/Household/Spouse?patientID={patientID}&spouseID={spouseID}	Delete spouse profile on a specific Head of Household record

FamilyMember

Method	API	Description
PUT	api/Patient/{systemID}/Household/FamilyMember	Update a single family member profile on Head of Household record
POST	api/Patient/{systemID}/Household/FamilyMember	Add a single family member profile to Head of Household record
DELETE	api/Patient/{systemID}/Household/FamilyMember?patientID={patientID}&familyMemberID={familyMemberID}	Delete family member profile on a specific Head of Household record

MedicalExpense

Method	API	Description
GET	api/Patient/{systemID}/MedicalExpense?patientID={patientID}&startDate={startDate}&endDate={endDate}	Retrieve medical expense data for a specific patient during the given date range.

Listings

Method	API	Description
GET	api/Listings/RelationshipToCardHolderList	[Relationship to Card Holder] Retrieve listing of valid Relationship To Card Holder values
GET	api/Listings/CoverageCodeList	[Coverage Code] Retrieve listing of valid Coverage Code values

PreAuthorization

Method	API	Description
GET	api/Payment/{systemID}/PreAuth?patientID={patientID}&paymentMethodID={paymentMethodID}&preAuthAmount={preAuthAmount}	Conduct a Pre-Authorization against a single credit card on file

PaymentMethods

Method	API	Description
GET	api/Payment/{systemID}/PaymentMethods?patientID={patientID}	Retrieve listing of patient payment methods on file
PUT	api/Payment/{systemID}/PaymentMethods?patientID={patientID}&paymentType={paymentType}&paymentMethodID={paymentMethodID}&orderNo={orderNo}	Update priority of a payment method for a patient

Checks

Method	API	Description
POST	api/Payment/{systemID}/PaymentMethods/Checks?patientID={patientID}&checkNumber={checkNumber}&checkAmount={checkAmount}	Add a single check to a Patient's Profile
DELETE	api/Payment/{systemID}/PaymentMethods/Checks?patientID={patientID}&checkNumber={checkNumber}&checkAmount={checkAmount}	Delete a single check from a Patient's Profile

PayrollDeductions

Method	API	Description
POST	api/Payment/{systemID}/PaymentMethods/PayrollDeductions	Add Payroll Deduction to a Patient's Profile
DELETE	api/Payment/{systemID}/PaymentMethods/PayrollDeductions?patientID={patientID}	Delete Payroll Deduction from a Patient's Profile

ChargeAccounts

Method	API	Description
POST	api/Payment/{systemID}/PaymentMethods/ChargeAccounts?patientID={patientID}&chargeAccountID={chargeAccountID}	Add Charge Account to a Patient's Profile
DELETE	api/Payment/{systemID}/PaymentMethods/ChargeAccounts?patientID={patientID}	Delete Charge Account from a Patient's Profile

ARChargeAccount

Method	API	Description
PUT	api/Payment/{systemID}/PaymentMethods/ARChargeAccount?chargeAccountID={chargeAccountID}	Update Charge Account - Only allows for update of Frozen, AutoPost and AccountLimit. *All other updates will be ignored
GET	api/Payment/{systemID}/PaymentMethods/ARChargeAccount?chargeAccountID={chargeAccountID}	Get Charge Account details
DELETE	api/Payment/{systemID}/PaymentMethods/ARChargeAccount?patientID={patientID}&balanceCheck={balanceCheck}	Delete Charge Account from patient record.

ARInvoice

Method	API	Description
GET	api/Payment/{systemID}/PaymentMethods/ARInvoice?chargeAccountID={chargeAccountID}	Get list of invoices for a charge account.
POST	api/Payment/{systemID}/PaymentMethods/ARInvoice/PostCharges?chargeAccountID={chargeAccountID}	Post charges to invoice.
POST	api/Payment/{systemID}/PaymentMethods/ARInvoice/PostPayments?chargeAccountID={chargeAccountID}	Post payments to invoice.
POST	api/Payment/{systemID}/PaymentMethods/ARInvoice/PostCredits?chargeAccountID={chargeAccountID}	Post charges to invoice.

RxExtendedQuery

Method	API	Description
GET	api/Orders/{systemID}/RxExtendedQuery	Query the pharmacy system for extended information for one or more prescriptions (up to 35) for a single patient.

Transaction

Method	API	Description
GET	api/Transaction/{systemID}/TransactionQuery?rx={rx}&sequenceNum={sequenceNum}	Query the pharmacy system for detailed information for a transaction
GET	api/Transaction/{systemID}/TransactionDeliveryQuery?rx={rx}&sequenceNum={sequenceNum}	Query the pharmacy system for delivery information for a transaction
GET	api/Transaction/{systemID}/TransactionSequenceQuery?rx={rx}&dateFilled={dateFilled}	Query the pharmacy system for the sequence number of a transaction
PUT	api/Transaction/{systemID}/TransactionUpdate	Update pickup information and signature on an existing transaction.

ECS

Method	API	Description
GET	api/ECS/{systemID}/ECSQuery?rxNumber={rxNumber}&sequenceNumber={sequenceNumber}	Gets ECS Data for a specified prescription number/transaction sequence number combination