POST PlanCare2Api/ClientplansV2/{clientplanId}/Careplans/{careplanId}/Domains/{domainId}/Goals

Saves a new goal.

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

Request Information

URI Parameters

Name	Description	Type	Additional information
clientplanId	The client plan V2 ID.	integer	Required
careplanId	The careplan ID.	integer	Required
domainId	The vision model domain ID.	integer	Required

Body Parameters

The goal to save.

GoalV2

Name	Description	Type	Additional information
Id	The id of the goal.	integer	Deprecated: Please use 'AggregateId' instead.
AggregateId	The aggregateId of the goal.	globally unique identifier	None
CareDemandName	The name of the CareDemand.	string	Required
CareDemandId	The id of the CareDemand.	integer	Required
CareDemandExplanation	The remarks of the CareDemand	string	None
TemplateGoalId	The id of the TemplateGoal.	integer	None
PreviousGoalId	The id of the previous Goal.	integer	None
QuestionnaireGoalId	The id of the QuestionnaireGoal.	integer	None
StartDate	The start date of the Goal.	date	None
EndDate	The end date of the Goal.	date	None
Name	The name of the Goal.	string	Required
Status	The state of the Goal.	string	None
StatusDescription	The description of the state of the Goal.	string	None
StatusDate	The status date of the Goal.	date	None
InitialSituation	The initial situation.	string	None
TargetSituation	The target situation.	string	None
DisciplineIds	The ids of the disciplines.	Collection of integer	None
DisciplineGroupIds	The ids of the discipline groups.	Collection of integer	None
LatestScore	The latest score of the Goal.	Score	None
MainGoalId	The id of the MainGoal	globally unique identifier	None
MainGoal	The name of the MainGoal	string	None

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "AggregateId": "95249a59-dec8-4887-a5d9-8cb9f42107b2",
  "CareDemandName": "sample string 3",
  "CareDemandId": 4,
  "CareDemandExplanation": "sample string 5",
  "TemplateGoalId": 1,
  "PreviousGoalId": 1,
  "QuestionnaireGoalId": 1,
  "StartDate": "2026-05-26T22:10:12.8537336+02:00",
  "EndDate": "2026-05-26T22:10:12.8537336+02:00",
  "Name": "sample string 6",
  "Status": "sample string 7",
  "StatusDescription": "sample string 8",
  "StatusDate": "2026-05-26T22:10:12.8537336+02:00",
  "InitialSituation": "sample string 10",
  "TargetSituation": "sample string 11",
  "DisciplineIds": [
    1,
    2
  ],
  "DisciplineGroupIds": [
    1,
    2
  ],
  "LatestScore": {
    "$id": "2",
    "Color": 1,
    "Description": "sample string 2",
    "Value": 3
  },
  "MainGoalId": "48de73d2-c283-4d65-905c-16be8a134366",
  "MainGoal": "sample string 12"
}

application/xml, text/xml

Sample:

<GoalV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Clientplan">
  <AggregateId>95249a59-dec8-4887-a5d9-8cb9f42107b2</AggregateId>
  <CareDemandExplanation>sample string 5</CareDemandExplanation>
  <CareDemandId>4</CareDemandId>
  <CareDemandName>sample string 3</CareDemandName>
  <DisciplineGroupIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </DisciplineGroupIds>
  <DisciplineIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </DisciplineIds>
  <EndDate>2026-05-26T22:10:12.8537336+02:00</EndDate>
  <Id>1</Id>
  <InitialSituation>sample string 10</InitialSituation>
  <LatestScore>
    <Color>1</Color>
    <Description>sample string 2</Description>
    <Value>3</Value>
  </LatestScore>
  <MainGoal>sample string 12</MainGoal>
  <MainGoalId>48de73d2-c283-4d65-905c-16be8a134366</MainGoalId>
  <Name>sample string 6</Name>
  <PreviousGoalId>1</PreviousGoalId>
  <QuestionnaireGoalId>1</QuestionnaireGoalId>
  <StartDate>2026-05-26T22:10:12.8537336+02:00</StartDate>
  <Status>sample string 7</Status>
  <StatusDate>2026-05-26T22:10:12.8537336+02:00</StatusDate>
  <StatusDescription>sample string 8</StatusDescription>
  <TargetSituation>sample string 11</TargetSituation>
  <TemplateGoalId>1</TemplateGoalId>
</GoalV2>

Response Information

Resource Description

Returns the HttpResponseMessage which contains the saved goal instance

HttpResponseMessage

Name	Type	Additional information
Version	Version	None
Content	HttpContent	None
StatusCode	HttpStatusCode	None
ReasonPhrase	string	None
Headers	Collection of Object	None
RequestMessage	HttpRequestMessage	None
IsSuccessStatusCode	boolean	None