GET PlanCare2Api/ClientplansV2/{clientplanId}/Careplans/{clientplanPartId}/CareDemands
Retrieve all care demands V2 for the selected clientplan.
Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientplanPartId |
The client planpart V2 Identifier. |
integer |
Required |
| clientplanId |
The client plan V2 Identifier. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
A list of care demands V2
Collection of CareDemand| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The id of the CareDemand. |
integer |
- |
| TemplateCareDemandId |
The id of the template CareDemand. |
integer |
Nullable |
| DomainId |
The id of the Domain. |
integer |
- |
| Name |
The name of the CareDemand. |
string |
- |
| Goals |
The Goals of the CareDemand. |
Collection of GoalV2 |
- |
| DomainName |
The name of the Domain. |
string |
- |
| Explanation |
The explanation of the CareDemand. |
string |
- |
| QuestionnaireCareDemandId |
The id of the Questionnaire CareDemand. |
integer |
Nullable |
| QuestionnaireName |
The name of the questionnaire. |
string |
- |
| QuestionnaireStatusDescription |
The status description of the questionnaire. |
string |
- |
Response Formats
application/json, text/json
Sample:
[
{
"$id": "1",
"Id": 1,
"TemplateCareDemandId": 1,
"DomainId": 2,
"Name": "sample string 3",
"Goals": [
{
"$id": "2",
"Id": 1,
"AggregateId": "2fb755e5-83ca-4c66-a43c-9ccf95b1e94e",
"CareDemandName": "sample string 3",
"CareDemandId": 4,
"CareDemandExplanation": "sample string 5",
"TemplateGoalId": 1,
"PreviousGoalId": 1,
"QuestionnaireGoalId": 1,
"StartDate": "2026-05-26T23:19:12.5019003+02:00",
"EndDate": "2026-05-26T23:19:12.5019003+02:00",
"Name": "sample string 6",
"Status": 0,
"StatusDescription": "sample string 7",
"StatusDate": "2026-05-26T23:19:12.5019003+02:00",
"InitialSituation": "sample string 9",
"TargetSituation": "sample string 10",
"DisciplineIds": [
1,
2
],
"DisciplineGroupIds": [
1,
2
],
"LatestScore": {
"$id": "3",
"Color": 1,
"Description": "sample string 2",
"Value": 3,
"Rank": 4,
"Name": "sample string 5"
},
"MainGoalId": "c5527124-27cb-4fcc-8647-531d62707ede",
"MainGoal": "sample string 11"
},
{
"$ref": "2"
}
],
"DomainName": "sample string 4",
"Explanation": "sample string 5",
"QuestionnaireCareDemandId": 1,
"QuestionnaireName": "sample string 6",
"QuestionnaireStatusDescription": "sample string 7"
},
{
"$ref": "1"
}
]
application/xml, text/xml
Sample:
<ArrayOfCareDemand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
<CareDemand>
<DomainId>2</DomainId>
<DomainName>sample string 4</DomainName>
<Explanation>sample string 5</Explanation>
<Goals>
<GoalV2>
<AggregateId>2fb755e5-83ca-4c66-a43c-9ccf95b1e94e</AggregateId>
<CareDemandExplanation>sample string 5</CareDemandExplanation>
<CareDemandId>4</CareDemandId>
<CareDemandName>sample string 3</CareDemandName>
<DisciplineGroupIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:long>1</d5p1:long>
<d5p1:long>2</d5p1:long>
</DisciplineGroupIds>
<DisciplineIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:long>1</d5p1:long>
<d5p1:long>2</d5p1:long>
</DisciplineIds>
<EndDate>2026-05-26T23:19:12.5019003+02:00</EndDate>
<Id>1</Id>
<InitialSituation>sample string 9</InitialSituation>
<LatestScore>
<Color>1</Color>
<Description>sample string 2</Description>
<Name>sample string 5</Name>
<Rank>4</Rank>
<Value>3</Value>
</LatestScore>
<MainGoal>sample string 11</MainGoal>
<MainGoalId>c5527124-27cb-4fcc-8647-531d62707ede</MainGoalId>
<Name>sample string 6</Name>
<PreviousGoalId>1</PreviousGoalId>
<QuestionnaireGoalId>1</QuestionnaireGoalId>
<StartDate>2026-05-26T23:19:12.5019003+02:00</StartDate>
<Status>Concept</Status>
<StatusDate>2026-05-26T23:19:12.5019003+02:00</StatusDate>
<StatusDescription>sample string 7</StatusDescription>
<TargetSituation>sample string 10</TargetSituation>
<TemplateGoalId>1</TemplateGoalId>
</GoalV2>
<GoalV2>
<AggregateId>2fb755e5-83ca-4c66-a43c-9ccf95b1e94e</AggregateId>
<CareDemandExplanation>sample string 5</CareDemandExplanation>
<CareDemandId>4</CareDemandId>
<CareDemandName>sample string 3</CareDemandName>
<DisciplineGroupIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:long>1</d5p1:long>
<d5p1:long>2</d5p1:long>
</DisciplineGroupIds>
<DisciplineIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:long>1</d5p1:long>
<d5p1:long>2</d5p1:long>
</DisciplineIds>
<EndDate>2026-05-26T23:19:12.5019003+02:00</EndDate>
<Id>1</Id>
<InitialSituation>sample string 9</InitialSituation>
<LatestScore>
<Color>1</Color>
<Description>sample string 2</Description>
<Name>sample string 5</Name>
<Rank>4</Rank>
<Value>3</Value>
</LatestScore>
<MainGoal>sample string 11</MainGoal>
<MainGoalId>c5527124-27cb-4fcc-8647-531d62707ede</MainGoalId>
<Name>sample string 6</Name>
<PreviousGoalId>1</PreviousGoalId>
<QuestionnaireGoalId>1</QuestionnaireGoalId>
<StartDate>2026-05-26T23:19:12.5019003+02:00</StartDate>
<Status>Concept</Status>
<StatusDate>2026-05-26T23:19:12.5019003+02:00</StatusDate>
<StatusDescription>sample string 7</StatusDescription>
<TargetSituation>sample string 10</TargetSituation>
<TemplateGoalId>1</TemplateGoalId>
</GoalV2>
</Goals>
<Id>1</Id>
<Name>sample string 3</Name>
<QuestionnaireCareDemandId>1</QuestionnaireCareDemandId>
<QuestionnaireName>sample string 6</QuestionnaireName>
<QuestionnaireStatusDescription>sample string 7</QuestionnaireStatusDescription>
<TemplateCareDemandId>1</TemplateCareDemandId>
</CareDemand>
<CareDemand>
<DomainId>2</DomainId>
<DomainName>sample string 4</DomainName>
<Explanation>sample string 5</Explanation>
<Goals>
<GoalV2>
<AggregateId>2fb755e5-83ca-4c66-a43c-9ccf95b1e94e</AggregateId>
<CareDemandExplanation>sample string 5</CareDemandExplanation>
<CareDemandId>4</CareDemandId>
<CareDemandName>sample string 3</CareDemandName>
<DisciplineGroupIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:long>1</d5p1:long>
<d5p1:long>2</d5p1:long>
</DisciplineGroupIds>
<DisciplineIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:long>1</d5p1:long>
<d5p1:long>2</d5p1:long>
</DisciplineIds>
<EndDate>2026-05-26T23:19:12.5019003+02:00</EndDate>
<Id>1</Id>
<InitialSituation>sample string 9</InitialSituation>
<LatestScore>
<Color>1</Color>
<Description>sample string 2</Description>
<Name>sample string 5</Name>
<Rank>4</Rank>
<Value>3</Value>
</LatestScore>
<MainGoal>sample string 11</MainGoal>
<MainGoalId>c5527124-27cb-4fcc-8647-531d62707ede</MainGoalId>
<Name>sample string 6</Name>
<PreviousGoalId>1</PreviousGoalId>
<QuestionnaireGoalId>1</QuestionnaireGoalId>
<StartDate>2026-05-26T23:19:12.5019003+02:00</StartDate>
<Status>Concept</Status>
<StatusDate>2026-05-26T23:19:12.5019003+02:00</StatusDate>
<StatusDescription>sample string 7</StatusDescription>
<TargetSituation>sample string 10</TargetSituation>
<TemplateGoalId>1</TemplateGoalId>
</GoalV2>
<GoalV2>
<AggregateId>2fb755e5-83ca-4c66-a43c-9ccf95b1e94e</AggregateId>
<CareDemandExplanation>sample string 5</CareDemandExplanation>
<CareDemandId>4</CareDemandId>
<CareDemandName>sample string 3</CareDemandName>
<DisciplineGroupIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:long>1</d5p1:long>
<d5p1:long>2</d5p1:long>
</DisciplineGroupIds>
<DisciplineIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:long>1</d5p1:long>
<d5p1:long>2</d5p1:long>
</DisciplineIds>
<EndDate>2026-05-26T23:19:12.5019003+02:00</EndDate>
<Id>1</Id>
<InitialSituation>sample string 9</InitialSituation>
<LatestScore>
<Color>1</Color>
<Description>sample string 2</Description>
<Name>sample string 5</Name>
<Rank>4</Rank>
<Value>3</Value>
</LatestScore>
<MainGoal>sample string 11</MainGoal>
<MainGoalId>c5527124-27cb-4fcc-8647-531d62707ede</MainGoalId>
<Name>sample string 6</Name>
<PreviousGoalId>1</PreviousGoalId>
<QuestionnaireGoalId>1</QuestionnaireGoalId>
<StartDate>2026-05-26T23:19:12.5019003+02:00</StartDate>
<Status>Concept</Status>
<StatusDate>2026-05-26T23:19:12.5019003+02:00</StatusDate>
<StatusDescription>sample string 7</StatusDescription>
<TargetSituation>sample string 10</TargetSituation>
<TemplateGoalId>1</TemplateGoalId>
</GoalV2>
</Goals>
<Id>1</Id>
<Name>sample string 3</Name>
<QuestionnaireCareDemandId>1</QuestionnaireCareDemandId>
<QuestionnaireName>sample string 6</QuestionnaireName>
<QuestionnaireStatusDescription>sample string 7</QuestionnaireStatusDescription>
<TemplateCareDemandId>1</TemplateCareDemandId>
</CareDemand>
</ArrayOfCareDemand>