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

Get specified Care Plan Definition (all versions)

Request Information

URI Parameters

Name	Description	Type	Additional 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

Name	Description	Type	Additional 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": "f2840ea2-257c-401c-86f8-70420c28ef62",
    "VillageId": "00c94469-4c31-48fb-b045-5d09ce0e5da3",
    "CarePlanId": "b21b888f-e72c-42b9-8d3c-66440868a4dd",
    "Frequency": 0,
    "RepeatsEvery": 4,
    "EndDate": "2025-06-03T05:59:25.310+00:00",
    "EndCount": 1,
    "InstanceCount": 5,
    "ReminderInterval": 1,
    "Title": "sample string 6",
    "Active": true,
    "Updated": "2025-06-03T05:59:25.310+00:00",
    "Questions": [
      {
        "CarePlanQuestionId": "b4737ba0-6312-495e-88ad-8f39e93ca988",
        "VersionId": "09f56e67-c271-461d-8ec9-ce7b4077f680",
        "QuestionId": "b31cacfe-7438-4ef9-a04e-6789460344d9",
        "VillageId": "34f238f1-2996-4ba0-8eaa-65b9e6f73f58",
        "Question": "sample string 5",
        "Sequence": 6
      },
      {
        "CarePlanQuestionId": "b4737ba0-6312-495e-88ad-8f39e93ca988",
        "VersionId": "09f56e67-c271-461d-8ec9-ce7b4077f680",
        "QuestionId": "b31cacfe-7438-4ef9-a04e-6789460344d9",
        "VillageId": "34f238f1-2996-4ba0-8eaa-65b9e6f73f58",
        "Question": "sample string 5",
        "Sequence": 6
      }
    ],
    "ActivatedDate": "2025-06-03T05:59:25.310+00:00",
    "Draft": true
  },
  {
    "VersionId": "f2840ea2-257c-401c-86f8-70420c28ef62",
    "VillageId": "00c94469-4c31-48fb-b045-5d09ce0e5da3",
    "CarePlanId": "b21b888f-e72c-42b9-8d3c-66440868a4dd",
    "Frequency": 0,
    "RepeatsEvery": 4,
    "EndDate": "2025-06-03T05:59:25.310+00:00",
    "EndCount": 1,
    "InstanceCount": 5,
    "ReminderInterval": 1,
    "Title": "sample string 6",
    "Active": true,
    "Updated": "2025-06-03T05:59:25.310+00:00",
    "Questions": [
      {
        "CarePlanQuestionId": "b4737ba0-6312-495e-88ad-8f39e93ca988",
        "VersionId": "09f56e67-c271-461d-8ec9-ce7b4077f680",
        "QuestionId": "b31cacfe-7438-4ef9-a04e-6789460344d9",
        "VillageId": "34f238f1-2996-4ba0-8eaa-65b9e6f73f58",
        "Question": "sample string 5",
        "Sequence": 6
      },
      {
        "CarePlanQuestionId": "b4737ba0-6312-495e-88ad-8f39e93ca988",
        "VersionId": "09f56e67-c271-461d-8ec9-ce7b4077f680",
        "QuestionId": "b31cacfe-7438-4ef9-a04e-6789460344d9",
        "VillageId": "34f238f1-2996-4ba0-8eaa-65b9e6f73f58",
        "Question": "sample string 5",
        "Sequence": 6
      }
    ],
    "ActivatedDate": "2025-06-03T05:59:25.310+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.3104381+00:00</ActivatedDate>
    <Active>true</Active>
    <CarePlanId>b21b888f-e72c-42b9-8d3c-66440868a4dd</CarePlanId>
    <Draft>true</Draft>
    <EndCount>1</EndCount>
    <EndDate>2025-06-03T05:59:25.3104381+00:00</EndDate>
    <Frequency>Daily</Frequency>
    <InstanceCount>5</InstanceCount>
    <Questions>
      <CarePlanQuestionDefinitionModel>
        <CarePlanQuestionId>b4737ba0-6312-495e-88ad-8f39e93ca988</CarePlanQuestionId>
        <Question>sample string 5</Question>
        <QuestionId>b31cacfe-7438-4ef9-a04e-6789460344d9</QuestionId>
        <Sequence>6</Sequence>
        <VersionId>09f56e67-c271-461d-8ec9-ce7b4077f680</VersionId>
        <VillageId>34f238f1-2996-4ba0-8eaa-65b9e6f73f58</VillageId>
      </CarePlanQuestionDefinitionModel>
      <CarePlanQuestionDefinitionModel>
        <CarePlanQuestionId>b4737ba0-6312-495e-88ad-8f39e93ca988</CarePlanQuestionId>
        <Question>sample string 5</Question>
        <QuestionId>b31cacfe-7438-4ef9-a04e-6789460344d9</QuestionId>
        <Sequence>6</Sequence>
        <VersionId>09f56e67-c271-461d-8ec9-ce7b4077f680</VersionId>
        <VillageId>34f238f1-2996-4ba0-8eaa-65b9e6f73f58</VillageId>
      </CarePlanQuestionDefinitionModel>
    </Questions>
    <ReminderInterval>1</ReminderInterval>
    <RepeatsEvery>4</RepeatsEvery>
    <Title>sample string 6</Title>
    <Updated>2025-06-03T05:59:25.3104381+00:00</Updated>
    <VersionId>f2840ea2-257c-401c-86f8-70420c28ef62</VersionId>
    <VillageId>00c94469-4c31-48fb-b045-5d09ce0e5da3</VillageId>
  </CarePlanDefinitionModel>
  <CarePlanDefinitionModel>
    <ActivatedDate>2025-06-03T05:59:25.3104381+00:00</ActivatedDate>
    <Active>true</Active>
    <CarePlanId>b21b888f-e72c-42b9-8d3c-66440868a4dd</CarePlanId>
    <Draft>true</Draft>
    <EndCount>1</EndCount>
    <EndDate>2025-06-03T05:59:25.3104381+00:00</EndDate>
    <Frequency>Daily</Frequency>
    <InstanceCount>5</InstanceCount>
    <Questions>
      <CarePlanQuestionDefinitionModel>
        <CarePlanQuestionId>b4737ba0-6312-495e-88ad-8f39e93ca988</CarePlanQuestionId>
        <Question>sample string 5</Question>
        <QuestionId>b31cacfe-7438-4ef9-a04e-6789460344d9</QuestionId>
        <Sequence>6</Sequence>
        <VersionId>09f56e67-c271-461d-8ec9-ce7b4077f680</VersionId>
        <VillageId>34f238f1-2996-4ba0-8eaa-65b9e6f73f58</VillageId>
      </CarePlanQuestionDefinitionModel>
      <CarePlanQuestionDefinitionModel>
        <CarePlanQuestionId>b4737ba0-6312-495e-88ad-8f39e93ca988</CarePlanQuestionId>
        <Question>sample string 5</Question>
        <QuestionId>b31cacfe-7438-4ef9-a04e-6789460344d9</QuestionId>
        <Sequence>6</Sequence>
        <VersionId>09f56e67-c271-461d-8ec9-ce7b4077f680</VersionId>
        <VillageId>34f238f1-2996-4ba0-8eaa-65b9e6f73f58</VillageId>
      </CarePlanQuestionDefinitionModel>
    </Questions>
    <ReminderInterval>1</ReminderInterval>
    <RepeatsEvery>4</RepeatsEvery>
    <Title>sample string 6</Title>
    <Updated>2025-06-03T05:59:25.3104381+00:00</Updated>
    <VersionId>f2840ea2-257c-401c-86f8-70420c28ef62</VersionId>
    <VillageId>00c94469-4c31-48fb-b045-5d09ce0e5da3</VillageId>
  </CarePlanDefinitionModel>
</ArrayOfCarePlanDefinitionModel>