OrderStatus
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]
Special Remarks
Statuses - Received, Processing, On Hold, Ready, Shipped/Picked up (*Look to DetailedStatus and PharmacyMessage for actual stage of processing)
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| systemID | The SystemID of the pharmacy system. |
Define this parameter in the request URI. |
| patientID | Unique Identifier for Patient - returns all orders linked to patient (optional) |
Define this parameter in the request URI. |
| daysToReview | Number of days to review in history. Default is 14. (optional) |
Define this parameter in the request URI. |
| rxNumber | Patient Rx Number - returns all orders linked to rx number (optional) |
Define this parameter in the request URI. |
| batchNumber | Unique Identifier for a series of orders - returns all orders in a single batch (optional) |
Define this parameter in the request URI. |
| includeProfiled | Include profiled scripts in listing. Default is 'N'. (Y/N) (optional) |
Define this parameter in the request URI. |
Response Codes
- OK (200)
- NotFound (404)
- InternalServerError (500)
Response Information
Response body formats
application/json, text/json
Sample:
[
{
"PatientID": "sample string 1",
"RxNumber": "sample string 2",
"BatchNum": "sample string 3",
"DateFilled": "sample string 4",
"LastStatusDate": "sample string 5",
"PatientName": "sample string 6",
"PrescriberName": "sample string 7",
"PrescriberId": "sample string 8",
"DispensedDrugName": "sample string 9",
"PrescribedDrugName": "sample string 10",
"Status": "sample string 11",
"DetailedStatus": "sample string 12",
"PharmacyMessage": "sample string 13",
"PatientAmount": 14.1,
"FullPrice": 15.1,
"TotalOrderAmount": 16.1,
"ShippedFeeAmount": 17.1,
"Location": "sample string 18",
"DueDate": "sample string 19",
"DueTime": "sample string 20",
"SubmittedDate": "sample string 21",
"SubmittedTime": "sample string 22",
"ShippedDate": "sample string 23",
"TrackingNumber": "sample string 24"
},
{
"PatientID": "sample string 1",
"RxNumber": "sample string 2",
"BatchNum": "sample string 3",
"DateFilled": "sample string 4",
"LastStatusDate": "sample string 5",
"PatientName": "sample string 6",
"PrescriberName": "sample string 7",
"PrescriberId": "sample string 8",
"DispensedDrugName": "sample string 9",
"PrescribedDrugName": "sample string 10",
"Status": "sample string 11",
"DetailedStatus": "sample string 12",
"PharmacyMessage": "sample string 13",
"PatientAmount": 14.1,
"FullPrice": 15.1,
"TotalOrderAmount": 16.1,
"ShippedFeeAmount": 17.1,
"Location": "sample string 18",
"DueDate": "sample string 19",
"DueTime": "sample string 20",
"SubmittedDate": "sample string 21",
"SubmittedTime": "sample string 22",
"ShippedDate": "sample string 23",
"TrackingNumber": "sample string 24"
},
{
"PatientID": "sample string 1",
"RxNumber": "sample string 2",
"BatchNum": "sample string 3",
"DateFilled": "sample string 4",
"LastStatusDate": "sample string 5",
"PatientName": "sample string 6",
"PrescriberName": "sample string 7",
"PrescriberId": "sample string 8",
"DispensedDrugName": "sample string 9",
"PrescribedDrugName": "sample string 10",
"Status": "sample string 11",
"DetailedStatus": "sample string 12",
"PharmacyMessage": "sample string 13",
"PatientAmount": 14.1,
"FullPrice": 15.1,
"TotalOrderAmount": 16.1,
"ShippedFeeAmount": 17.1,
"Location": "sample string 18",
"DueDate": "sample string 19",
"DueTime": "sample string 20",
"SubmittedDate": "sample string 21",
"SubmittedTime": "sample string 22",
"ShippedDate": "sample string 23",
"TrackingNumber": "sample string 24"
}
]
text/javascript
Sample:
[{"PatientID":"sample string 1","RxNumber":"sample string 2","BatchNum":"sample string 3","DateFilled":"sample string 4","LastStatusDate":"sample string 5","PatientName":"sample string 6","PrescriberName":"sample string 7","PrescriberId":"sample string 8","DispensedDrugName":"sample string 9","PrescribedDrugName":"sample string 10","Status":"sample string 11","DetailedStatus":"sample string 12","PharmacyMessage":"sample string 13","PatientAmount":14.1,"FullPrice":15.1,"TotalOrderAmount":16.1,"ShippedFeeAmount":17.1,"Location":"sample string 18","DueDate":"sample string 19","DueTime":"sample string 20","SubmittedDate":"sample string 21","SubmittedTime":"sample string 22","ShippedDate":"sample string 23","TrackingNumber":"sample string 24"},{"PatientID":"sample string 1","RxNumber":"sample string 2","BatchNum":"sample string 3","DateFilled":"sample string 4","LastStatusDate":"sample string 5","PatientName":"sample string 6","PrescriberName":"sample string 7","PrescriberId":"sample string 8","DispensedDrugName":"sample string 9","PrescribedDrugName":"sample string 10","Status":"sample string 11","DetailedStatus":"sample string 12","PharmacyMessage":"sample string 13","PatientAmount":14.1,"FullPrice":15.1,"TotalOrderAmount":16.1,"ShippedFeeAmount":17.1,"Location":"sample string 18","DueDate":"sample string 19","DueTime":"sample string 20","SubmittedDate":"sample string 21","SubmittedTime":"sample string 22","ShippedDate":"sample string 23","TrackingNumber":"sample string 24"},{"PatientID":"sample string 1","RxNumber":"sample string 2","BatchNum":"sample string 3","DateFilled":"sample string 4","LastStatusDate":"sample string 5","PatientName":"sample string 6","PrescriberName":"sample string 7","PrescriberId":"sample string 8","DispensedDrugName":"sample string 9","PrescribedDrugName":"sample string 10","Status":"sample string 11","DetailedStatus":"sample string 12","PharmacyMessage":"sample string 13","PatientAmount":14.1,"FullPrice":15.1,"TotalOrderAmount":16.1,"ShippedFeeAmount":17.1,"Location":"sample string 18","DueDate":"sample string 19","DueTime":"sample string 20","SubmittedDate":"sample string 21","SubmittedTime":"sample string 22","ShippedDate":"sample string 23","TrackingNumber":"sample string 24"}]
application/xml, text/xml
Sample:
<ArrayOfOrderStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
<OrderStatus>
<BatchNum>sample string 3</BatchNum>
<DateFilled>sample string 4</DateFilled>
<DetailedStatus>sample string 12</DetailedStatus>
<DispensedDrugName>sample string 9</DispensedDrugName>
<DueDate>sample string 19</DueDate>
<DueTime>sample string 20</DueTime>
<FullPrice>15.1</FullPrice>
<LastStatusDate>sample string 5</LastStatusDate>
<Location>sample string 18</Location>
<PatientAmount>14.1</PatientAmount>
<PatientID>sample string 1</PatientID>
<PatientName>sample string 6</PatientName>
<PharmacyMessage>sample string 13</PharmacyMessage>
<PrescribedDrugName>sample string 10</PrescribedDrugName>
<PrescriberId>sample string 8</PrescriberId>
<PrescriberName>sample string 7</PrescriberName>
<RxNumber>sample string 2</RxNumber>
<ShippedDate>sample string 23</ShippedDate>
<ShippedFeeAmount>17.1</ShippedFeeAmount>
<Status>sample string 11</Status>
<SubmittedDate>sample string 21</SubmittedDate>
<SubmittedTime>sample string 22</SubmittedTime>
<TotalOrderAmount>16.1</TotalOrderAmount>
<TrackingNumber>sample string 24</TrackingNumber>
</OrderStatus>
<OrderStatus>
<BatchNum>sample string 3</BatchNum>
<DateFilled>sample string 4</DateFilled>
<DetailedStatus>sample string 12</DetailedStatus>
<DispensedDrugName>sample string 9</DispensedDrugName>
<DueDate>sample string 19</DueDate>
<DueTime>sample string 20</DueTime>
<FullPrice>15.1</FullPrice>
<LastStatusDate>sample string 5</LastStatusDate>
<Location>sample string 18</Location>
<PatientAmount>14.1</PatientAmount>
<PatientID>sample string 1</PatientID>
<PatientName>sample string 6</PatientName>
<PharmacyMessage>sample string 13</PharmacyMessage>
<PrescribedDrugName>sample string 10</PrescribedDrugName>
<PrescriberId>sample string 8</PrescriberId>
<PrescriberName>sample string 7</PrescriberName>
<RxNumber>sample string 2</RxNumber>
<ShippedDate>sample string 23</ShippedDate>
<ShippedFeeAmount>17.1</ShippedFeeAmount>
<Status>sample string 11</Status>
<SubmittedDate>sample string 21</SubmittedDate>
<SubmittedTime>sample string 22</SubmittedTime>
<TotalOrderAmount>16.1</TotalOrderAmount>
<TrackingNumber>sample string 24</TrackingNumber>
</OrderStatus>
<OrderStatus>
<BatchNum>sample string 3</BatchNum>
<DateFilled>sample string 4</DateFilled>
<DetailedStatus>sample string 12</DetailedStatus>
<DispensedDrugName>sample string 9</DispensedDrugName>
<DueDate>sample string 19</DueDate>
<DueTime>sample string 20</DueTime>
<FullPrice>15.1</FullPrice>
<LastStatusDate>sample string 5</LastStatusDate>
<Location>sample string 18</Location>
<PatientAmount>14.1</PatientAmount>
<PatientID>sample string 1</PatientID>
<PatientName>sample string 6</PatientName>
<PharmacyMessage>sample string 13</PharmacyMessage>
<PrescribedDrugName>sample string 10</PrescribedDrugName>
<PrescriberId>sample string 8</PrescriberId>
<PrescriberName>sample string 7</PrescriberName>
<RxNumber>sample string 2</RxNumber>
<ShippedDate>sample string 23</ShippedDate>
<ShippedFeeAmount>17.1</ShippedFeeAmount>
<Status>sample string 11</Status>
<SubmittedDate>sample string 21</SubmittedDate>
<SubmittedTime>sample string 22</SubmittedTime>
<TotalOrderAmount>16.1</TotalOrderAmount>
<TrackingNumber>sample string 24</TrackingNumber>
</OrderStatus>
</ArrayOfOrderStatus>