GET Clients/CarePlanEntryItemNote
Get clientCarePlanEntryItemNotes 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. |
| IncludeCarePlanDetails |
Include Care Plan related details which will be slower due to the flatenned DTO. |
boolean |
None. |
| Match |
When searching by string, include records based on match type |
MatchCriteriaStringType |
None. |
| ClientCarePlanEntryItemNoteIDs |
Filter by ClientCarePlanEntryItemNoteIDs |
Collection of integer |
None. |
| ClientCarePlanEntryIDs |
Filter by ClientCarePlanEntryIDs |
Collection of integer |
None. |
| ClientCarePlanEntryID |
Filter by ClientCarePlanEntryID |
integer |
None. |
| CarePlanItemID |
Filter by CarePlanItemID |
integer |
None. |
| Contents |
Filter by Contents |
string |
None. |
| CarePlanIDs |
Filter by CarePlanIDs |
Collection of integer |
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 ClientCarePlanEntryItemNoteDTOs
Collection of ClientCarePlanEntryItemNoteDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientCarePlanEntryItemNoteID |
Client Care Plan Entry Item Note ID |
integer |
None. |
| ClientCarePlanEntryID |
Client Care Plan Entry ID |
integer |
None. |
| CarePlanItemID |
Care Plan Item ID |
integer |
None. |
| Contents |
Contents |
string |
None. |
| CarePlanItemType |
Type |
CarePlanItemType |
None. |
| CarePlanName |
Care Plan Name |
string |
None. |
| CarePlanItemName |
Care Plan Item Name |
string |
None. |
| CarePlanItemCaption |
Caption |
string |
None. |
| RecordState |
Record State |
ClinicalRecordState |
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. |