GET api/Village/{village}/CarePlans/{carePlanId}/Active/Definition

Get specified Care Plan Definition (active version only)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
carePlanId

ID of the care plan to return

 globally unique identifier

Required
village

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of CarePlanDefinitionModel
NameDescriptionTypeAdditional information
VersionId

Unique ID for this version of the care plan

 globally unique identifier

None.
VillageId

Unique ID of the village

 globally unique identifier

None.
CarePlanId

Unique ID of this care plan (multiple versions may share the same Care Plan ID)

 globally unique identifier

None.
Frequency

Frequency the plan should be filled out (Daily = 0, Weekly = 1)

 CarePlanFrequency

None.
RepeatsEvery

Repeats Every N

 integer

None.
EndDate

End on X date (null if no end date)

 date

None.
EndCount

End after X occurrences (null if no end count)

 integer

None.
InstanceCount

Number of occurrences that have happened

 integer

None.
ReminderInterval

Reminder N time (in minutes) before reset

 integer

None.
Title

Care Plan title

 string

None.
Active

Whether or not this is the current active care plan for the village

 boolean

None.
Updated

Date/Time the care plan was last updated

 date

None.
Questions

Ordered list of questions for this care plan

 Collection of CarePlanQuestionDefinitionModel

None.
ActivatedDate

Date the care plan version was activated

 date

None.
Draft

If true, the care plan version is a draft (has never been activated)

 boolean

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "VersionId": "4c1cb918-7af6-450d-86a7-03f1b0c3a7a2",
    "VillageId": "6bfd959c-35b4-40b6-b300-46c4f5d37ab4",
    "CarePlanId": "fb773d2f-6906-47ab-a079-e728560c16f0",
    "Frequency": 0,
    "RepeatsEvery": 4,
    "EndDate": "2025-06-03T05:59:25.462+00:00",
    "EndCount": 1,
    "InstanceCount": 5,
    "ReminderInterval": 1,
    "Title": "sample string 6",
    "Active": true,
    "Updated": "2025-06-03T05:59:25.462+00:00",
    "Questions": [
      {
        "CarePlanQuestionId": "3507594c-bf13-4711-b18a-7a55a1c2a756",
        "VersionId": "45b68f0b-e8bc-4cdd-b314-d5ed58ba0b7d",
        "QuestionId": "7dd967e9-c569-4473-9ba1-3e91f4d1c3e0",
        "VillageId": "413c11c1-b1d9-4767-8e73-f6d12964d90b",
        "Question": "sample string 5",
        "Sequence": 6
      },
      {
        "CarePlanQuestionId": "3507594c-bf13-4711-b18a-7a55a1c2a756",
        "VersionId": "45b68f0b-e8bc-4cdd-b314-d5ed58ba0b7d",
        "QuestionId": "7dd967e9-c569-4473-9ba1-3e91f4d1c3e0",
        "VillageId": "413c11c1-b1d9-4767-8e73-f6d12964d90b",
        "Question": "sample string 5",
        "Sequence": 6
      }
    ],
    "ActivatedDate": "2025-06-03T05:59:25.462+00:00",
    "Draft": true
  },
  {
    "VersionId": "4c1cb918-7af6-450d-86a7-03f1b0c3a7a2",
    "VillageId": "6bfd959c-35b4-40b6-b300-46c4f5d37ab4",
    "CarePlanId": "fb773d2f-6906-47ab-a079-e728560c16f0",
    "Frequency": 0,
    "RepeatsEvery": 4,
    "EndDate": "2025-06-03T05:59:25.462+00:00",
    "EndCount": 1,
    "InstanceCount": 5,
    "ReminderInterval": 1,
    "Title": "sample string 6",
    "Active": true,
    "Updated": "2025-06-03T05:59:25.462+00:00",
    "Questions": [
      {
        "CarePlanQuestionId": "3507594c-bf13-4711-b18a-7a55a1c2a756",
        "VersionId": "45b68f0b-e8bc-4cdd-b314-d5ed58ba0b7d",
        "QuestionId": "7dd967e9-c569-4473-9ba1-3e91f4d1c3e0",
        "VillageId": "413c11c1-b1d9-4767-8e73-f6d12964d90b",
        "Question": "sample string 5",
        "Sequence": 6
      },
      {
        "CarePlanQuestionId": "3507594c-bf13-4711-b18a-7a55a1c2a756",
        "VersionId": "45b68f0b-e8bc-4cdd-b314-d5ed58ba0b7d",
        "QuestionId": "7dd967e9-c569-4473-9ba1-3e91f4d1c3e0",
        "VillageId": "413c11c1-b1d9-4767-8e73-f6d12964d90b",
        "Question": "sample string 5",
        "Sequence": 6
      }
    ],
    "ActivatedDate": "2025-06-03T05:59:25.462+00:00",
    "Draft": true
  }
]

application/xml, text/xml

Sample: 
<ArrayOfCarePlanDefinitionModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <CarePlanDefinitionModel>
    <ActivatedDate>2025-06-03T05:59:25.4625324+00:00</ActivatedDate>
    <Active>true</Active>
    <CarePlanId>fb773d2f-6906-47ab-a079-e728560c16f0</CarePlanId>
    <Draft>true</Draft>
    <EndCount>1</EndCount>
    <EndDate>2025-06-03T05:59:25.4625324+00:00</EndDate>
    <Frequency>Daily</Frequency>
    <InstanceCount>5</InstanceCount>
    <Questions>
      <CarePlanQuestionDefinitionModel>
        <CarePlanQuestionId>3507594c-bf13-4711-b18a-7a55a1c2a756</CarePlanQuestionId>
        <Question>sample string 5</Question>
        <QuestionId>7dd967e9-c569-4473-9ba1-3e91f4d1c3e0</QuestionId>
        <Sequence>6</Sequence>
        <VersionId>45b68f0b-e8bc-4cdd-b314-d5ed58ba0b7d</VersionId>
        <VillageId>413c11c1-b1d9-4767-8e73-f6d12964d90b</VillageId>
      </CarePlanQuestionDefinitionModel>
      <CarePlanQuestionDefinitionModel>
        <CarePlanQuestionId>3507594c-bf13-4711-b18a-7a55a1c2a756</CarePlanQuestionId>
        <Question>sample string 5</Question>
        <QuestionId>7dd967e9-c569-4473-9ba1-3e91f4d1c3e0</QuestionId>
        <Sequence>6</Sequence>
        <VersionId>45b68f0b-e8bc-4cdd-b314-d5ed58ba0b7d</VersionId>
        <VillageId>413c11c1-b1d9-4767-8e73-f6d12964d90b</VillageId>
      </CarePlanQuestionDefinitionModel>
    </Questions>
    <ReminderInterval>1</ReminderInterval>
    <RepeatsEvery>4</RepeatsEvery>
    <Title>sample string 6</Title>
    <Updated>2025-06-03T05:59:25.4625324+00:00</Updated>
    <VersionId>4c1cb918-7af6-450d-86a7-03f1b0c3a7a2</VersionId>
    <VillageId>6bfd959c-35b4-40b6-b300-46c4f5d37ab4</VillageId>
  </CarePlanDefinitionModel>
  <CarePlanDefinitionModel>
    <ActivatedDate>2025-06-03T05:59:25.4625324+00:00</ActivatedDate>
    <Active>true</Active>
    <CarePlanId>fb773d2f-6906-47ab-a079-e728560c16f0</CarePlanId>
    <Draft>true</Draft>
    <EndCount>1</EndCount>
    <EndDate>2025-06-03T05:59:25.4625324+00:00</EndDate>
    <Frequency>Daily</Frequency>
    <InstanceCount>5</InstanceCount>
    <Questions>
      <CarePlanQuestionDefinitionModel>
        <CarePlanQuestionId>3507594c-bf13-4711-b18a-7a55a1c2a756</CarePlanQuestionId>
        <Question>sample string 5</Question>
        <QuestionId>7dd967e9-c569-4473-9ba1-3e91f4d1c3e0</QuestionId>
        <Sequence>6</Sequence>
        <VersionId>45b68f0b-e8bc-4cdd-b314-d5ed58ba0b7d</VersionId>
        <VillageId>413c11c1-b1d9-4767-8e73-f6d12964d90b</VillageId>
      </CarePlanQuestionDefinitionModel>
      <CarePlanQuestionDefinitionModel>
        <CarePlanQuestionId>3507594c-bf13-4711-b18a-7a55a1c2a756</CarePlanQuestionId>
        <Question>sample string 5</Question>
        <QuestionId>7dd967e9-c569-4473-9ba1-3e91f4d1c3e0</QuestionId>
        <Sequence>6</Sequence>
        <VersionId>45b68f0b-e8bc-4cdd-b314-d5ed58ba0b7d</VersionId>
        <VillageId>413c11c1-b1d9-4767-8e73-f6d12964d90b</VillageId>
      </CarePlanQuestionDefinitionModel>
    </Questions>
    <ReminderInterval>1</ReminderInterval>
    <RepeatsEvery>4</RepeatsEvery>
    <Title>sample string 6</Title>
    <Updated>2025-06-03T05:59:25.4625324+00:00</Updated>
    <VersionId>4c1cb918-7af6-450d-86a7-03f1b0c3a7a2</VersionId>
    <VillageId>6bfd959c-35b4-40b6-b300-46c4f5d37ab4</VillageId>
  </CarePlanDefinitionModel>
</ArrayOfCarePlanDefinitionModel>