GET api/patients/{patientId}/medications/history?start={start}&end={end}&onBehalfOfUserId={onBehalfOfUserId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| patientId | integer |
Required |
|
| start | date |
None. |
|
| end | date |
None. |
|
| onBehalfOfUserId | integer |
None. |
Body Parameters
None.
Response Information
Resource Description
ListResponseOfSureScriptsHistoryMedication| Name | Description | Type | Additional information |
|---|---|---|---|
| Items | Collection of SureScriptsHistoryMedication |
None. |
|
| Result | Result |
None. |
Response Formats
application/json, text/json
Sample:
{
"Items": [
{
"PatientMedicationHistoryId": 1,
"PharmacyNotes": "sample string 2",
"NoSubstitutions": true,
"EffectiveDate": "2025-12-18T12:38:37.962258+00:00",
"LastFillDate": "2025-12-18T12:38:37.962258+00:00",
"Payer": "sample string 3",
"DaysSupply": 1,
"Directions": "sample string 4",
"DispenseUnitDescription": "sample string 5",
"DispenseUnitId": 1,
"Quantity": "sample string 6",
"Refills": "sample string 7",
"WrittenDate": "2025-12-18T12:38:37.962258+00:00",
"DiagnosisCode": "sample string 8",
"DiagnosisQualifier": "sample string 9",
"DoseForm": "sample string 11",
"Route": "sample string 12",
"Strength": "sample string 13",
"GenericProductName": "sample string 14",
"GenericDrugName": "sample string 15",
"LexiGenProductId": 16,
"LexiDrugSynId": 17,
"LexiSynonymTypeId": 18,
"LexiGenDrugId": "sample string 19",
"RxCUI": "sample string 20",
"OTC": true,
"NDC": "sample string 22",
"Schedule": "sample string 23",
"DisplayName": "sample string 24",
"MonographPath": "sample string 25",
"DrugClassification": "sample string 26",
"StateSchedules": [
{
"StateName": "sample string 1",
"Schedule": 2
},
{
"StateName": "sample string 1",
"Schedule": 2
}
],
"Brand": true,
"CompoundIngredients": [
{
"LexiGenProductId": 1,
"LexiDrugSynId": 1,
"LexiSynonymTypeId": 1,
"FreeText": "sample string 1",
"DispenseUnitId": 2,
"Quantity": "sample string 3",
"IsFreeTextEPCS": true,
"Schedule": 1,
"StateSchedules": [
{
"StateName": "sample string 1",
"Schedule": 2
},
{
"StateName": "sample string 1",
"Schedule": 2
}
]
},
{
"LexiGenProductId": 1,
"LexiDrugSynId": 1,
"LexiSynonymTypeId": 1,
"FreeText": "sample string 1",
"DispenseUnitId": 2,
"Quantity": "sample string 3",
"IsFreeTextEPCS": true,
"Schedule": 1,
"StateSchedules": [
{
"StateName": "sample string 1",
"Schedule": 2
},
{
"StateName": "sample string 1",
"Schedule": 2
}
]
}
]
},
{
"PatientMedicationHistoryId": 1,
"PharmacyNotes": "sample string 2",
"NoSubstitutions": true,
"EffectiveDate": "2025-12-18T12:38:37.962258+00:00",
"LastFillDate": "2025-12-18T12:38:37.962258+00:00",
"Payer": "sample string 3",
"DaysSupply": 1,
"Directions": "sample string 4",
"DispenseUnitDescription": "sample string 5",
"DispenseUnitId": 1,
"Quantity": "sample string 6",
"Refills": "sample string 7",
"WrittenDate": "2025-12-18T12:38:37.962258+00:00",
"DiagnosisCode": "sample string 8",
"DiagnosisQualifier": "sample string 9",
"DoseForm": "sample string 11",
"Route": "sample string 12",
"Strength": "sample string 13",
"GenericProductName": "sample string 14",
"GenericDrugName": "sample string 15",
"LexiGenProductId": 16,
"LexiDrugSynId": 17,
"LexiSynonymTypeId": 18,
"LexiGenDrugId": "sample string 19",
"RxCUI": "sample string 20",
"OTC": true,
"NDC": "sample string 22",
"Schedule": "sample string 23",
"DisplayName": "sample string 24",
"MonographPath": "sample string 25",
"DrugClassification": "sample string 26",
"StateSchedules": [
{
"StateName": "sample string 1",
"Schedule": 2
},
{
"StateName": "sample string 1",
"Schedule": 2
}
],
"Brand": true,
"CompoundIngredients": [
{
"LexiGenProductId": 1,
"LexiDrugSynId": 1,
"LexiSynonymTypeId": 1,
"FreeText": "sample string 1",
"DispenseUnitId": 2,
"Quantity": "sample string 3",
"IsFreeTextEPCS": true,
"Schedule": 1,
"StateSchedules": [
{
"StateName": "sample string 1",
"Schedule": 2
},
{
"StateName": "sample string 1",
"Schedule": 2
}
]
},
{
"LexiGenProductId": 1,
"LexiDrugSynId": 1,
"LexiSynonymTypeId": 1,
"FreeText": "sample string 1",
"DispenseUnitId": 2,
"Quantity": "sample string 3",
"IsFreeTextEPCS": true,
"Schedule": 1,
"StateSchedules": [
{
"StateName": "sample string 1",
"Schedule": 2
},
{
"StateName": "sample string 1",
"Schedule": 2
}
]
}
]
}
],
"Result": {
"ResultCode": "sample string 1",
"ResultDescription": "sample string 2"
}
}
application/xml, text/xml
Sample:
<ListResponseOfSureScriptsHistoryMedication8Vkccj_Sk xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13">
<Result>
<ResultCode>sample string 1</ResultCode>
<ResultDescription>sample string 2</ResultDescription>
</Result>
<Items>
<SureScriptsHistoryMedication>
<Brand>true</Brand>
<CompoundIngredients>
<CompoundIngredientSchedule>
<DispenseUnitId>2</DispenseUnitId>
<FreeText>sample string 1</FreeText>
<IsFreeTextEPCS>true</IsFreeTextEPCS>
<LexiDrugSynId>1</LexiDrugSynId>
<LexiGenProductId>1</LexiGenProductId>
<LexiSynonymTypeId>1</LexiSynonymTypeId>
<Quantity>sample string 3</Quantity>
<Schedule>1</Schedule>
<StateSchedules>
<StateSchedules>
<Schedule>2</Schedule>
<StateName>sample string 1</StateName>
</StateSchedules>
<StateSchedules>
<Schedule>2</Schedule>
<StateName>sample string 1</StateName>
</StateSchedules>
</StateSchedules>
</CompoundIngredientSchedule>
<CompoundIngredientSchedule>
<DispenseUnitId>2</DispenseUnitId>
<FreeText>sample string 1</FreeText>
<IsFreeTextEPCS>true</IsFreeTextEPCS>
<LexiDrugSynId>1</LexiDrugSynId>
<LexiGenProductId>1</LexiGenProductId>
<LexiSynonymTypeId>1</LexiSynonymTypeId>
<Quantity>sample string 3</Quantity>
<Schedule>1</Schedule>
<StateSchedules>
<StateSchedules>
<Schedule>2</Schedule>
<StateName>sample string 1</StateName>
</StateSchedules>
<StateSchedules>
<Schedule>2</Schedule>
<StateName>sample string 1</StateName>
</StateSchedules>
</StateSchedules>
</CompoundIngredientSchedule>
</CompoundIngredients>
<DispenseUnitId>10</DispenseUnitId>
<DisplayName>sample string 24</DisplayName>
<DoseForm>sample string 11</DoseForm>
<DrugClassification>sample string 26</DrugClassification>
<GenericDrugName>sample string 15</GenericDrugName>
<GenericProductName>sample string 14</GenericProductName>
<LexiDrugSynId>17</LexiDrugSynId>
<LexiGenDrugId>sample string 19</LexiGenDrugId>
<LexiGenProductId>16</LexiGenProductId>
<LexiSynonymTypeId>18</LexiSynonymTypeId>
<MonographPath>sample string 25</MonographPath>
<NDC>sample string 22</NDC>
<OTC>true</OTC>
<Route>sample string 12</Route>
<RxCUI>sample string 20</RxCUI>
<Schedule>sample string 23</Schedule>
<StateSchedules>
<StateSchedules>
<Schedule>2</Schedule>
<StateName>sample string 1</StateName>
</StateSchedules>
<StateSchedules>
<Schedule>2</Schedule>
<StateName>sample string 1</StateName>
</StateSchedules>
</StateSchedules>
<Strength>sample string 13</Strength>
<DaysSupply>1</DaysSupply>
<DiagnosisCode>sample string 8</DiagnosisCode>
<DiagnosisQualifier>sample string 9</DiagnosisQualifier>
<Directions>sample string 4</Directions>
<DispenseUnitDescription>sample string 5</DispenseUnitDescription>
<DispenseUnitId>1</DispenseUnitId>
<EffectiveDate>2025-12-18T12:38:37.962258+00:00</EffectiveDate>
<LastFillDate>2025-12-18T12:38:37.962258+00:00</LastFillDate>
<NoSubstitutions>true</NoSubstitutions>
<PatientMedicationHistoryId>1</PatientMedicationHistoryId>
<Payer>sample string 3</Payer>
<PharmacyNotes>sample string 2</PharmacyNotes>
<Quantity>sample string 6</Quantity>
<Refills>sample string 7</Refills>
<WrittenDate>2025-12-18T12:38:37.962258+00:00</WrittenDate>
</SureScriptsHistoryMedication>
<SureScriptsHistoryMedication>
<Brand>true</Brand>
<CompoundIngredients>
<CompoundIngredientSchedule>
<DispenseUnitId>2</DispenseUnitId>
<FreeText>sample string 1</FreeText>
<IsFreeTextEPCS>true</IsFreeTextEPCS>
<LexiDrugSynId>1</LexiDrugSynId>
<LexiGenProductId>1</LexiGenProductId>
<LexiSynonymTypeId>1</LexiSynonymTypeId>
<Quantity>sample string 3</Quantity>
<Schedule>1</Schedule>
<StateSchedules>
<StateSchedules>
<Schedule>2</Schedule>
<StateName>sample string 1</StateName>
</StateSchedules>
<StateSchedules>
<Schedule>2</Schedule>
<StateName>sample string 1</StateName>
</StateSchedules>
</StateSchedules>
</CompoundIngredientSchedule>
<CompoundIngredientSchedule>
<DispenseUnitId>2</DispenseUnitId>
<FreeText>sample string 1</FreeText>
<IsFreeTextEPCS>true</IsFreeTextEPCS>
<LexiDrugSynId>1</LexiDrugSynId>
<LexiGenProductId>1</LexiGenProductId>
<LexiSynonymTypeId>1</LexiSynonymTypeId>
<Quantity>sample string 3</Quantity>
<Schedule>1</Schedule>
<StateSchedules>
<StateSchedules>
<Schedule>2</Schedule>
<StateName>sample string 1</StateName>
</StateSchedules>
<StateSchedules>
<Schedule>2</Schedule>
<StateName>sample string 1</StateName>
</StateSchedules>
</StateSchedules>
</CompoundIngredientSchedule>
</CompoundIngredients>
<DispenseUnitId>10</DispenseUnitId>
<DisplayName>sample string 24</DisplayName>
<DoseForm>sample string 11</DoseForm>
<DrugClassification>sample string 26</DrugClassification>
<GenericDrugName>sample string 15</GenericDrugName>
<GenericProductName>sample string 14</GenericProductName>
<LexiDrugSynId>17</LexiDrugSynId>
<LexiGenDrugId>sample string 19</LexiGenDrugId>
<LexiGenProductId>16</LexiGenProductId>
<LexiSynonymTypeId>18</LexiSynonymTypeId>
<MonographPath>sample string 25</MonographPath>
<NDC>sample string 22</NDC>
<OTC>true</OTC>
<Route>sample string 12</Route>
<RxCUI>sample string 20</RxCUI>
<Schedule>sample string 23</Schedule>
<StateSchedules>
<StateSchedules>
<Schedule>2</Schedule>
<StateName>sample string 1</StateName>
</StateSchedules>
<StateSchedules>
<Schedule>2</Schedule>
<StateName>sample string 1</StateName>
</StateSchedules>
</StateSchedules>
<Strength>sample string 13</Strength>
<DaysSupply>1</DaysSupply>
<DiagnosisCode>sample string 8</DiagnosisCode>
<DiagnosisQualifier>sample string 9</DiagnosisQualifier>
<Directions>sample string 4</Directions>
<DispenseUnitDescription>sample string 5</DispenseUnitDescription>
<DispenseUnitId>1</DispenseUnitId>
<EffectiveDate>2025-12-18T12:38:37.962258+00:00</EffectiveDate>
<LastFillDate>2025-12-18T12:38:37.962258+00:00</LastFillDate>
<NoSubstitutions>true</NoSubstitutions>
<PatientMedicationHistoryId>1</PatientMedicationHistoryId>
<Payer>sample string 3</Payer>
<PharmacyNotes>sample string 2</PharmacyNotes>
<Quantity>sample string 6</Quantity>
<Refills>sample string 7</Refills>
<WrittenDate>2025-12-18T12:38:37.962258+00:00</WrittenDate>
</SureScriptsHistoryMedication>
</Items>
</ListResponseOfSureScriptsHistoryMedication8Vkccj_Sk>