POST Clients/Medication?validateOnly={validateOnly}
Add clientMedication
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| validateOnly |
Validate data, but don't post it |
boolean |
Default value is False |
Body Parameters
ClientMedication data
ClientMedicationDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientMedicationID |
Client Medication ID |
integer |
None. |
| ClientID |
Client ID |
integer |
None. |
| IsCustomMedication |
Is Custom Medication |
boolean |
None. |
| MedicationID |
Medication ID |
integer |
None. |
| Status |
Status |
ClientMedicationStatus |
None. |
| MedicationCategory |
Medication Category |
MedicationCategory |
None. |
| MedicationName |
Medication Name |
string |
None. |
| MedicationBrandName |
Medication Brand Name |
string |
None. |
| DrugInformationNumber |
Drug Information Number |
string |
None. |
| MedicationTeachings |
Medication Teachings |
string |
None. |
| DrugFamilyEntryID |
Drug Family Entry ID |
integer |
None. |
| DrugFamilyEntryValue |
Drug Family Entry Value |
string |
None. |
| WebSite |
Web Site |
string |
None. |
| IsOTC |
Is OTC |
boolean |
None. |
| IsNarcotic |
Is Narcotic |
boolean |
None. |
| ClientDiagnosisID |
Client Diagnosis ID |
integer |
None. |
| StartDate |
Start Date |
date |
None. |
| ExpiryDate |
Expiry Date |
date |
None. |
| ProviderContactID |
Provider Contact ID |
integer |
None. |
| ProvidedByContactID |
Provided By Contact ID |
integer |
None. |
| IsMedAdminRequiredProvider |
Is Med Admin Required Provider |
boolean |
None. |
| IsMedAdminRequiredCaregiver |
Is Med Admin Required Caregiver |
boolean |
None. |
| IsMedAdminRequiredSelf |
Is Med Admin Required Self |
boolean |
None. |
| Props |
Props |
Collection of Object |
None. |
| Comments |
Comments |
string |
None. |
| DiscontinuePlannedDateUtc |
Discontinue Planned Date Utc |
date |
None. |
| DiscontinueActualDateUtc |
Discontinue Actual Date Utc |
date |
None. |
| DiscontinueReason |
Discontinue Reason |
string |
None. |
| DiscontinueDocumentedOnUtc |
Discontinue Documented On Utc |
date |
None. |
| DiscontinueDocumentedBy |
Discontinue Documented By |
string |
None. |
| DiscontinueDocumentedUserID |
Discontinue Documented User ID |
integer |
None. |
| Entries |
Medication Entries |
Collection of ClientMedicationEntryDTO |
None. |
| RecordState |
Record State |
ClinicalRecordState |
None. |
| RecordStateReason |
Record State Reason |
string |
None. |
| CreatedByUserID |
Created By User ID |
integer |
None. |
| LastUpdatedByUserID |
Last Updated By User ID |
integer |
None. |
| Created |
Created |
AuditDataDTO |
None. |
| LastUpdated |
Last Updated |
AuditDataDTO |
None. |
| Summary |
Summary |
string |
None. |
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |