DELETE api/ProviderService/RemoveTreatmentPlan

Remove Patient Treatment Plan

Request Information

URI Parameters

None.

Body Parameters

Send only Treatment Plan ID

TreatmentPlan
NameDescriptionTypeAdditional 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

Request Formats

application/json, text/json

Sample:
{
  "TreatmentPlanID": "402cbcf7-7746-476f-b8c6-b4f6af3b5ec5",
  "TreatmentDetails": [
    {
      "Drug_Id": "e649fb8c-42b2-4827-8207-c57157623dd9",
      "Instructions_Note": "sample string 2",
      "Frequency": 3,
      "FrequencyUnitTypeID": 4,
      "Repeat": "sample string 5",
      "Quantity": 6.0,
      "Start_Date": "2025-06-08T01:48:31.8893352+00:00",
      "End_Date": "2025-06-08T01:48:31.8893352+00:00",
      "DrugName": "sample string 7",
      "PrescriptionDetail_Id": "74f5d5ad-72f9-4c8d-a214-47dfa7be0192",
      "Consult_Date": "2025-06-08T01:48:31.8893352+00:00",
      "Authority": "sample string 8",
      "Is_Current": true,
      "DrugCategory_Id": 1,
      "FrequencyUnitType": "sample string 9",
      "DrugCategoryName": "sample string 10"
    },
    {
      "Drug_Id": "e649fb8c-42b2-4827-8207-c57157623dd9",
      "Instructions_Note": "sample string 2",
      "Frequency": 3,
      "FrequencyUnitTypeID": 4,
      "Repeat": "sample string 5",
      "Quantity": 6.0,
      "Start_Date": "2025-06-08T01:48:31.8893352+00:00",
      "End_Date": "2025-06-08T01:48:31.8893352+00:00",
      "DrugName": "sample string 7",
      "PrescriptionDetail_Id": "74f5d5ad-72f9-4c8d-a214-47dfa7be0192",
      "Consult_Date": "2025-06-08T01:48:31.8893352+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": "11075e6c-6bf8-4221-a070-b601a6c279bc",
  "TreatmentDate": "2025-06-08T01:48:31.8893352+00:00",
  "Authority": "sample string 4",
  "PatientID": "ee484725-5a1f-4ecf-b86e-cf4cd0ade9d0",
  "Count": 1,
  "DrugID": "13ee0d8a-42c4-4fc8-b3b7-ee4e56ace510",
  "ApplicationID": "38a0b54b-7a26-4c1f-9dcd-126c626e383a"
}

application/xml, text/xml

Sample:
<TreatmentPlan xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbsoluteHealth.API.Models">
  <ApplicationID>38a0b54b-7a26-4c1f-9dcd-126c626e383a</ApplicationID>
  <Count>1</Count>
  <DrugID>13ee0d8a-42c4-4fc8-b3b7-ee4e56ace510</DrugID>
  <PatientID>ee484725-5a1f-4ecf-b86e-cf4cd0ade9d0</PatientID>
  <Authority>sample string 4</Authority>
  <TreatmentDate>2025-06-08T01:48:31.8893352+00:00</TreatmentDate>
  <TreatmentDetails>
    <TreatmentInfoViewModel>
      <Authority>sample string 8</Authority>
      <Consult_Date>2025-06-08T01:48:31.8893352+00:00</Consult_Date>
      <DrugCategoryName>sample string 10</DrugCategoryName>
      <DrugCategory_Id>1</DrugCategory_Id>
      <DrugName>sample string 7</DrugName>
      <Drug_Id>e649fb8c-42b2-4827-8207-c57157623dd9</Drug_Id>
      <End_Date>2025-06-08T01:48:31.8893352+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>74f5d5ad-72f9-4c8d-a214-47dfa7be0192</PrescriptionDetail_Id>
      <Quantity>6</Quantity>
      <Repeat>sample string 5</Repeat>
      <Start_Date>2025-06-08T01:48:31.8893352+00:00</Start_Date>
    </TreatmentInfoViewModel>
    <TreatmentInfoViewModel>
      <Authority>sample string 8</Authority>
      <Consult_Date>2025-06-08T01:48:31.8893352+00:00</Consult_Date>
      <DrugCategoryName>sample string 10</DrugCategoryName>
      <DrugCategory_Id>1</DrugCategory_Id>
      <DrugName>sample string 7</DrugName>
      <Drug_Id>e649fb8c-42b2-4827-8207-c57157623dd9</Drug_Id>
      <End_Date>2025-06-08T01:48:31.8893352+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>74f5d5ad-72f9-4c8d-a214-47dfa7be0192</PrescriptionDetail_Id>
      <Quantity>6</Quantity>
      <Repeat>sample string 5</Repeat>
      <Start_Date>2025-06-08T01:48:31.8893352+00:00</Start_Date>
    </TreatmentInfoViewModel>
  </TreatmentDetails>
  <TreatmentNote>sample string 2</TreatmentNote>
  <TreatmentPlanID>402cbcf7-7746-476f-b8c6-b4f6af3b5ec5</TreatmentPlanID>
</TreatmentPlan>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'TreatmentPlan'.

Response Information

Resource Description

True on success

boolean

Response Formats

application/json, text/json

Sample:
true

application/xml, text/xml

Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>