GET Clients/CarePlanEntry
Get clientCarePlanEntries 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. |
| ClientCarePlanEntryIDs |
Filter by ClientCarePlanEntryIDs |
Collection of integer |
None. |
| ClientCarePlanID |
Filter by ClientCarePlanID |
integer |
None. |
| ClientID |
Filter by ClientID |
integer |
None. |
| CarePlanID |
Filter by CarePlanID |
integer |
None. |
| CarePlanIDs | Collection of integer |
None. |
|
| CarePlanItemID |
Filter by CarePlanItemID |
integer |
None. |
| StartDateUtcMin |
Filter by StartDateUtcMin |
date |
None. |
| StartDateUtcMax |
Filter by StartDateUtcMax |
date |
None. |
| StopDateUtcMin |
Filter by StopDateUtcMin |
date |
None. |
| StopDateUtcMax |
Filter by StopDateUtcMax |
date |
None. |
| Comments |
Filter by Comments |
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. |
| Sort |
Sort Criteria for searches |
Collection of FindSortByCriteria |
None. |
| MaxRows |
Limit number of rows |
integer |
None. |
Body Parameters
None.
Response Information
Resource Description
List of ClientCarePlanEntryDTOs
Collection of ClientCarePlanEntryDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientCarePlanEntryID |
Client Care Plan Entry ID |
integer |
None. |
| ClientCarePlanID |
Client Care Plan ID |
integer |
None. |
| ClientID |
Client ID |
integer |
None. |
| CarePlanID |
Care Plan ID |
integer |
None. |
| StartDateUtc |
Start Date Utc |
date |
None. |
| StopDateUtc |
Stop Date Utc |
date |
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. |
| ClientCarePlanEntryItems |
Client Care Plan Entry Items |
Collection of ClientCarePlanEntryItemDTO |
None. |
| CarePlanName |
Care Plan Name |
string |
None. |
| Title |
Title |
string |
None. |
| Summary |
Summary |
string |
None. |