GET api/v{version}/laboratory/{laboratoryId}/subject/{subjectId}/medication?ListType={ListType}&UserProfileID={UserProfileID}&MedicationName={MedicationName}&PatientNotes={PatientNotes}&Dose={Dose}&Frequency={Frequency}&Route={Route}&LastTaken={LastTaken}&MedicationOriginID={MedicationOriginID}&MedicationState={MedicationState}
Lists the medications and prescriptions for the specified patient.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
laboratoryId |
The laboratory identifier. |
integer |
Required |
subjectId |
The subject identifier. |
integer |
Required |
ListType |
Gets or sets the type of the list. |
ListTypeEnum |
None. |
UserProfileID |
Gets or sets the user profile identifier. |
integer |
None. |
MedicationName |
Gets or sets the name of the medication. |
string |
None. |
PatientNotes |
Gets or sets the patient notes. |
string |
None. |
Dose |
Gets or sets the dose. |
string |
None. |
Frequency |
Gets or sets the frequency. |
string |
None. |
Route |
Gets or sets the route. |
string |
None. |
LastTaken |
Gets or sets the last taken. |
date |
None. |
MedicationOriginID |
Gets or sets the medication origin identifier. |
integer |
None. |
MedicationState |
Gets or sets the state of the medication. |
MedicationStateEnum |
None. |
version | string |
None. |
Body Parameters
None.
Response Information
Resource Description
ResponseOfIEnumerableOfMedicationListModelName | Description | Type | Additional information |
---|---|---|---|
Data | Collection of MedicationListModel |
None. |
|
StatusCode |
Gets or sets the status code. |
HttpStatusCode |
None. |
StatusDescription |
Gets or sets the status description. |
string |
None. |
Errors | Collection of string |
None. |
Response Formats
application/json, text/json
{ "data": [ { "id": 1, "type": "sample string 2", "name": "sample string 3", "dose": "sample string 4", "frequency": "sample string 5", "route": "sample string 6", "drugForm": "sample string 7", "origin": "sample string 8", "inRescueKit": true, "effectiveDate": "2025-02-06T09:24:36.3598257-07:00", "expirationDate": "2025-02-06T09:24:36.3598257-07:00", "lastTakenDate": "2025-02-06T09:24:36.3598257-07:00", "lastObtainedDate": "2025-02-06T09:24:36.3598257-07:00", "origOrderDate": "2025-02-06T09:24:36.3598257-07:00", "patientNotes": "sample string 10" }, { "id": 1, "type": "sample string 2", "name": "sample string 3", "dose": "sample string 4", "frequency": "sample string 5", "route": "sample string 6", "drugForm": "sample string 7", "origin": "sample string 8", "inRescueKit": true, "effectiveDate": "2025-02-06T09:24:36.3598257-07:00", "expirationDate": "2025-02-06T09:24:36.3598257-07:00", "lastTakenDate": "2025-02-06T09:24:36.3598257-07:00", "lastObtainedDate": "2025-02-06T09:24:36.3598257-07:00", "origOrderDate": "2025-02-06T09:24:36.3598257-07:00", "patientNotes": "sample string 10" } ], "statusCode": 100, "statusDescription": "sample string 1", "errors": [ "sample string 1", "sample string 2" ] }
application/xml, text/xml
<ResponseOfArrayOfMedicationListModeluskxzdf5 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CancerBytesAPI.Response"> <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Errors> <StatusCode>Continue</StatusCode> <StatusDescription>sample string 1</StatusDescription> <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/CancerBytesAPI.Models"> <d2p1:MedicationListModel> <d2p1:Dose>sample string 4</d2p1:Dose> <d2p1:DrugForm>sample string 7</d2p1:DrugForm> <d2p1:EffectiveDate>2025-02-06T09:24:36.3598257-07:00</d2p1:EffectiveDate> <d2p1:ExpirationDate>2025-02-06T09:24:36.3598257-07:00</d2p1:ExpirationDate> <d2p1:Frequency>sample string 5</d2p1:Frequency> <d2p1:Id>1</d2p1:Id> <d2p1:InRescueKit>true</d2p1:InRescueKit> <d2p1:LastObtainedDate>2025-02-06T09:24:36.3598257-07:00</d2p1:LastObtainedDate> <d2p1:LastTakenDate>2025-02-06T09:24:36.3598257-07:00</d2p1:LastTakenDate> <d2p1:Name>sample string 3</d2p1:Name> <d2p1:OrigOrderDate>2025-02-06T09:24:36.3598257-07:00</d2p1:OrigOrderDate> <d2p1:Origin>sample string 8</d2p1:Origin> <d2p1:PatientNotes>sample string 10</d2p1:PatientNotes> <d2p1:Route>sample string 6</d2p1:Route> <d2p1:Type>sample string 2</d2p1:Type> </d2p1:MedicationListModel> <d2p1:MedicationListModel> <d2p1:Dose>sample string 4</d2p1:Dose> <d2p1:DrugForm>sample string 7</d2p1:DrugForm> <d2p1:EffectiveDate>2025-02-06T09:24:36.3598257-07:00</d2p1:EffectiveDate> <d2p1:ExpirationDate>2025-02-06T09:24:36.3598257-07:00</d2p1:ExpirationDate> <d2p1:Frequency>sample string 5</d2p1:Frequency> <d2p1:Id>1</d2p1:Id> <d2p1:InRescueKit>true</d2p1:InRescueKit> <d2p1:LastObtainedDate>2025-02-06T09:24:36.3598257-07:00</d2p1:LastObtainedDate> <d2p1:LastTakenDate>2025-02-06T09:24:36.3598257-07:00</d2p1:LastTakenDate> <d2p1:Name>sample string 3</d2p1:Name> <d2p1:OrigOrderDate>2025-02-06T09:24:36.3598257-07:00</d2p1:OrigOrderDate> <d2p1:Origin>sample string 8</d2p1:Origin> <d2p1:PatientNotes>sample string 10</d2p1:PatientNotes> <d2p1:Route>sample string 6</d2p1:Route> <d2p1:Type>sample string 2</d2p1:Type> </d2p1:MedicationListModel> </Data> </ResponseOfArrayOfMedicationListModeluskxzdf5>