PUT Clients/Medication/{clientMedicationID}?validateOnly={validateOnly}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientMedicationID | integer |
Required |
|
| validateOnly | boolean |
Default value is False |
Body Parameters
ClientMedicationDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientMedicationID | integer |
None. |
|
| ClientID | integer |
None. |
|
| IsCustomMedication | boolean |
None. |
|
| MedicationID | integer |
None. |
|
| Status | ClientMedicationStatus |
None. |
|
| MedicationCategory | MedicationCategory |
None. |
|
| MedicationName | string |
None. |
|
| MedicationBrandName | string |
None. |
|
| DrugInformationNumber | string |
None. |
|
| MedicationTeachings | string |
None. |
|
| DrugFamilyEntryID | integer |
None. |
|
| DrugFamilyEntryValue | string |
None. |
|
| WebSite | string |
None. |
|
| IsOTC | boolean |
None. |
|
| IsNarcotic | boolean |
None. |
|
| ClientDiagnosisID | integer |
None. |
|
| StartDate | date |
None. |
|
| ExpiryDate | date |
None. |
|
| ProviderContactID | integer |
None. |
|
| ProvidedByContactID | integer |
None. |
|
| IsMedAdminRequiredProvider | boolean |
None. |
|
| IsMedAdminRequiredCaregiver | boolean |
None. |
|
| IsMedAdminRequiredSelf | boolean |
None. |
|
| Props | Collection of Object |
None. |
|
| Comments | string |
None. |
|
| DiscontinuePlannedDateUtc | date |
None. |
|
| DiscontinueActualDateUtc | date |
None. |
|
| DiscontinueReason | string |
None. |
|
| DiscontinueDocumentedOnUtc | date |
None. |
|
| DiscontinueDocumentedBy | string |
None. |
|
| DiscontinueDocumentedUserID | integer |
None. |
|
| Entries | Collection of ClientMedicationEntryDTO |
None. |
|
| RecordState | ClinicalRecordState |
None. |
|
| RecordStateReason | string |
None. |
|
| CreatedByUserID | integer |
None. |
|
| LastUpdatedByUserID | integer |
None. |
|
| Created | AuditDataDTO |
None. |
|
| LastUpdated | AuditDataDTO |
None. |
|
| Summary | string |
None. |
Request Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
application/x-www-form-urlencoded
Sample:
Sample not available.
application/x-compressed-json
Sample:
Sample not available.
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. |