Home

RxProfile

GET api/Patient/{systemID}/RxProfile?patientID={patientID}&daysInHistory={daysInHistory}&ActiveScriptsOnly={ActiveScriptsOnly}&IncludeShortTerm={IncludeShortTerm}

Retrieve listing of prescriptions on patient profile

Request Information

Parameters

NameDescriptionAdditional information
systemID 
The SystemID of the pharmacy system.

Define this parameter in the request URI.
patientID 
Unique ID of patient in pharmacy system.

Define this parameter in the request URI.
daysInHistory 
Number of days in history [Default is 365]

Define this parameter in the request URI.
ActiveScriptsOnly 
Return only active scripts on the profile [Default is 'True']

Define this parameter in the request URI.
IncludeShortTerm 
Return short cycle scripts with the profile [Default is 'False']

Define this parameter in the request URI.
    

Response Codes

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

Response Information

List of Prescriptions

Response body formats

application/json, text/json

Sample: 
[
  {
    "PatientID": "sample string 1",
    "RxNumber": "sample string 2",
    "DispensedDrugName": "sample string 3",
    "DispensedDrugNDC": "sample string 4",
    "DispensedDrugID": "sample string 5",
    "PrescribedDrugName": "sample string 6",
    "PrescribedDrugNDC": "sample string 7",
    "PrescribedDrugID": "sample string 8",
    "DateWritten": "sample string 9",
    "OriginalDate": "sample string 10",
    "LastFillDate": "sample string 11",
    "DueDate": "sample string 12",
    "Quantity": 13.1,
    "QuantityPrescribed": 14.1,
    "DaysSupply": 15,
    "PrescriberName": "sample string 16",
    "PrescriberId": "sample string 17",
    "PrimaryPricePlan": "sample string 18",
    "PatientAmountAtLastFill": 19.1,
    "FullPriceAtLastFill": 20.1,
    "Discontinued": "sample string 21",
    "ProfileOnly": "sample string 22",
    "CycleFill": "sample string 23",
    "RefillsRemaining": 24,
    "SIG": "sample string 25",
    "PRNIndicator": "sample string 26",
    "ShortTermIndicator": "sample string 27",
    "DrugClass": "sample string 28",
    "ExpirationDate": "sample string 29"
  },
  {
    "PatientID": "sample string 1",
    "RxNumber": "sample string 2",
    "DispensedDrugName": "sample string 3",
    "DispensedDrugNDC": "sample string 4",
    "DispensedDrugID": "sample string 5",
    "PrescribedDrugName": "sample string 6",
    "PrescribedDrugNDC": "sample string 7",
    "PrescribedDrugID": "sample string 8",
    "DateWritten": "sample string 9",
    "OriginalDate": "sample string 10",
    "LastFillDate": "sample string 11",
    "DueDate": "sample string 12",
    "Quantity": 13.1,
    "QuantityPrescribed": 14.1,
    "DaysSupply": 15,
    "PrescriberName": "sample string 16",
    "PrescriberId": "sample string 17",
    "PrimaryPricePlan": "sample string 18",
    "PatientAmountAtLastFill": 19.1,
    "FullPriceAtLastFill": 20.1,
    "Discontinued": "sample string 21",
    "ProfileOnly": "sample string 22",
    "CycleFill": "sample string 23",
    "RefillsRemaining": 24,
    "SIG": "sample string 25",
    "PRNIndicator": "sample string 26",
    "ShortTermIndicator": "sample string 27",
    "DrugClass": "sample string 28",
    "ExpirationDate": "sample string 29"
  },
  {
    "PatientID": "sample string 1",
    "RxNumber": "sample string 2",
    "DispensedDrugName": "sample string 3",
    "DispensedDrugNDC": "sample string 4",
    "DispensedDrugID": "sample string 5",
    "PrescribedDrugName": "sample string 6",
    "PrescribedDrugNDC": "sample string 7",
    "PrescribedDrugID": "sample string 8",
    "DateWritten": "sample string 9",
    "OriginalDate": "sample string 10",
    "LastFillDate": "sample string 11",
    "DueDate": "sample string 12",
    "Quantity": 13.1,
    "QuantityPrescribed": 14.1,
    "DaysSupply": 15,
    "PrescriberName": "sample string 16",
    "PrescriberId": "sample string 17",
    "PrimaryPricePlan": "sample string 18",
    "PatientAmountAtLastFill": 19.1,
    "FullPriceAtLastFill": 20.1,
    "Discontinued": "sample string 21",
    "ProfileOnly": "sample string 22",
    "CycleFill": "sample string 23",
    "RefillsRemaining": 24,
    "SIG": "sample string 25",
    "PRNIndicator": "sample string 26",
    "ShortTermIndicator": "sample string 27",
    "DrugClass": "sample string 28",
    "ExpirationDate": "sample string 29"
  }
]

text/javascript

Sample: 
[{"PatientID":"sample string 1","RxNumber":"sample string 2","DispensedDrugName":"sample string 3","DispensedDrugNDC":"sample string 4","DispensedDrugID":"sample string 5","PrescribedDrugName":"sample string 6","PrescribedDrugNDC":"sample string 7","PrescribedDrugID":"sample string 8","DateWritten":"sample string 9","OriginalDate":"sample string 10","LastFillDate":"sample string 11","DueDate":"sample string 12","Quantity":13.1,"QuantityPrescribed":14.1,"DaysSupply":15,"PrescriberName":"sample string 16","PrescriberId":"sample string 17","PrimaryPricePlan":"sample string 18","PatientAmountAtLastFill":19.1,"FullPriceAtLastFill":20.1,"Discontinued":"sample string 21","ProfileOnly":"sample string 22","CycleFill":"sample string 23","RefillsRemaining":24,"SIG":"sample string 25","PRNIndicator":"sample string 26","ShortTermIndicator":"sample string 27","DrugClass":"sample string 28","ExpirationDate":"sample string 29"},{"PatientID":"sample string 1","RxNumber":"sample string 2","DispensedDrugName":"sample string 3","DispensedDrugNDC":"sample string 4","DispensedDrugID":"sample string 5","PrescribedDrugName":"sample string 6","PrescribedDrugNDC":"sample string 7","PrescribedDrugID":"sample string 8","DateWritten":"sample string 9","OriginalDate":"sample string 10","LastFillDate":"sample string 11","DueDate":"sample string 12","Quantity":13.1,"QuantityPrescribed":14.1,"DaysSupply":15,"PrescriberName":"sample string 16","PrescriberId":"sample string 17","PrimaryPricePlan":"sample string 18","PatientAmountAtLastFill":19.1,"FullPriceAtLastFill":20.1,"Discontinued":"sample string 21","ProfileOnly":"sample string 22","CycleFill":"sample string 23","RefillsRemaining":24,"SIG":"sample string 25","PRNIndicator":"sample string 26","ShortTermIndicator":"sample string 27","DrugClass":"sample string 28","ExpirationDate":"sample string 29"},{"PatientID":"sample string 1","RxNumber":"sample string 2","DispensedDrugName":"sample string 3","DispensedDrugNDC":"sample string 4","DispensedDrugID":"sample string 5","PrescribedDrugName":"sample string 6","PrescribedDrugNDC":"sample string 7","PrescribedDrugID":"sample string 8","DateWritten":"sample string 9","OriginalDate":"sample string 10","LastFillDate":"sample string 11","DueDate":"sample string 12","Quantity":13.1,"QuantityPrescribed":14.1,"DaysSupply":15,"PrescriberName":"sample string 16","PrescriberId":"sample string 17","PrimaryPricePlan":"sample string 18","PatientAmountAtLastFill":19.1,"FullPriceAtLastFill":20.1,"Discontinued":"sample string 21","ProfileOnly":"sample string 22","CycleFill":"sample string 23","RefillsRemaining":24,"SIG":"sample string 25","PRNIndicator":"sample string 26","ShortTermIndicator":"sample string 27","DrugClass":"sample string 28","ExpirationDate":"sample string 29"}]

application/xml, text/xml

Sample: 
<ArrayOfPrescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
  <Prescription>
    <CycleFill>sample string 23</CycleFill>
    <DateWritten>sample string 9</DateWritten>
    <DaysSupply>15</DaysSupply>
    <Discontinued>sample string 21</Discontinued>
    <DispensedDrugID>sample string 5</DispensedDrugID>
    <DispensedDrugNDC>sample string 4</DispensedDrugNDC>
    <DispensedDrugName>sample string 3</DispensedDrugName>
    <DrugClass>sample string 28</DrugClass>
    <DueDate>sample string 12</DueDate>
    <ExpirationDate>sample string 29</ExpirationDate>
    <FullPriceAtLastFill>20.1</FullPriceAtLastFill>
    <LastFillDate>sample string 11</LastFillDate>
    <OriginalDate>sample string 10</OriginalDate>
    <PRNIndicator>sample string 26</PRNIndicator>
    <PatientAmountAtLastFill>19.1</PatientAmountAtLastFill>
    <PatientID>sample string 1</PatientID>
    <PrescribedDrugID>sample string 8</PrescribedDrugID>
    <PrescribedDrugNDC>sample string 7</PrescribedDrugNDC>
    <PrescribedDrugName>sample string 6</PrescribedDrugName>
    <PrescriberId>sample string 17</PrescriberId>
    <PrescriberName>sample string 16</PrescriberName>
    <PrimaryPricePlan>sample string 18</PrimaryPricePlan>
    <ProfileOnly>sample string 22</ProfileOnly>
    <Quantity>13.1</Quantity>
    <QuantityPrescribed>14.1</QuantityPrescribed>
    <RefillsRemaining>24</RefillsRemaining>
    <RxNumber>sample string 2</RxNumber>
    <SIG>sample string 25</SIG>
    <ShortTermIndicator>sample string 27</ShortTermIndicator>
  </Prescription>
  <Prescription>
    <CycleFill>sample string 23</CycleFill>
    <DateWritten>sample string 9</DateWritten>
    <DaysSupply>15</DaysSupply>
    <Discontinued>sample string 21</Discontinued>
    <DispensedDrugID>sample string 5</DispensedDrugID>
    <DispensedDrugNDC>sample string 4</DispensedDrugNDC>
    <DispensedDrugName>sample string 3</DispensedDrugName>
    <DrugClass>sample string 28</DrugClass>
    <DueDate>sample string 12</DueDate>
    <ExpirationDate>sample string 29</ExpirationDate>
    <FullPriceAtLastFill>20.1</FullPriceAtLastFill>
    <LastFillDate>sample string 11</LastFillDate>
    <OriginalDate>sample string 10</OriginalDate>
    <PRNIndicator>sample string 26</PRNIndicator>
    <PatientAmountAtLastFill>19.1</PatientAmountAtLastFill>
    <PatientID>sample string 1</PatientID>
    <PrescribedDrugID>sample string 8</PrescribedDrugID>
    <PrescribedDrugNDC>sample string 7</PrescribedDrugNDC>
    <PrescribedDrugName>sample string 6</PrescribedDrugName>
    <PrescriberId>sample string 17</PrescriberId>
    <PrescriberName>sample string 16</PrescriberName>
    <PrimaryPricePlan>sample string 18</PrimaryPricePlan>
    <ProfileOnly>sample string 22</ProfileOnly>
    <Quantity>13.1</Quantity>
    <QuantityPrescribed>14.1</QuantityPrescribed>
    <RefillsRemaining>24</RefillsRemaining>
    <RxNumber>sample string 2</RxNumber>
    <SIG>sample string 25</SIG>
    <ShortTermIndicator>sample string 27</ShortTermIndicator>
  </Prescription>
  <Prescription>
    <CycleFill>sample string 23</CycleFill>
    <DateWritten>sample string 9</DateWritten>
    <DaysSupply>15</DaysSupply>
    <Discontinued>sample string 21</Discontinued>
    <DispensedDrugID>sample string 5</DispensedDrugID>
    <DispensedDrugNDC>sample string 4</DispensedDrugNDC>
    <DispensedDrugName>sample string 3</DispensedDrugName>
    <DrugClass>sample string 28</DrugClass>
    <DueDate>sample string 12</DueDate>
    <ExpirationDate>sample string 29</ExpirationDate>
    <FullPriceAtLastFill>20.1</FullPriceAtLastFill>
    <LastFillDate>sample string 11</LastFillDate>
    <OriginalDate>sample string 10</OriginalDate>
    <PRNIndicator>sample string 26</PRNIndicator>
    <PatientAmountAtLastFill>19.1</PatientAmountAtLastFill>
    <PatientID>sample string 1</PatientID>
    <PrescribedDrugID>sample string 8</PrescribedDrugID>
    <PrescribedDrugNDC>sample string 7</PrescribedDrugNDC>
    <PrescribedDrugName>sample string 6</PrescribedDrugName>
    <PrescriberId>sample string 17</PrescriberId>
    <PrescriberName>sample string 16</PrescriberName>
    <PrimaryPricePlan>sample string 18</PrimaryPricePlan>
    <ProfileOnly>sample string 22</ProfileOnly>
    <Quantity>13.1</Quantity>
    <QuantityPrescribed>14.1</QuantityPrescribed>
    <RefillsRemaining>24</RefillsRemaining>
    <RxNumber>sample string 2</RxNumber>
    <SIG>sample string 25</SIG>
    <ShortTermIndicator>sample string 27</ShortTermIndicator>
  </Prescription>
</ArrayOfPrescription>