RxQuery
GET api/Orders/{systemID}/RxQuery
Query the pharmacy system for detailed information for one or more prescriptions (up to 35) for a single patient.
Special Remarks
Response Codes:
Status:
[F] - Found, [D] - Discontinued, [N] - Not Found, [T] - Transferred, [I] - Invalid, [ES] - Expired Rx; [ER] - Early Refill; [NR] - No Refills
LastOrderStatus:
[R] - Ready, [N] - Not Ready, [D] - Delivered, [P] - Need to Speak to RPh
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| systemID | Unique ID for system |
Define this parameter in the request URI. |
| scripts | Array of rx numbers (e.g. scripts=12345678&scripts=12345678). [Required] |
Define this parameter in the request URI. |
Response Codes
- OK (200)
- BadRequest (400)
- NotFound (404)
- InternalServerError (500)
Response Information
List of Rx Scripts
Response body formats
application/json, text/json
Sample:
[
{
"RxNumber": "sample string 1",
"Status": "sample string 2",
"RefillsRemaining": 3,
"ExpirationDate": "sample string 4",
"LastFillDate": "sample string 5",
"DaysSupply": 6,
"DrugSchedule": "sample string 7",
"FillListIndicator": "sample string 8",
"PatientName": "sample string 9",
"Last4OfSSN": "sample string 10",
"Phone": "sample string 11",
"MedicalRecordNumber": "sample string 12",
"PatientDOB": "sample string 13",
"PatientGroup": "sample string 14",
"LastOrderStatus": "sample string 15",
"PRNIndicator": "sample string 16",
"ShortTermIndicator": "sample string 17",
"DrugName": "sample string 18",
"HOA": "sample string 19",
"HOAFrequency": "sample string 20"
},
{
"RxNumber": "sample string 1",
"Status": "sample string 2",
"RefillsRemaining": 3,
"ExpirationDate": "sample string 4",
"LastFillDate": "sample string 5",
"DaysSupply": 6,
"DrugSchedule": "sample string 7",
"FillListIndicator": "sample string 8",
"PatientName": "sample string 9",
"Last4OfSSN": "sample string 10",
"Phone": "sample string 11",
"MedicalRecordNumber": "sample string 12",
"PatientDOB": "sample string 13",
"PatientGroup": "sample string 14",
"LastOrderStatus": "sample string 15",
"PRNIndicator": "sample string 16",
"ShortTermIndicator": "sample string 17",
"DrugName": "sample string 18",
"HOA": "sample string 19",
"HOAFrequency": "sample string 20"
},
{
"RxNumber": "sample string 1",
"Status": "sample string 2",
"RefillsRemaining": 3,
"ExpirationDate": "sample string 4",
"LastFillDate": "sample string 5",
"DaysSupply": 6,
"DrugSchedule": "sample string 7",
"FillListIndicator": "sample string 8",
"PatientName": "sample string 9",
"Last4OfSSN": "sample string 10",
"Phone": "sample string 11",
"MedicalRecordNumber": "sample string 12",
"PatientDOB": "sample string 13",
"PatientGroup": "sample string 14",
"LastOrderStatus": "sample string 15",
"PRNIndicator": "sample string 16",
"ShortTermIndicator": "sample string 17",
"DrugName": "sample string 18",
"HOA": "sample string 19",
"HOAFrequency": "sample string 20"
}
]
text/javascript
Sample:
[{"RxNumber":"sample string 1","Status":"sample string 2","RefillsRemaining":3,"ExpirationDate":"sample string 4","LastFillDate":"sample string 5","DaysSupply":6,"DrugSchedule":"sample string 7","FillListIndicator":"sample string 8","PatientName":"sample string 9","Last4OfSSN":"sample string 10","Phone":"sample string 11","MedicalRecordNumber":"sample string 12","PatientDOB":"sample string 13","PatientGroup":"sample string 14","LastOrderStatus":"sample string 15","PRNIndicator":"sample string 16","ShortTermIndicator":"sample string 17","DrugName":"sample string 18","HOA":"sample string 19","HOAFrequency":"sample string 20"},{"RxNumber":"sample string 1","Status":"sample string 2","RefillsRemaining":3,"ExpirationDate":"sample string 4","LastFillDate":"sample string 5","DaysSupply":6,"DrugSchedule":"sample string 7","FillListIndicator":"sample string 8","PatientName":"sample string 9","Last4OfSSN":"sample string 10","Phone":"sample string 11","MedicalRecordNumber":"sample string 12","PatientDOB":"sample string 13","PatientGroup":"sample string 14","LastOrderStatus":"sample string 15","PRNIndicator":"sample string 16","ShortTermIndicator":"sample string 17","DrugName":"sample string 18","HOA":"sample string 19","HOAFrequency":"sample string 20"},{"RxNumber":"sample string 1","Status":"sample string 2","RefillsRemaining":3,"ExpirationDate":"sample string 4","LastFillDate":"sample string 5","DaysSupply":6,"DrugSchedule":"sample string 7","FillListIndicator":"sample string 8","PatientName":"sample string 9","Last4OfSSN":"sample string 10","Phone":"sample string 11","MedicalRecordNumber":"sample string 12","PatientDOB":"sample string 13","PatientGroup":"sample string 14","LastOrderStatus":"sample string 15","PRNIndicator":"sample string 16","ShortTermIndicator":"sample string 17","DrugName":"sample string 18","HOA":"sample string 19","HOAFrequency":"sample string 20"}]
application/xml, text/xml
Sample:
<ArrayOfRxScriptResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
<RxScriptResponse>
<DaysSupply>6</DaysSupply>
<DrugName>sample string 18</DrugName>
<DrugSchedule>sample string 7</DrugSchedule>
<ExpirationDate>sample string 4</ExpirationDate>
<FillListIndicator>sample string 8</FillListIndicator>
<HOA>sample string 19</HOA>
<HOAFrequency>sample string 20</HOAFrequency>
<Last4OfSSN>sample string 10</Last4OfSSN>
<LastFillDate>sample string 5</LastFillDate>
<LastOrderStatus>sample string 15</LastOrderStatus>
<MedicalRecordNumber>sample string 12</MedicalRecordNumber>
<PRNIndicator>sample string 16</PRNIndicator>
<PatientDOB>sample string 13</PatientDOB>
<PatientGroup>sample string 14</PatientGroup>
<PatientName>sample string 9</PatientName>
<Phone>sample string 11</Phone>
<RefillsRemaining>3</RefillsRemaining>
<RxNumber>sample string 1</RxNumber>
<ShortTermIndicator>sample string 17</ShortTermIndicator>
<Status>sample string 2</Status>
</RxScriptResponse>
<RxScriptResponse>
<DaysSupply>6</DaysSupply>
<DrugName>sample string 18</DrugName>
<DrugSchedule>sample string 7</DrugSchedule>
<ExpirationDate>sample string 4</ExpirationDate>
<FillListIndicator>sample string 8</FillListIndicator>
<HOA>sample string 19</HOA>
<HOAFrequency>sample string 20</HOAFrequency>
<Last4OfSSN>sample string 10</Last4OfSSN>
<LastFillDate>sample string 5</LastFillDate>
<LastOrderStatus>sample string 15</LastOrderStatus>
<MedicalRecordNumber>sample string 12</MedicalRecordNumber>
<PRNIndicator>sample string 16</PRNIndicator>
<PatientDOB>sample string 13</PatientDOB>
<PatientGroup>sample string 14</PatientGroup>
<PatientName>sample string 9</PatientName>
<Phone>sample string 11</Phone>
<RefillsRemaining>3</RefillsRemaining>
<RxNumber>sample string 1</RxNumber>
<ShortTermIndicator>sample string 17</ShortTermIndicator>
<Status>sample string 2</Status>
</RxScriptResponse>
<RxScriptResponse>
<DaysSupply>6</DaysSupply>
<DrugName>sample string 18</DrugName>
<DrugSchedule>sample string 7</DrugSchedule>
<ExpirationDate>sample string 4</ExpirationDate>
<FillListIndicator>sample string 8</FillListIndicator>
<HOA>sample string 19</HOA>
<HOAFrequency>sample string 20</HOAFrequency>
<Last4OfSSN>sample string 10</Last4OfSSN>
<LastFillDate>sample string 5</LastFillDate>
<LastOrderStatus>sample string 15</LastOrderStatus>
<MedicalRecordNumber>sample string 12</MedicalRecordNumber>
<PRNIndicator>sample string 16</PRNIndicator>
<PatientDOB>sample string 13</PatientDOB>
<PatientGroup>sample string 14</PatientGroup>
<PatientName>sample string 9</PatientName>
<Phone>sample string 11</Phone>
<RefillsRemaining>3</RefillsRemaining>
<RxNumber>sample string 1</RxNumber>
<ShortTermIndicator>sample string 17</ShortTermIndicator>
<Status>sample string 2</Status>
</RxScriptResponse>
</ArrayOfRxScriptResponse>