GET api/PatientService/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": "14a28c1b-8dc8-44d8-b80d-db3c910da221", "Count": 1, "DrugID": "85e552c9-2ce8-4e7e-8316-f5dd4f19571e", "ApplicationID": "25ed8d96-3aa4-4d92-8f38-f0a1bb9633dd" }
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>25ed8d96-3aa4-4d92-8f38-f0a1bb9633dd</ApplicationID> <Count>1</Count> <DrugID>85e552c9-2ce8-4e7e-8316-f5dd4f19571e</DrugID> <PatientID>14a28c1b-8dc8-44d8-b80d-db3c910da221</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": "a96d4b4a-814f-44ce-8bcb-3dbff7a86d6c", "TreatmentDetails": [ { "Drug_Id": "87e7a4b5-f7e6-41fd-a6b4-15dca9d5449f", "Instructions_Note": "sample string 2", "Frequency": 3, "FrequencyUnitTypeID": 4, "Repeat": "sample string 5", "Quantity": 6.0, "Start_Date": "2025-06-08T02:15:39.2821856+00:00", "End_Date": "2025-06-08T02:15:39.2821856+00:00", "DrugName": "sample string 7", "PrescriptionDetail_Id": "73d7bace-50af-46ae-b421-9dc3d7b41431", "Consult_Date": "2025-06-08T02:15:39.2821856+00:00", "Authority": "sample string 8", "Is_Current": true, "DrugCategory_Id": 1, "FrequencyUnitType": "sample string 9", "DrugCategoryName": "sample string 10" }, { "Drug_Id": "87e7a4b5-f7e6-41fd-a6b4-15dca9d5449f", "Instructions_Note": "sample string 2", "Frequency": 3, "FrequencyUnitTypeID": 4, "Repeat": "sample string 5", "Quantity": 6.0, "Start_Date": "2025-06-08T02:15:39.2821856+00:00", "End_Date": "2025-06-08T02:15:39.2821856+00:00", "DrugName": "sample string 7", "PrescriptionDetail_Id": "73d7bace-50af-46ae-b421-9dc3d7b41431", "Consult_Date": "2025-06-08T02:15:39.2821856+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": "42708dd9-21d5-49c4-a26a-fff6b1d6bc0f", "TreatmentDate": "2025-06-08T02:15:39.2821856+00:00", "Authority": "sample string 4", "PatientID": "49e12612-aa4b-48c8-bde3-2c3b500ac8d0", "Count": 1, "DrugID": "ae7abba8-c71e-4452-b3c1-b3713e84ea83", "ApplicationID": "37dd93cd-a04e-4cdc-b947-7ad79b8530a5" }, { "TreatmentPlanID": "a96d4b4a-814f-44ce-8bcb-3dbff7a86d6c", "TreatmentDetails": [ { "Drug_Id": "87e7a4b5-f7e6-41fd-a6b4-15dca9d5449f", "Instructions_Note": "sample string 2", "Frequency": 3, "FrequencyUnitTypeID": 4, "Repeat": "sample string 5", "Quantity": 6.0, "Start_Date": "2025-06-08T02:15:39.2821856+00:00", "End_Date": "2025-06-08T02:15:39.2821856+00:00", "DrugName": "sample string 7", "PrescriptionDetail_Id": "73d7bace-50af-46ae-b421-9dc3d7b41431", "Consult_Date": "2025-06-08T02:15:39.2821856+00:00", "Authority": "sample string 8", "Is_Current": true, "DrugCategory_Id": 1, "FrequencyUnitType": "sample string 9", "DrugCategoryName": "sample string 10" }, { "Drug_Id": "87e7a4b5-f7e6-41fd-a6b4-15dca9d5449f", "Instructions_Note": "sample string 2", "Frequency": 3, "FrequencyUnitTypeID": 4, "Repeat": "sample string 5", "Quantity": 6.0, "Start_Date": "2025-06-08T02:15:39.2821856+00:00", "End_Date": "2025-06-08T02:15:39.2821856+00:00", "DrugName": "sample string 7", "PrescriptionDetail_Id": "73d7bace-50af-46ae-b421-9dc3d7b41431", "Consult_Date": "2025-06-08T02:15:39.2821856+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": "42708dd9-21d5-49c4-a26a-fff6b1d6bc0f", "TreatmentDate": "2025-06-08T02:15:39.2821856+00:00", "Authority": "sample string 4", "PatientID": "49e12612-aa4b-48c8-bde3-2c3b500ac8d0", "Count": 1, "DrugID": "ae7abba8-c71e-4452-b3c1-b3713e84ea83", "ApplicationID": "37dd93cd-a04e-4cdc-b947-7ad79b8530a5" } ]
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>37dd93cd-a04e-4cdc-b947-7ad79b8530a5</ApplicationID> <Count>1</Count> <DrugID>ae7abba8-c71e-4452-b3c1-b3713e84ea83</DrugID> <PatientID>49e12612-aa4b-48c8-bde3-2c3b500ac8d0</PatientID> <Authority>sample string 4</Authority> <TreatmentDate>2025-06-08T02:15:39.2821856+00:00</TreatmentDate> <TreatmentDetails> <TreatmentInfoViewModel> <Authority>sample string 8</Authority> <Consult_Date>2025-06-08T02:15:39.2821856+00:00</Consult_Date> <DrugCategoryName>sample string 10</DrugCategoryName> <DrugCategory_Id>1</DrugCategory_Id> <DrugName>sample string 7</DrugName> <Drug_Id>87e7a4b5-f7e6-41fd-a6b4-15dca9d5449f</Drug_Id> <End_Date>2025-06-08T02:15:39.2821856+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>73d7bace-50af-46ae-b421-9dc3d7b41431</PrescriptionDetail_Id> <Quantity>6</Quantity> <Repeat>sample string 5</Repeat> <Start_Date>2025-06-08T02:15:39.2821856+00:00</Start_Date> </TreatmentInfoViewModel> <TreatmentInfoViewModel> <Authority>sample string 8</Authority> <Consult_Date>2025-06-08T02:15:39.2821856+00:00</Consult_Date> <DrugCategoryName>sample string 10</DrugCategoryName> <DrugCategory_Id>1</DrugCategory_Id> <DrugName>sample string 7</DrugName> <Drug_Id>87e7a4b5-f7e6-41fd-a6b4-15dca9d5449f</Drug_Id> <End_Date>2025-06-08T02:15:39.2821856+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>73d7bace-50af-46ae-b421-9dc3d7b41431</PrescriptionDetail_Id> <Quantity>6</Quantity> <Repeat>sample string 5</Repeat> <Start_Date>2025-06-08T02:15:39.2821856+00:00</Start_Date> </TreatmentInfoViewModel> </TreatmentDetails> <TreatmentNote>sample string 2</TreatmentNote> <TreatmentPlanID>a96d4b4a-814f-44ce-8bcb-3dbff7a86d6c</TreatmentPlanID> </TreatmentPlan> <TreatmentPlan> <ApplicationID>37dd93cd-a04e-4cdc-b947-7ad79b8530a5</ApplicationID> <Count>1</Count> <DrugID>ae7abba8-c71e-4452-b3c1-b3713e84ea83</DrugID> <PatientID>49e12612-aa4b-48c8-bde3-2c3b500ac8d0</PatientID> <Authority>sample string 4</Authority> <TreatmentDate>2025-06-08T02:15:39.2821856+00:00</TreatmentDate> <TreatmentDetails> <TreatmentInfoViewModel> <Authority>sample string 8</Authority> <Consult_Date>2025-06-08T02:15:39.2821856+00:00</Consult_Date> <DrugCategoryName>sample string 10</DrugCategoryName> <DrugCategory_Id>1</DrugCategory_Id> <DrugName>sample string 7</DrugName> <Drug_Id>87e7a4b5-f7e6-41fd-a6b4-15dca9d5449f</Drug_Id> <End_Date>2025-06-08T02:15:39.2821856+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>73d7bace-50af-46ae-b421-9dc3d7b41431</PrescriptionDetail_Id> <Quantity>6</Quantity> <Repeat>sample string 5</Repeat> <Start_Date>2025-06-08T02:15:39.2821856+00:00</Start_Date> </TreatmentInfoViewModel> <TreatmentInfoViewModel> <Authority>sample string 8</Authority> <Consult_Date>2025-06-08T02:15:39.2821856+00:00</Consult_Date> <DrugCategoryName>sample string 10</DrugCategoryName> <DrugCategory_Id>1</DrugCategory_Id> <DrugName>sample string 7</DrugName> <Drug_Id>87e7a4b5-f7e6-41fd-a6b4-15dca9d5449f</Drug_Id> <End_Date>2025-06-08T02:15:39.2821856+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>73d7bace-50af-46ae-b421-9dc3d7b41431</PrescriptionDetail_Id> <Quantity>6</Quantity> <Repeat>sample string 5</Repeat> <Start_Date>2025-06-08T02:15:39.2821856+00:00</Start_Date> </TreatmentInfoViewModel> </TreatmentDetails> <TreatmentNote>sample string 2</TreatmentNote> <TreatmentPlanID>a96d4b4a-814f-44ce-8bcb-3dbff7a86d6c</TreatmentPlanID> </TreatmentPlan> </ArrayOfTreatmentPlan>