POST Api/Medication

Create/Update a patient medication.

Request Information

URI Parameters

None.

Body Parameters

Patient Medication Data.

PatientMedicationRequest
NameDescriptionTypeAdditional information
AccountName

Gets or sets Account Name.

string

None.

ProviderUniqueId

Gets or sets Provider Unique Id (e.g. MRN).

string

None.

AlertId

Gets or sets alert Id.

integer

None.

Comments

Gets or sets Comments.

string

None.

DeliveredDate

Gets or sets Delivered Date.

date

None.

Dosage

Gets or sets Dosage.

string

None.

EndDate

Gets or sets End Date.

date

None.

FillNo

Gets or sets Fill No.

integer

None.

Frequency

Gets or sets Frequency.

string

None.

IsPrescription

Gets or sets a value indicating whether Is Subscription.

boolean

None.

MedicationName

Gets or sets Medication Name.

string

None.

NDCCode

Gets or sets NDC Code.

string

None.

NoLongerTaking

Gets or sets a value indicating whether No Longer Taking.

boolean

None.

OrderedDate

Gets or sets Ordered Date.

date

None.

Quantity

Gets or sets Quantity.

decimal number

None.

ReconciliationDate

Gets or sets Reconciliation Date.

date

None.

RefillNo

Gets or sets Refill No.

integer

None.

RouteOfAdministration

Gets or sets Route of Administration.

string

None.

RXNumber

Gets or sets RX Number.

string

None.

StartDate

Gets or sets Start Date.

date

None.

TakenDosage

Gets or sets Taken Dosage.

integer

None.

TimeTaken

Gets or sets Taken Time.

string

None.

TimeTaken2

Gets or sets Taken Time 2.

string

None.

TimeTaken3

Gets or sets Taken Time 3.

string

None.

TimeTaken4

Gets or sets Taken Time 4.

string

None.

TotalDosage

Gets or sets Total Dosage.

integer

None.

Unit

Gets or sets Unit.

string

None.

EmrName

Gets or sets EMR Name (e.g. "HCHB").

string

None.

Request Formats

application/json, text/json

Sample:
{
  "AccountName": "sample string 1",
  "ProviderUniqueId": "sample string 2",
  "AlertId": 3,
  "Comments": "sample string 4",
  "DeliveredDate": "2025-06-14T23:07:17.252661-05:00",
  "Dosage": "sample string 5",
  "EndDate": "2025-06-14T23:07:17.252661-05:00",
  "FillNo": 1,
  "Frequency": "sample string 6",
  "IsPrescription": true,
  "MedicationName": "sample string 8",
  "NDCCode": "sample string 9",
  "NoLongerTaking": true,
  "OrderedDate": "2025-06-14T23:07:17.252661-05:00",
  "Quantity": 1.0,
  "ReconciliationDate": "2025-06-14T23:07:17.252661-05:00",
  "RefillNo": 1,
  "RouteOfAdministration": "sample string 11",
  "RXNumber": "sample string 12",
  "StartDate": "2025-06-14T23:07:17.252661-05:00",
  "TakenDosage": 1,
  "TimeTaken": "sample string 13",
  "TimeTaken2": "sample string 14",
  "TimeTaken3": "sample string 15",
  "TimeTaken4": "sample string 16",
  "TotalDosage": 1,
  "Unit": "sample string 17",
  "EmrName": "sample string 18"
}

application/xml, text/xml

Sample:
<PatientMedicationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPC.API.Models">
  <AccountName>sample string 1</AccountName>
  <AlertId>3</AlertId>
  <Comments>sample string 4</Comments>
  <DeliveredDate>2025-06-14T23:07:17.252661-05:00</DeliveredDate>
  <Dosage>sample string 5</Dosage>
  <EmrName>sample string 18</EmrName>
  <EndDate>2025-06-14T23:07:17.252661-05:00</EndDate>
  <FillNo>1</FillNo>
  <Frequency>sample string 6</Frequency>
  <IsPrescription>true</IsPrescription>
  <MedicationName>sample string 8</MedicationName>
  <NDCCode>sample string 9</NDCCode>
  <NoLongerTaking>true</NoLongerTaking>
  <OrderedDate>2025-06-14T23:07:17.252661-05:00</OrderedDate>
  <ProviderUniqueId>sample string 2</ProviderUniqueId>
  <Quantity>1</Quantity>
  <RXNumber>sample string 12</RXNumber>
  <ReconciliationDate>2025-06-14T23:07:17.252661-05:00</ReconciliationDate>
  <RefillNo>1</RefillNo>
  <RouteOfAdministration>sample string 11</RouteOfAdministration>
  <StartDate>2025-06-14T23:07:17.252661-05:00</StartDate>
  <TakenDosage>1</TakenDosage>
  <TimeTaken>sample string 13</TimeTaken>
  <TimeTaken2>sample string 14</TimeTaken2>
  <TimeTaken3>sample string 15</TimeTaken3>
  <TimeTaken4>sample string 16</TimeTaken4>
  <TotalDosage>1</TotalDosage>
  <Unit>sample string 17</Unit>
</PatientMedicationRequest>

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 'PatientMedicationRequest'.

Response Information

Resource Description

TPC Response.

TPCResponse
NameDescriptionTypeAdditional information
result

string

None.

error_code

integer

None.

message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "result": "sample string 1",
  "error_code": 1,
  "message": "sample string 2"
}

application/xml, text/xml

Sample:
<TPCResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPC.API.Models">
  <error_code>1</error_code>
  <message>sample string 2</message>
  <result>sample string 1</result>
</TPCResponse>