Home

RxIntake

POST api/Orders/{systemID}/RxIntake

Submit one or more RxIntakes (up to 35).

Special Remarks

RejectCode:
            [RP] - "Patient ID Required" 
            [NP] - "Patient Not Found"
            [RM] - "Medication Required" 
            [NM] - "Medication Not Found" 
            [RD] - "Prescriber ID Required" 
            [ND] - "Prescriber Not Found"
            [NA] - "At least one Workflow Queue is required in PMS"
            [DR] - "DocuTrack Authorization Required"
            [ER] - "General Error (See message for specific details about the error)"

Request Information

Parameters

NameDescriptionAdditional information
systemID 
Unique ID for system

Define this parameter in the request URI.
requests 
List of RxIntakes:
            PatientID - Unique identifier for patient (Required)
            PrescriberID - Unique identifier for prescriber (Required)
            DrugID - Unique identifer for medication (Required)
            StoreNumber - Specify store number if host/remote system (default = 0)
            EmployeeID - Unique identifier for employee
            DocumentID - Unique identifier for Document
            QuantityAuthorized - Quantity of medication (3 digit max),
            DaysSupply - Number of days supply (3 digit max),
            WrittenDate - Date Written (YYYYMMDD),
            DueDate - Date Rx Due (YYYYMMDD),
            DueTime - Time Rx Due (HHMM),
            FacilityIDCode - Unique identifier for facility,
            WorkflowNote - Workflow Note (50 characters)

Define this parameter in the request body.
    

Response Codes

    
  • OK (200)
  • BadRequest (400)
  • NotFound (404)
  • InternalServerError (500)
    •     

Request body formats

application/json, text/json

Sample: 
[
  {
    "StoreNumber": "sample string 1",
    "EmployeeID": "sample string 2",
    "PatientID": "sample string 3",
    "PrescriberID": "sample string 4",
    "DrugID": "sample string 5",
    "DocumentID": "sample string 6",
    "QuantityAuthorized": "sample string 7",
    "DaysSupply": "sample string 8",
    "WrittenDate": "sample string 9",
    "DueDate": "sample string 10",
    "DueTime": "sample string 11",
    "FacilityIDCode": "sample string 12",
    "WorkflowNote": "sample string 13"
  },
  {
    "StoreNumber": "sample string 1",
    "EmployeeID": "sample string 2",
    "PatientID": "sample string 3",
    "PrescriberID": "sample string 4",
    "DrugID": "sample string 5",
    "DocumentID": "sample string 6",
    "QuantityAuthorized": "sample string 7",
    "DaysSupply": "sample string 8",
    "WrittenDate": "sample string 9",
    "DueDate": "sample string 10",
    "DueTime": "sample string 11",
    "FacilityIDCode": "sample string 12",
    "WorkflowNote": "sample string 13"
  },
  {
    "StoreNumber": "sample string 1",
    "EmployeeID": "sample string 2",
    "PatientID": "sample string 3",
    "PrescriberID": "sample string 4",
    "DrugID": "sample string 5",
    "DocumentID": "sample string 6",
    "QuantityAuthorized": "sample string 7",
    "DaysSupply": "sample string 8",
    "WrittenDate": "sample string 9",
    "DueDate": "sample string 10",
    "DueTime": "sample string 11",
    "FacilityIDCode": "sample string 12",
    "WorkflowNote": "sample string 13"
  }
]

text/javascript

Sample: 
[{"StoreNumber":"sample string 1","EmployeeID":"sample string 2","PatientID":"sample string 3","PrescriberID":"sample string 4","DrugID":"sample string 5","DocumentID":"sample string 6","QuantityAuthorized":"sample string 7","DaysSupply":"sample string 8","WrittenDate":"sample string 9","DueDate":"sample string 10","DueTime":"sample string 11","FacilityIDCode":"sample string 12","WorkflowNote":"sample string 13"},{"StoreNumber":"sample string 1","EmployeeID":"sample string 2","PatientID":"sample string 3","PrescriberID":"sample string 4","DrugID":"sample string 5","DocumentID":"sample string 6","QuantityAuthorized":"sample string 7","DaysSupply":"sample string 8","WrittenDate":"sample string 9","DueDate":"sample string 10","DueTime":"sample string 11","FacilityIDCode":"sample string 12","WorkflowNote":"sample string 13"},{"StoreNumber":"sample string 1","EmployeeID":"sample string 2","PatientID":"sample string 3","PrescriberID":"sample string 4","DrugID":"sample string 5","DocumentID":"sample string 6","QuantityAuthorized":"sample string 7","DaysSupply":"sample string 8","WrittenDate":"sample string 9","DueDate":"sample string 10","DueTime":"sample string 11","FacilityIDCode":"sample string 12","WorkflowNote":"sample string 13"}]

application/xml, text/xml

Sample: 
<ArrayOfRxIntake xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
  <RxIntake>
    <DaysSupply>sample string 8</DaysSupply>
    <DocumentID>sample string 6</DocumentID>
    <DrugID>sample string 5</DrugID>
    <DueDate>sample string 10</DueDate>
    <DueTime>sample string 11</DueTime>
    <EmployeeID>sample string 2</EmployeeID>
    <FacilityIDCode>sample string 12</FacilityIDCode>
    <PatientID>sample string 3</PatientID>
    <PrescriberID>sample string 4</PrescriberID>
    <QuantityAuthorized>sample string 7</QuantityAuthorized>
    <StoreNumber>sample string 1</StoreNumber>
    <WorkflowNote>sample string 13</WorkflowNote>
    <WrittenDate>sample string 9</WrittenDate>
  </RxIntake>
  <RxIntake>
    <DaysSupply>sample string 8</DaysSupply>
    <DocumentID>sample string 6</DocumentID>
    <DrugID>sample string 5</DrugID>
    <DueDate>sample string 10</DueDate>
    <DueTime>sample string 11</DueTime>
    <EmployeeID>sample string 2</EmployeeID>
    <FacilityIDCode>sample string 12</FacilityIDCode>
    <PatientID>sample string 3</PatientID>
    <PrescriberID>sample string 4</PrescriberID>
    <QuantityAuthorized>sample string 7</QuantityAuthorized>
    <StoreNumber>sample string 1</StoreNumber>
    <WorkflowNote>sample string 13</WorkflowNote>
    <WrittenDate>sample string 9</WrittenDate>
  </RxIntake>
  <RxIntake>
    <DaysSupply>sample string 8</DaysSupply>
    <DocumentID>sample string 6</DocumentID>
    <DrugID>sample string 5</DrugID>
    <DueDate>sample string 10</DueDate>
    <DueTime>sample string 11</DueTime>
    <EmployeeID>sample string 2</EmployeeID>
    <FacilityIDCode>sample string 12</FacilityIDCode>
    <PatientID>sample string 3</PatientID>
    <PrescriberID>sample string 4</PrescriberID>
    <QuantityAuthorized>sample string 7</QuantityAuthorized>
    <StoreNumber>sample string 1</StoreNumber>
    <WorkflowNote>sample string 13</WorkflowNote>
    <WrittenDate>sample string 9</WrittenDate>
  </RxIntake>
</ArrayOfRxIntake>

Response Information

List of RxIntake Responses: PatientID; PrescriberID; DrugID; Status (A = Accepted R = Rejected); RejectCode; StatusMessage;

Response body formats

application/json, text/json

Sample: 
[
  {
    "PatientID": "sample string 1",
    "PrescriberID": "sample string 2",
    "DrugID": "sample string 3",
    "Status": "sample string 4",
    "RejectCode": "sample string 5",
    "StatusMessage": "sample string 6"
  },
  {
    "PatientID": "sample string 1",
    "PrescriberID": "sample string 2",
    "DrugID": "sample string 3",
    "Status": "sample string 4",
    "RejectCode": "sample string 5",
    "StatusMessage": "sample string 6"
  },
  {
    "PatientID": "sample string 1",
    "PrescriberID": "sample string 2",
    "DrugID": "sample string 3",
    "Status": "sample string 4",
    "RejectCode": "sample string 5",
    "StatusMessage": "sample string 6"
  }
]

text/javascript

Sample: 
[{"PatientID":"sample string 1","PrescriberID":"sample string 2","DrugID":"sample string 3","Status":"sample string 4","RejectCode":"sample string 5","StatusMessage":"sample string 6"},{"PatientID":"sample string 1","PrescriberID":"sample string 2","DrugID":"sample string 3","Status":"sample string 4","RejectCode":"sample string 5","StatusMessage":"sample string 6"},{"PatientID":"sample string 1","PrescriberID":"sample string 2","DrugID":"sample string 3","Status":"sample string 4","RejectCode":"sample string 5","StatusMessage":"sample string 6"}]

application/xml, text/xml

Sample: 
<ArrayOfRxIntakeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
  <RxIntakeResponse>
    <DrugID>sample string 3</DrugID>
    <PatientID>sample string 1</PatientID>
    <PrescriberID>sample string 2</PrescriberID>
    <RejectCode>sample string 5</RejectCode>
    <Status>sample string 4</Status>
    <StatusMessage>sample string 6</StatusMessage>
  </RxIntakeResponse>
  <RxIntakeResponse>
    <DrugID>sample string 3</DrugID>
    <PatientID>sample string 1</PatientID>
    <PrescriberID>sample string 2</PrescriberID>
    <RejectCode>sample string 5</RejectCode>
    <Status>sample string 4</Status>
    <StatusMessage>sample string 6</StatusMessage>
  </RxIntakeResponse>
  <RxIntakeResponse>
    <DrugID>sample string 3</DrugID>
    <PatientID>sample string 1</PatientID>
    <PrescriberID>sample string 2</PrescriberID>
    <RejectCode>sample string 5</RejectCode>
    <Status>sample string 4</Status>
    <StatusMessage>sample string 6</StatusMessage>
  </RxIntakeResponse>
</ArrayOfRxIntakeResponse>