GET CarePlans/CarePlan

Get carePlans 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.
CarePlanIDs	Filter by CarePlanIDs	Collection of integer	None.
CarePlanNames	Filter by CarePlan names	Collection of string	None.
CarePlanResponseCodeTableID	Filter by CarePlanResponseCodeTableID	integer	None.
CarePlanName	Filter by CarePlanName	string	None.
Type	Filter by Type	CarePlanType	None.
Title	Filter by Title	string	None.
Props	Filter by Props	Collection of Object	None.
BusinessUnits	Filter by BusinessUnit(s)	Collection of integer	None.
SortOrder	Filter by SortOrder	integer	None.
Comments	Filter by Comments	string	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 CarePlanDTOs

Collection of CarePlanDTO

Name	Description	Type	Additional information
CarePlanID	Care Plan ID	integer	None.
CarePlanResponseCodeTableID	Care Plan Response Code Table ID	integer	None.
CarePlanResponseCodeTableName	Care Plan Response Code Table Name	string	None.
CarePlanName	Care Plan Name	string	None.
Type	Type	CarePlanType	None.
Title	Title	string	None.
Props	Props	Collection of Object	None.
SortOrder	Sort Order	integer	None.
Comments	Comments	string	None.
RecordState	Record State	RecordState	None.
Created	Created	AuditDataDTO	None.
LastUpdated	Last Updated	AuditDataDTO	None.
BusinessUnits	Business units	Collection of CarePlanBusinessUnitDTO	None.
CarePlanItems	Care Plan Items	Collection of CarePlanItemLinkDTO	None.
ResponseSubCodes	Care Plan Response Sub Codes	Collection of CarePlanResponseSubCodeDTO	None.
Summary	Summary	string	None.