GET Clients/Medication
Get clientMedications from criteria
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| IncludeActive |
Include records where RecordState == RecordState.Active |
boolean |
None. |
| IncludeInactive |
Include records where RecordState == RecordState.Inactive |
boolean |
None. |
| IncludeDeleted |
Include records where RecordState == RecordState.Deleted |
boolean |
None. |
| IncludeError |
Include records where RecordState == RecordState.Error |
boolean |
None. |
| Match |
When searching by string, include records based on match type |
MatchCriteriaStringType |
None. |
| ClientMedications |
Filter by ClientMedicationIDs |
Collection of integer |
None. |
| ClientID |
Filter by ClientID |
integer |
None. |
| IsCustomMedication |
Filter by IsCustomMedication |
boolean |
None. |
| MedicationID |
Filter by MedicationID |
integer |
None. |
| Status |
Filter by Status |
ClientMedicationStatus |
None. |
| MedicationCategory |
Filter by MedicationCategory |
MedicationCategory |
None. |
| MedicationName |
Filter by MedicationName |
string |
None. |
| MedicationBrandName |
Filter by MedicationBrandName |
string |
None. |
| DrugFamilyEntryID |
Filter by DrugFamilyEntryID |
integer |
None. |
| IsOTC |
Filter by IsOTC |
boolean |
None. |
| IsNarcotic |
Filter by IsNarcotic |
boolean |
None. |
| ClientDiagnosisID |
Filter by ClientDiagnosisID |
integer |
None. |
| StartDateMin |
Filter by StartDateMin |
date |
None. |
| StartDateMax |
Filter by StartDateMax |
date |
None. |
| ExpiryDateMin |
Filter by ExpiryDateMin |
date |
None. |
| ExpiryDateMax |
Filter by ExpiryDateMax |
date |
None. |
| ProviderContactID |
Filter by ProviderContactID |
integer |
None. |
| ProvidedByContactID |
Filter by ProvidedByContactID |
integer |
None. |
| Props |
Filter by Props |
Collection of Object |
None. |
| Comments |
Filter by Comments |
string |
None. |
| DiscontinuePlannedDateUtcMin |
Filter by DiscontinuePlannedDateUtcMin |
date |
None. |
| DiscontinuePlannedDateUtcMax |
Filter by DiscontinuePlannedDateUtcMax |
date |
None. |
| DiscontinueActualDateUtcMin |
Filter by DiscontinueActualDateUtcMin |
date |
None. |
| DiscontinueActualDateUtcMax |
Filter by DiscontinueActualDateUtcMax |
date |
None. |
| DiscontinueReason |
Filter by DiscontinueReason |
string |
None. |
| DiscontinueDocumentedOnUtcMin |
Filter by DiscontinueDocumentedOnUtcMin |
date |
None. |
| DiscontinueDocumentedOnUtcMax |
Filter by DiscontinueDocumentedOnUtcMax |
date |
None. |
| DiscontinueDocumentedBy |
Filter by DiscontinueDocumentedBy |
string |
None. |
| DiscontinueDocumentedUserID |
Filter by DiscontinueDocumentedUserID |
integer |
None. |
| RecordStateReason |
Filter by RecordStateReason |
string |
None. |
| CreatedByUserID |
Filter by CreatedByUserID |
integer |
None. |
| LastUpdatedByUserID |
Filter by LastUpdatedByUserID |
integer |
None. |
| CreatedDateUtcMin |
Filter by CreatedDateUtcMin |
date |
None. |
| CreatedDateUtcMax |
Filter by CreatedDateUtcMax |
date |
None. |
| LastUpdatedDateUtcMin |
Filter by LastUpdatedDateUtcMin |
date |
None. |
| LastUpdatedDateUtcMax |
Filter by LastUpdatedDateUtcMax |
date |
None. |
| IncludePayload |
Include payload |
boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
List of ClientMedicationDTOs
Collection of 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. |