GET api/ProviderService/PatientTreatmentPlans
to retrieve a list of the prescribed drugs including the name, quantity, frequency, etc.
Request Information
URI Parameters
None.
Body Parameters
Patient GUID
PatientIDQueryName | Description | Type | Additional information |
---|---|---|---|
PatientID |
Patient ID |
globally unique identifier |
Required |
Count |
COunt -1 all otherwise above zero |
integer |
None. |
DrugID |
Drug ID |
globally unique identifier |
None. |
ApplicationID |
Application using Absolute EMR API |
globally unique identifier |
Required |
Request Formats
application/json, text/json
Sample:
{ "PatientID": "6a96bccc-6041-401e-9c02-68e4c303586e", "Count": 1, "DrugID": "41523ca0-0b03-42ca-bbf6-908f699cd156", "ApplicationID": "1bac1d52-ba29-4c9d-8d47-5857a0eebe22" }
application/xml, text/xml
Sample:
<PatientIDQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbsoluteHealth.API.Models"> <ApplicationID>1bac1d52-ba29-4c9d-8d47-5857a0eebe22</ApplicationID> <Count>1</Count> <DrugID>41523ca0-0b03-42ca-bbf6-908f699cd156</DrugID> <PatientID>6a96bccc-6041-401e-9c02-68e4c303586e</PatientID> </PatientIDQuery>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Current Active Treatment plans by descending order
Collection of TreatmentPlanName | Description | Type | Additional information |
---|---|---|---|
TreatmentPlanID |
Gets or sets the treatment plan ID |
globally unique identifier |
None. |
TreatmentDetails |
Treatment Details |
Collection of TreatmentInfoViewModel |
Required |
TreatmentNote | string |
None. |
|
ProviderID | globally unique identifier |
None. |
|
TreatmentDate | date |
None. |
|
Authority | string |
None. |
|
PatientID |
Patient ID |
globally unique identifier |
Required |
Count |
COunt -1 all otherwise above zero |
integer |
None. |
DrugID |
Drug ID |
globally unique identifier |
None. |
ApplicationID |
Application using Absolute EMR API |
globally unique identifier |
Required |
Response Formats
application/json, text/json
Sample:
[ { "TreatmentPlanID": "4b7826b1-4c51-49d2-beb3-ba320ab6722c", "TreatmentDetails": [ { "Drug_Id": "54c3f44d-321d-4321-a036-ca4a75da65a2", "Instructions_Note": "sample string 2", "Frequency": 3, "FrequencyUnitTypeID": 4, "Repeat": "sample string 5", "Quantity": 6.0, "Start_Date": "2025-06-08T01:43:08.5232062+00:00", "End_Date": "2025-06-08T01:43:08.5232062+00:00", "DrugName": "sample string 7", "PrescriptionDetail_Id": "65f51f72-9ecd-4ccc-bf64-750e8fe37b86", "Consult_Date": "2025-06-08T01:43:08.5232062+00:00", "Authority": "sample string 8", "Is_Current": true, "DrugCategory_Id": 1, "FrequencyUnitType": "sample string 9", "DrugCategoryName": "sample string 10" }, { "Drug_Id": "54c3f44d-321d-4321-a036-ca4a75da65a2", "Instructions_Note": "sample string 2", "Frequency": 3, "FrequencyUnitTypeID": 4, "Repeat": "sample string 5", "Quantity": 6.0, "Start_Date": "2025-06-08T01:43:08.5232062+00:00", "End_Date": "2025-06-08T01:43:08.5232062+00:00", "DrugName": "sample string 7", "PrescriptionDetail_Id": "65f51f72-9ecd-4ccc-bf64-750e8fe37b86", "Consult_Date": "2025-06-08T01:43:08.5232062+00:00", "Authority": "sample string 8", "Is_Current": true, "DrugCategory_Id": 1, "FrequencyUnitType": "sample string 9", "DrugCategoryName": "sample string 10" } ], "TreatmentNote": "sample string 2", "ProviderID": "73ad2bd5-ad32-45b9-9e5c-b6fb3f45c777", "TreatmentDate": "2025-06-08T01:43:08.5232062+00:00", "Authority": "sample string 4", "PatientID": "c7244936-f3cf-4d24-aaf6-7b8539195f9d", "Count": 1, "DrugID": "ced9b834-7e2c-43ce-a134-af34edb61fea", "ApplicationID": "4f8c912a-a5e1-491e-9cd7-65c225ee4d83" }, { "TreatmentPlanID": "4b7826b1-4c51-49d2-beb3-ba320ab6722c", "TreatmentDetails": [ { "Drug_Id": "54c3f44d-321d-4321-a036-ca4a75da65a2", "Instructions_Note": "sample string 2", "Frequency": 3, "FrequencyUnitTypeID": 4, "Repeat": "sample string 5", "Quantity": 6.0, "Start_Date": "2025-06-08T01:43:08.5232062+00:00", "End_Date": "2025-06-08T01:43:08.5232062+00:00", "DrugName": "sample string 7", "PrescriptionDetail_Id": "65f51f72-9ecd-4ccc-bf64-750e8fe37b86", "Consult_Date": "2025-06-08T01:43:08.5232062+00:00", "Authority": "sample string 8", "Is_Current": true, "DrugCategory_Id": 1, "FrequencyUnitType": "sample string 9", "DrugCategoryName": "sample string 10" }, { "Drug_Id": "54c3f44d-321d-4321-a036-ca4a75da65a2", "Instructions_Note": "sample string 2", "Frequency": 3, "FrequencyUnitTypeID": 4, "Repeat": "sample string 5", "Quantity": 6.0, "Start_Date": "2025-06-08T01:43:08.5232062+00:00", "End_Date": "2025-06-08T01:43:08.5232062+00:00", "DrugName": "sample string 7", "PrescriptionDetail_Id": "65f51f72-9ecd-4ccc-bf64-750e8fe37b86", "Consult_Date": "2025-06-08T01:43:08.5232062+00:00", "Authority": "sample string 8", "Is_Current": true, "DrugCategory_Id": 1, "FrequencyUnitType": "sample string 9", "DrugCategoryName": "sample string 10" } ], "TreatmentNote": "sample string 2", "ProviderID": "73ad2bd5-ad32-45b9-9e5c-b6fb3f45c777", "TreatmentDate": "2025-06-08T01:43:08.5232062+00:00", "Authority": "sample string 4", "PatientID": "c7244936-f3cf-4d24-aaf6-7b8539195f9d", "Count": 1, "DrugID": "ced9b834-7e2c-43ce-a134-af34edb61fea", "ApplicationID": "4f8c912a-a5e1-491e-9cd7-65c225ee4d83" } ]
application/xml, text/xml
Sample:
<ArrayOfTreatmentPlan xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbsoluteHealth.API.Models"> <TreatmentPlan> <ApplicationID>4f8c912a-a5e1-491e-9cd7-65c225ee4d83</ApplicationID> <Count>1</Count> <DrugID>ced9b834-7e2c-43ce-a134-af34edb61fea</DrugID> <PatientID>c7244936-f3cf-4d24-aaf6-7b8539195f9d</PatientID> <Authority>sample string 4</Authority> <TreatmentDate>2025-06-08T01:43:08.5232062+00:00</TreatmentDate> <TreatmentDetails> <TreatmentInfoViewModel> <Authority>sample string 8</Authority> <Consult_Date>2025-06-08T01:43:08.5232062+00:00</Consult_Date> <DrugCategoryName>sample string 10</DrugCategoryName> <DrugCategory_Id>1</DrugCategory_Id> <DrugName>sample string 7</DrugName> <Drug_Id>54c3f44d-321d-4321-a036-ca4a75da65a2</Drug_Id> <End_Date>2025-06-08T01:43:08.5232062+00:00</End_Date> <Frequency>3</Frequency> <FrequencyUnitType>sample string 9</FrequencyUnitType> <FrequencyUnitTypeID>4</FrequencyUnitTypeID> <Instructions_Note>sample string 2</Instructions_Note> <Is_Current>true</Is_Current> <PrescriptionDetail_Id>65f51f72-9ecd-4ccc-bf64-750e8fe37b86</PrescriptionDetail_Id> <Quantity>6</Quantity> <Repeat>sample string 5</Repeat> <Start_Date>2025-06-08T01:43:08.5232062+00:00</Start_Date> </TreatmentInfoViewModel> <TreatmentInfoViewModel> <Authority>sample string 8</Authority> <Consult_Date>2025-06-08T01:43:08.5232062+00:00</Consult_Date> <DrugCategoryName>sample string 10</DrugCategoryName> <DrugCategory_Id>1</DrugCategory_Id> <DrugName>sample string 7</DrugName> <Drug_Id>54c3f44d-321d-4321-a036-ca4a75da65a2</Drug_Id> <End_Date>2025-06-08T01:43:08.5232062+00:00</End_Date> <Frequency>3</Frequency> <FrequencyUnitType>sample string 9</FrequencyUnitType> <FrequencyUnitTypeID>4</FrequencyUnitTypeID> <Instructions_Note>sample string 2</Instructions_Note> <Is_Current>true</Is_Current> <PrescriptionDetail_Id>65f51f72-9ecd-4ccc-bf64-750e8fe37b86</PrescriptionDetail_Id> <Quantity>6</Quantity> <Repeat>sample string 5</Repeat> <Start_Date>2025-06-08T01:43:08.5232062+00:00</Start_Date> </TreatmentInfoViewModel> </TreatmentDetails> <TreatmentNote>sample string 2</TreatmentNote> <TreatmentPlanID>4b7826b1-4c51-49d2-beb3-ba320ab6722c</TreatmentPlanID> </TreatmentPlan> <TreatmentPlan> <ApplicationID>4f8c912a-a5e1-491e-9cd7-65c225ee4d83</ApplicationID> <Count>1</Count> <DrugID>ced9b834-7e2c-43ce-a134-af34edb61fea</DrugID> <PatientID>c7244936-f3cf-4d24-aaf6-7b8539195f9d</PatientID> <Authority>sample string 4</Authority> <TreatmentDate>2025-06-08T01:43:08.5232062+00:00</TreatmentDate> <TreatmentDetails> <TreatmentInfoViewModel> <Authority>sample string 8</Authority> <Consult_Date>2025-06-08T01:43:08.5232062+00:00</Consult_Date> <DrugCategoryName>sample string 10</DrugCategoryName> <DrugCategory_Id>1</DrugCategory_Id> <DrugName>sample string 7</DrugName> <Drug_Id>54c3f44d-321d-4321-a036-ca4a75da65a2</Drug_Id> <End_Date>2025-06-08T01:43:08.5232062+00:00</End_Date> <Frequency>3</Frequency> <FrequencyUnitType>sample string 9</FrequencyUnitType> <FrequencyUnitTypeID>4</FrequencyUnitTypeID> <Instructions_Note>sample string 2</Instructions_Note> <Is_Current>true</Is_Current> <PrescriptionDetail_Id>65f51f72-9ecd-4ccc-bf64-750e8fe37b86</PrescriptionDetail_Id> <Quantity>6</Quantity> <Repeat>sample string 5</Repeat> <Start_Date>2025-06-08T01:43:08.5232062+00:00</Start_Date> </TreatmentInfoViewModel> <TreatmentInfoViewModel> <Authority>sample string 8</Authority> <Consult_Date>2025-06-08T01:43:08.5232062+00:00</Consult_Date> <DrugCategoryName>sample string 10</DrugCategoryName> <DrugCategory_Id>1</DrugCategory_Id> <DrugName>sample string 7</DrugName> <Drug_Id>54c3f44d-321d-4321-a036-ca4a75da65a2</Drug_Id> <End_Date>2025-06-08T01:43:08.5232062+00:00</End_Date> <Frequency>3</Frequency> <FrequencyUnitType>sample string 9</FrequencyUnitType> <FrequencyUnitTypeID>4</FrequencyUnitTypeID> <Instructions_Note>sample string 2</Instructions_Note> <Is_Current>true</Is_Current> <PrescriptionDetail_Id>65f51f72-9ecd-4ccc-bf64-750e8fe37b86</PrescriptionDetail_Id> <Quantity>6</Quantity> <Repeat>sample string 5</Repeat> <Start_Date>2025-06-08T01:43:08.5232062+00:00</Start_Date> </TreatmentInfoViewModel> </TreatmentDetails> <TreatmentNote>sample string 2</TreatmentNote> <TreatmentPlanID>4b7826b1-4c51-49d2-beb3-ba320ab6722c</TreatmentPlanID> </TreatmentPlan> </ArrayOfTreatmentPlan>