GET Clients/MedicationEntry
Get clientMedicationEntries 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. |
| ClientMedicationEntries |
Filter by ClientMedicationEntries |
Collection of integer |
None. |
| ClientID |
Filter by ClientID |
integer |
None. |
| ClientMedications |
Filter by ClientMedications |
Collection of integer |
None. |
| MedicationCategory |
Filter by MedicationCategory |
MedicationCategory |
None. |
| AdministeredOnUtcMin |
Filter by AdministeredOnUtcMin |
date |
None. |
| AdministeredOnUtcMax |
Filter by AdministeredOnUtcMax |
date |
None. |
| AdministeredBy |
Filter by AdministeredBy |
MedicationAdministeredBy |
None. |
| IsAdministered |
Filter by IsAdministered |
boolean |
None. |
| Props |
Filter by Props |
Collection of Object |
None. |
| Comments |
Filter by Comments |
string |
None. |
| RecordState |
Filter by RecordState |
ClinicalRecordState |
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. |
Body Parameters
None.
Response Information
Resource Description
List of ClientMedicationEntryDTOs
Collection of ClientMedicationEntryDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientMedicationEntryID |
Client Medication Entry ID |
integer |
None. |
| ClientMedicationID |
Client Medication ID |
integer |
None. |
| MedicationCategory |
Medication Category |
MedicationCategory |
None. |
| AdministeredOnUtc |
Administered On Utc |
date |
None. |
| AdministeredBy |
Administered By |
MedicationAdministeredBy |
None. |
| IsAdministered |
Is Administered |
boolean |
None. |
| Props |
Props |
Collection of Object |
None. |
| Comments |
Comments |
string |
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. |