GET Clients/Medication
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| IncludeActive | boolean |
None. |
|
| IncludeInactive | boolean |
None. |
|
| IncludeDeleted | boolean |
None. |
|
| IncludeError | boolean |
None. |
|
| Match | MatchCriteriaStringType |
None. |
|
| ClientMedications | Collection of integer |
None. |
|
| ClientID | integer |
None. |
|
| IsCustomMedication | boolean |
None. |
|
| MedicationID | integer |
None. |
|
| Status | ClientMedicationStatus |
None. |
|
| MedicationCategory | MedicationCategory |
None. |
|
| MedicationName | string |
None. |
|
| MedicationBrandName | string |
None. |
|
| DrugFamilyEntryID | integer |
None. |
|
| IsOTC | boolean |
None. |
|
| IsNarcotic | boolean |
None. |
|
| ClientDiagnosisID | integer |
None. |
|
| StartDateMin | date |
None. |
|
| StartDateMax | date |
None. |
|
| ExpiryDateMin | date |
None. |
|
| ExpiryDateMax | date |
None. |
|
| ProviderContactID | integer |
None. |
|
| ProvidedByContactID | integer |
None. |
|
| Props | Collection of Object |
None. |
|
| Comments | string |
None. |
|
| DiscontinuePlannedDateUtcMin | date |
None. |
|
| DiscontinuePlannedDateUtcMax | date |
None. |
|
| DiscontinueActualDateUtcMin | date |
None. |
|
| DiscontinueActualDateUtcMax | date |
None. |
|
| DiscontinueReason | string |
None. |
|
| DiscontinueDocumentedOnUtcMin | date |
None. |
|
| DiscontinueDocumentedOnUtcMax | date |
None. |
|
| DiscontinueDocumentedBy | string |
None. |
|
| DiscontinueDocumentedUserID | integer |
None. |
|
| RecordStateReason | string |
None. |
|
| CreatedByUserID | integer |
None. |
|
| LastUpdatedByUserID | integer |
None. |
|
| CreatedDateUtcMin | date |
None. |
|
| CreatedDateUtcMax | date |
None. |
|
| LastUpdatedDateUtcMin | date |
None. |
|
| LastUpdatedDateUtcMax | date |
None. |
|
| IncludePayload | boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of 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. |
Response 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-compressed-json
Sample:
Sample not available.