GET PlanCare2Api/ClientplansV2?clientId={clientId}

Retrieve all clientplans V2 for the selected client.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	The clientId for whom to fetch the clientplans.	integer	Required

Body Parameters

None.

Response Information

Resource Description

A list of clientplans V2

Collection of ClientplanV2

Name	Description	Type	Additional information
BasicInformationInfo	The basic information part of the clientplan. For read-only purposes only.	ClientplanPartInfo	-
QuestionnaireInfo	The questionnaire information part of the clientplan. For read-only purposes only.	ClientplanPartInfo	-
CareplanInfo	The careplan information part of the clientplan. For read-only purposes only.	ClientplanPartInfo	-
OmahaSystemInfo	The Omaha System information part of the clientplan. For read-only purposes only.	ClientplanPartInfo	-
AgreementsInfo	The agreements information part of the clientplan. For read-only purposes only.	ClientplanPartInfo	-
PrimaryCareInfo	The primary care part of the clientplan. For read-only purposes only.	ClientplanPartInfo	-
InvoluntaryCareInfo	The involuntary care part of the clientplan. For read-only purposes only.	ClientplanPartInfo	-
WorkplanInfo	The workplan information part of the clientplan. For read-only purposes only.	ClientplanPartInfo	-
Id	The internal id of the clientplan.	integer	-
ClientId	The internal id of the client.	Identity	Required
StartDate	The date on which the clientplan takes effect.	date	Required
EndDate	The date on which the clientplan will end or was ended.	date	Nullable
CareDemandsRequired	Determines if CareDemands must be used when creating goals.	boolean	-
SectorName	The name of the sector. For read-only purposes only.	string	-
Name	The name of the clientplan.	string	Required
TypeId	The id of the type of the clientplan.	integer	Required
VisionModelName	The name of the vision model. For read-only purposes only.	string	-
ResponsibleEmployeeName	The name of the responsible employee. For read-only purposes only.	string	-
SectorId	The id of the sector of the clientplan.	integer	Required
VisionModelId	The id of the vision model of the clientplan.	integer	Required
ResponsibleEmployeeId	The responsible employee of the clientplan.	Identity	Required

Response Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "BasicInformationInfo": {
      "$id": "2",
      "TypeId": 1,
      "Name": "sample string 2",
      "IsVisible": true
    },
    "QuestionnaireInfo": {
      "$ref": "2"
    },
    "CareplanInfo": {
      "$ref": "2"
    },
    "OmahaSystemInfo": {
      "$ref": "2"
    },
    "AgreementsInfo": {
      "$ref": "2"
    },
    "PrimaryCareInfo": {
      "$ref": "2"
    },
    "InvoluntaryCareInfo": {
      "$ref": "2"
    },
    "WorkplanInfo": {
      "$ref": "2"
    },
    "Id": 1,
    "ClientId": {
      "$id": "3",
      "Identifier": "sample string 1",
      "Type": 0
    },
    "StartDate": "2026-05-26T22:07:01.1900468+02:00",
    "EndDate": "2026-05-26T22:07:01.1900468+02:00",
    "CareDemandsRequired": true,
    "SectorName": "sample string 4",
    "Name": "sample string 5",
    "TypeId": 6,
    "VisionModelName": "sample string 7",
    "ResponsibleEmployeeName": "sample string 8",
    "SectorId": 9,
    "VisionModelId": 10,
    "ResponsibleEmployeeId": {
      "$ref": "3"
    }
  },
  {
    "$ref": "1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfClientplanV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <ClientplanV2>
    <CareDemandsRequired>true</CareDemandsRequired>
    <ClientId xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
      <d3p1:Identifier>sample string 1</d3p1:Identifier>
      <d3p1:Type>ExternalId</d3p1:Type>
    </ClientId>
    <EndDate>2026-05-26T22:07:01.1900468+02:00</EndDate>
    <Id>1</Id>
    <Name>sample string 5</Name>
    <ResponsibleEmployeeId xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
      <d3p1:Identifier>sample string 1</d3p1:Identifier>
      <d3p1:Type>ExternalId</d3p1:Type>
    </ResponsibleEmployeeId>
    <ResponsibleEmployeeName>sample string 8</ResponsibleEmployeeName>
    <SectorId>9</SectorId>
    <SectorName>sample string 4</SectorName>
    <StartDate>2026-05-26T22:07:01.1900468+02:00</StartDate>
    <TypeId>6</TypeId>
    <VisionModelId>10</VisionModelId>
    <VisionModelName>sample string 7</VisionModelName>
    <AgreementsInfo>
      <IsVisible>true</IsVisible>
      <Name>sample string 2</Name>
      <TypeId>1</TypeId>
    </AgreementsInfo>
    <BasicInformationInfo>
      <IsVisible>true</IsVisible>
      <Name>sample string 2</Name>
      <TypeId>1</TypeId>
    </BasicInformationInfo>
    <CareplanInfo>
      <IsVisible>true</IsVisible>
      <Name>sample string 2</Name>
      <TypeId>1</TypeId>
    </CareplanInfo>
    <InvoluntaryCareInfo>
      <IsVisible>true</IsVisible>
      <Name>sample string 2</Name>
      <TypeId>1</TypeId>
    </InvoluntaryCareInfo>
    <OmahaSystemInfo>
      <IsVisible>true</IsVisible>
      <Name>sample string 2</Name>
      <TypeId>1</TypeId>
    </OmahaSystemInfo>
    <PrimaryCareInfo>
      <IsVisible>true</IsVisible>
      <Name>sample string 2</Name>
      <TypeId>1</TypeId>
    </PrimaryCareInfo>
    <QuestionnaireInfo>
      <IsVisible>true</IsVisible>
      <Name>sample string 2</Name>
      <TypeId>1</TypeId>
    </QuestionnaireInfo>
    <WorkplanInfo>
      <IsVisible>true</IsVisible>
      <Name>sample string 2</Name>
      <TypeId>1</TypeId>
    </WorkplanInfo>
  </ClientplanV2>
  <ClientplanV2>
    <CareDemandsRequired>true</CareDemandsRequired>
    <ClientId xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
      <d3p1:Identifier>sample string 1</d3p1:Identifier>
      <d3p1:Type>ExternalId</d3p1:Type>
    </ClientId>
    <EndDate>2026-05-26T22:07:01.1900468+02:00</EndDate>
    <Id>1</Id>
    <Name>sample string 5</Name>
    <ResponsibleEmployeeId xmlns:d3p1="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Common.Infrastructure">
      <d3p1:Identifier>sample string 1</d3p1:Identifier>
      <d3p1:Type>ExternalId</d3p1:Type>
    </ResponsibleEmployeeId>
    <ResponsibleEmployeeName>sample string 8</ResponsibleEmployeeName>
    <SectorId>9</SectorId>
    <SectorName>sample string 4</SectorName>
    <StartDate>2026-05-26T22:07:01.1900468+02:00</StartDate>
    <TypeId>6</TypeId>
    <VisionModelId>10</VisionModelId>
    <VisionModelName>sample string 7</VisionModelName>
    <AgreementsInfo>
      <IsVisible>true</IsVisible>
      <Name>sample string 2</Name>
      <TypeId>1</TypeId>
    </AgreementsInfo>
    <BasicInformationInfo>
      <IsVisible>true</IsVisible>
      <Name>sample string 2</Name>
      <TypeId>1</TypeId>
    </BasicInformationInfo>
    <CareplanInfo>
      <IsVisible>true</IsVisible>
      <Name>sample string 2</Name>
      <TypeId>1</TypeId>
    </CareplanInfo>
    <InvoluntaryCareInfo>
      <IsVisible>true</IsVisible>
      <Name>sample string 2</Name>
      <TypeId>1</TypeId>
    </InvoluntaryCareInfo>
    <OmahaSystemInfo>
      <IsVisible>true</IsVisible>
      <Name>sample string 2</Name>
      <TypeId>1</TypeId>
    </OmahaSystemInfo>
    <PrimaryCareInfo>
      <IsVisible>true</IsVisible>
      <Name>sample string 2</Name>
      <TypeId>1</TypeId>
    </PrimaryCareInfo>
    <QuestionnaireInfo>
      <IsVisible>true</IsVisible>
      <Name>sample string 2</Name>
      <TypeId>1</TypeId>
    </QuestionnaireInfo>
    <WorkplanInfo>
      <IsVisible>true</IsVisible>
      <Name>sample string 2</Name>
      <TypeId>1</TypeId>
    </WorkplanInfo>
  </ClientplanV2>
</ArrayOfClientplanV2>