GET CarePlans/ItemLink
Get carePlanItemLinks 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. |
Match |
When searching by string, include records based on match type |
MatchCriteriaStringType |
None. |
CarePlanItemLinkIDs |
Filter by CarePlanItemLinkIDs |
Collection of integer |
None. |
CarePlanID |
Filter by CarePlanID |
integer |
None. |
CarePlans |
Filter by CarePlan.CarePlanIDs |
Collection of integer |
None. |
CarePlanItemID |
Filter by CarePlanItemID |
integer |
None. |
ParentCarePlanItemLinkID |
Filter by ParentCarePlanItemLinkID |
integer |
None. |
ParentCarePlanItemLinkIDs |
Filter by ParentCarePlanItemLinkIDs |
Collection of integer |
None. |
IsDefault |
Filter by IsDefault |
boolean |
None. |
IsRequired |
Filter by IsRequired |
boolean |
None. |
IsCustom |
Filter by IsCustom |
boolean |
None. |
IsCustomOnly |
Filter by IsCustomOnly |
boolean |
None. |
ClientCarePlanID |
Filter by ClientCarePlanID |
integer |
None. |
SortOrder |
Filter by SortOrder |
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 CarePlanItemLinkDTOs
Collection of CarePlanItemLinkDTOName | Description | Type | Additional information |
---|---|---|---|
CarePlanItemLinkID |
Care Plan Item Link ID |
integer |
None. |
CarePlanID |
Care Plan ID |
integer |
None. |
CarePlanName |
Care Plan Name |
string |
None. |
CarePlanTitle |
Care Plan Title |
string |
None. |
CarePlanItemID |
Care Plan Item ID |
integer |
None. |
ParentCarePlanItemLinkID |
Parent Care Plan Item Link ID |
integer |
None. |
IsDefault |
Is Default |
boolean |
None. |
IsRequired |
Is Required |
boolean |
None. |
SortOrder |
Sort Order |
integer |
None. |
RecordState |
Record State |
RecordState |
None. |
Created |
Created |
AuditDataDTO |
None. |
LastUpdated |
Last Updated |
AuditDataDTO |
None. |
CarePlanItemName |
Care Plan Item Name |
string |
None. |
CarePlanItemCaption |
Care Plan Item Caption |
string |
None. |
CarePlanItemType |
Care Plan Item Type |
CarePlanItemType |
None. |
CarePlanItemAnswerType |
Care Plan Item Answer Type |
CarePlanItemAnswerType |
None. |
CarePlanItemCategoryID |
Care Plan Item Category ID |
integer |
None. |
CategoryName |
Category Name |
string |
None. |
CategoryDescription |
Category Description |
string |
None. |
CarePlanItemIsCustom | boolean |
None. |
|
Summary |
Summary |
string |
None. |