GET api/Village/{village}/CarePlans/{carePlanId}?baseDate={baseDate}&withInactive={withInactive}

Get all Care Plan instances for the specified care plan

Request Information

URI Parameters

Name	Description	Type	Additional information
carePlanId	Plan ID to retrieve instance data for	globally unique identifier	Required
baseDate	If provided, date to retrieve the care plan for (for weekly plans, can be any day within the week). Defaults to all dates	date	None.
withInactive	If provided, specifies whether to include inactive care plans. Defaults to true.	boolean	Default value is True
village		string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of CarePlanInstanceModel

Name	Description	Type	Additional information
CarePlanInstanceId	Unique ID of this care plan instance	globally unique identifier	None.
Title	Care Plan title	string	None.
Frequency	Frequency the plan should be filled out (Daily = 0, Weekly = 1, Monthly = 2, Annual = 3)	CarePlanFrequency	None.
FrequencyText	Frequency as text	string	None.
Start	UTC date for the start of the Care Plan instance period (e.g. 7/12/2016 12:00:00.000 am)	date	None.
End	UTC date for the end of the Care Plan instance period (e.g. 7/11/2016 11:59:59.999 pm)	date	None.
Updated	Date/Time the care plan instance was last updated - null if the care plan for the selected period does not exist yet	date	None.
UpdatedById	Unique ID of the user who updated the care plan instance - null if the care plan for the selected period does not exist yet	globally unique identifier	None.
UpdatedBy	Name (First L.) of the user who updated the care plan instance - null if the care plan for the selected period does not exist yet	string	None.
VersionId	Unique ID of the version of the care plan this instance is based on	globally unique identifier	None.
CarePlanId	Unique ID of the care plan this instance is based on	globally unique identifier	None.
VillageId	Unique ID of the village	globally unique identifier	None.
ActiveVersion	Whether or not the care plan version this instance is based on is the currently active care plan version	boolean	None.
Items	Ordered list of questions w/ responses for this care plan	Collection of CarePlanItemModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CarePlanInstanceId": "f041314e-c017-4222-8094-09da5c9df3ba",
    "Title": "sample string 2",
    "Frequency": 0,
    "FrequencyText": "Daily",
    "Start": "2025-06-03T05:57:11.021+00:00",
    "End": "2025-06-03T05:57:11.021+00:00",
    "Updated": "2025-06-03T05:57:11.021+00:00",
    "UpdatedById": "dcc35d1f-b2f1-460d-a326-e237e7a0f7ef",
    "UpdatedBy": "sample string 5",
    "VersionId": "5ee867dd-d51f-4700-b314-ab88962b788b",
    "CarePlanId": "9f7ed376-7c56-4669-8190-653389645ef8",
    "VillageId": "f15a6d20-67f6-495d-84e5-db044f292bef",
    "ActiveVersion": true,
    "Items": [
      {
        "CarePlanItemId": "57586450-ed52-491c-97f5-8eb3bbff30b5",
        "CarePlanInstanceId": "688d35b4-1ecf-441a-bcb6-b460f3ba62a7",
        "CarePlanQuestionId": "ee2ba4f5-c03d-40d3-b648-1ce7e5251fa9",
        "QuestionId": "012d2265-b5f0-484e-8627-97d0a942bc38",
        "VillageId": "09e3aa99-805d-4e0c-bd35-d541188cbb9a",
        "Question": "sample string 6",
        "Sequence": 7,
        "Status": 0,
        "Updated": "2025-06-03T05:57:11.021+00:00",
        "UpdatedById": "040c0d72-e38b-4ca1-854e-0916c1cd4ad2",
        "UpdatedBy": "sample string 8"
      },
      {
        "CarePlanItemId": "57586450-ed52-491c-97f5-8eb3bbff30b5",
        "CarePlanInstanceId": "688d35b4-1ecf-441a-bcb6-b460f3ba62a7",
        "CarePlanQuestionId": "ee2ba4f5-c03d-40d3-b648-1ce7e5251fa9",
        "QuestionId": "012d2265-b5f0-484e-8627-97d0a942bc38",
        "VillageId": "09e3aa99-805d-4e0c-bd35-d541188cbb9a",
        "Question": "sample string 6",
        "Sequence": 7,
        "Status": 0,
        "Updated": "2025-06-03T05:57:11.021+00:00",
        "UpdatedById": "040c0d72-e38b-4ca1-854e-0916c1cd4ad2",
        "UpdatedBy": "sample string 8"
      }
    ]
  },
  {
    "CarePlanInstanceId": "f041314e-c017-4222-8094-09da5c9df3ba",
    "Title": "sample string 2",
    "Frequency": 0,
    "FrequencyText": "Daily",
    "Start": "2025-06-03T05:57:11.021+00:00",
    "End": "2025-06-03T05:57:11.021+00:00",
    "Updated": "2025-06-03T05:57:11.021+00:00",
    "UpdatedById": "dcc35d1f-b2f1-460d-a326-e237e7a0f7ef",
    "UpdatedBy": "sample string 5",
    "VersionId": "5ee867dd-d51f-4700-b314-ab88962b788b",
    "CarePlanId": "9f7ed376-7c56-4669-8190-653389645ef8",
    "VillageId": "f15a6d20-67f6-495d-84e5-db044f292bef",
    "ActiveVersion": true,
    "Items": [
      {
        "CarePlanItemId": "57586450-ed52-491c-97f5-8eb3bbff30b5",
        "CarePlanInstanceId": "688d35b4-1ecf-441a-bcb6-b460f3ba62a7",
        "CarePlanQuestionId": "ee2ba4f5-c03d-40d3-b648-1ce7e5251fa9",
        "QuestionId": "012d2265-b5f0-484e-8627-97d0a942bc38",
        "VillageId": "09e3aa99-805d-4e0c-bd35-d541188cbb9a",
        "Question": "sample string 6",
        "Sequence": 7,
        "Status": 0,
        "Updated": "2025-06-03T05:57:11.021+00:00",
        "UpdatedById": "040c0d72-e38b-4ca1-854e-0916c1cd4ad2",
        "UpdatedBy": "sample string 8"
      },
      {
        "CarePlanItemId": "57586450-ed52-491c-97f5-8eb3bbff30b5",
        "CarePlanInstanceId": "688d35b4-1ecf-441a-bcb6-b460f3ba62a7",
        "CarePlanQuestionId": "ee2ba4f5-c03d-40d3-b648-1ce7e5251fa9",
        "QuestionId": "012d2265-b5f0-484e-8627-97d0a942bc38",
        "VillageId": "09e3aa99-805d-4e0c-bd35-d541188cbb9a",
        "Question": "sample string 6",
        "Sequence": 7,
        "Status": 0,
        "Updated": "2025-06-03T05:57:11.021+00:00",
        "UpdatedById": "040c0d72-e38b-4ca1-854e-0916c1cd4ad2",
        "UpdatedBy": "sample string 8"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfCarePlanInstanceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <CarePlanInstanceModel>
    <ActiveVersion>true</ActiveVersion>
    <CarePlanId>9f7ed376-7c56-4669-8190-653389645ef8</CarePlanId>
    <CarePlanInstanceId>f041314e-c017-4222-8094-09da5c9df3ba</CarePlanInstanceId>
    <End>2025-06-03T05:57:11.0218543+00:00</End>
    <Frequency>Daily</Frequency>
    <Items>
      <CarePlanItemModel>
        <CarePlanInstanceId>688d35b4-1ecf-441a-bcb6-b460f3ba62a7</CarePlanInstanceId>
        <CarePlanItemId>57586450-ed52-491c-97f5-8eb3bbff30b5</CarePlanItemId>
        <CarePlanQuestionId>ee2ba4f5-c03d-40d3-b648-1ce7e5251fa9</CarePlanQuestionId>
        <Question>sample string 6</Question>
        <QuestionId>012d2265-b5f0-484e-8627-97d0a942bc38</QuestionId>
        <Sequence>7</Sequence>
        <Status>NA</Status>
        <Updated>2025-06-03T05:57:11.0218543+00:00</Updated>
        <UpdatedBy>sample string 8</UpdatedBy>
        <UpdatedById>040c0d72-e38b-4ca1-854e-0916c1cd4ad2</UpdatedById>
        <VillageId>09e3aa99-805d-4e0c-bd35-d541188cbb9a</VillageId>
      </CarePlanItemModel>
      <CarePlanItemModel>
        <CarePlanInstanceId>688d35b4-1ecf-441a-bcb6-b460f3ba62a7</CarePlanInstanceId>
        <CarePlanItemId>57586450-ed52-491c-97f5-8eb3bbff30b5</CarePlanItemId>
        <CarePlanQuestionId>ee2ba4f5-c03d-40d3-b648-1ce7e5251fa9</CarePlanQuestionId>
        <Question>sample string 6</Question>
        <QuestionId>012d2265-b5f0-484e-8627-97d0a942bc38</QuestionId>
        <Sequence>7</Sequence>
        <Status>NA</Status>
        <Updated>2025-06-03T05:57:11.0218543+00:00</Updated>
        <UpdatedBy>sample string 8</UpdatedBy>
        <UpdatedById>040c0d72-e38b-4ca1-854e-0916c1cd4ad2</UpdatedById>
        <VillageId>09e3aa99-805d-4e0c-bd35-d541188cbb9a</VillageId>
      </CarePlanItemModel>
    </Items>
    <Start>2025-06-03T05:57:11.0218543+00:00</Start>
    <Title>sample string 2</Title>
    <Updated>2025-06-03T05:57:11.0218543+00:00</Updated>
    <UpdatedBy>sample string 5</UpdatedBy>
    <UpdatedById>dcc35d1f-b2f1-460d-a326-e237e7a0f7ef</UpdatedById>
    <VersionId>5ee867dd-d51f-4700-b314-ab88962b788b</VersionId>
    <VillageId>f15a6d20-67f6-495d-84e5-db044f292bef</VillageId>
  </CarePlanInstanceModel>
  <CarePlanInstanceModel>
    <ActiveVersion>true</ActiveVersion>
    <CarePlanId>9f7ed376-7c56-4669-8190-653389645ef8</CarePlanId>
    <CarePlanInstanceId>f041314e-c017-4222-8094-09da5c9df3ba</CarePlanInstanceId>
    <End>2025-06-03T05:57:11.0218543+00:00</End>
    <Frequency>Daily</Frequency>
    <Items>
      <CarePlanItemModel>
        <CarePlanInstanceId>688d35b4-1ecf-441a-bcb6-b460f3ba62a7</CarePlanInstanceId>
        <CarePlanItemId>57586450-ed52-491c-97f5-8eb3bbff30b5</CarePlanItemId>
        <CarePlanQuestionId>ee2ba4f5-c03d-40d3-b648-1ce7e5251fa9</CarePlanQuestionId>
        <Question>sample string 6</Question>
        <QuestionId>012d2265-b5f0-484e-8627-97d0a942bc38</QuestionId>
        <Sequence>7</Sequence>
        <Status>NA</Status>
        <Updated>2025-06-03T05:57:11.0218543+00:00</Updated>
        <UpdatedBy>sample string 8</UpdatedBy>
        <UpdatedById>040c0d72-e38b-4ca1-854e-0916c1cd4ad2</UpdatedById>
        <VillageId>09e3aa99-805d-4e0c-bd35-d541188cbb9a</VillageId>
      </CarePlanItemModel>
      <CarePlanItemModel>
        <CarePlanInstanceId>688d35b4-1ecf-441a-bcb6-b460f3ba62a7</CarePlanInstanceId>
        <CarePlanItemId>57586450-ed52-491c-97f5-8eb3bbff30b5</CarePlanItemId>
        <CarePlanQuestionId>ee2ba4f5-c03d-40d3-b648-1ce7e5251fa9</CarePlanQuestionId>
        <Question>sample string 6</Question>
        <QuestionId>012d2265-b5f0-484e-8627-97d0a942bc38</QuestionId>
        <Sequence>7</Sequence>
        <Status>NA</Status>
        <Updated>2025-06-03T05:57:11.0218543+00:00</Updated>
        <UpdatedBy>sample string 8</UpdatedBy>
        <UpdatedById>040c0d72-e38b-4ca1-854e-0916c1cd4ad2</UpdatedById>
        <VillageId>09e3aa99-805d-4e0c-bd35-d541188cbb9a</VillageId>
      </CarePlanItemModel>
    </Items>
    <Start>2025-06-03T05:57:11.0218543+00:00</Start>
    <Title>sample string 2</Title>
    <Updated>2025-06-03T05:57:11.0218543+00:00</Updated>
    <UpdatedBy>sample string 5</UpdatedBy>
    <UpdatedById>dcc35d1f-b2f1-460d-a326-e237e7a0f7ef</UpdatedById>
    <VersionId>5ee867dd-d51f-4700-b314-ab88962b788b</VersionId>
    <VillageId>f15a6d20-67f6-495d-84e5-db044f292bef</VillageId>
  </CarePlanInstanceModel>
</ArrayOfCarePlanInstanceModel>