GET CarePlans/Item

Request Information

URI Parameters

Name	Type	Additional information
IncludeActive	boolean	None.
IncludeInactive	boolean	None.
IncludeDeleted	boolean	None.
IncludeError	boolean	None.
Match	MatchCriteriaStringType	None.
CarePlanItemIDs	Collection of integer	None.
CarePlanItemCategoryID	integer	None.
CarePlanItemName	string	None.
Type	CarePlanItemType	None.
AnswerType	CarePlanItemAnswerType	None.
Caption	string	None.
IsCustom	boolean	None.
ClientCarePlanID	integer	None.
IsCustom_ClientCarePlanID	integer	None.
ClientCarePlanEntryID	integer	None.
Props	Collection of Object	None.
CreatedByUserID	integer	None.
LastUpdatedByUserID	integer	None.
CreatedDateUtcMin	date	None.
CreatedDateUtcMax	date	None.
LastUpdatedDateUtcMin	date	None.
LastUpdatedDateUtcMax	date	None.
CarePlanID	integer	None.

Body Parameters

None.

Response Information

Resource Description

Collection of CarePlanItemDTO

Name	Type	Additional information
CarePlanItemID	integer	None.
CarePlanItemCategoryID	integer	None.
CarePlanItemName	string	None.
Type	CarePlanItemType	None.
AnswerType	CarePlanItemAnswerType	None.
Caption	string	None.
IsCustom	boolean	None.
ClientCarePlanID	integer	None.
Props	Collection of Object	None.
RecordState	ClinicalRecordState	None.
CreatedByUserID	integer	None.
LastUpdatedByUserID	integer	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
CategoryName	string	None.
CategoryDescription	string	None.
CarePlanItemLinks	Collection of CarePlanItemLinkDTO	None.
Summary	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "carePlanItemID": 1,
    "carePlanItemCategoryID": 2,
    "carePlanItemName": "sample string 3",
    "type": 1,
    "answerType": 1,
    "caption": "sample string 4",
    "isCustom": true,
    "clientCarePlanID": 1,
    "recordState": 1,
    "createdByUserID": 1,
    "lastUpdatedByUserID": 1,
    "created": {
      "dateUtc": "2024-12-04T08:16:56.8168543+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:16:56 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T08:16:56.8168543+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:16:56 AM"
    },
    "categoryName": "sample string 6",
    "categoryDescription": "sample string 7",
    "carePlanItemLinks": [
      {
        "carePlanItemLinkID": 1,
        "carePlanID": 2,
        "carePlanName": "sample string 3",
        "carePlanTitle": "sample string 4",
        "carePlanItemID": 5,
        "parentCarePlanItemLinkID": 1,
        "isDefault": true,
        "isRequired": true,
        "sortOrder": 8,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:16:56.8168543+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:16:56 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:16:56.8168543+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:16:56 AM"
        },
        "carePlanItemName": "sample string 9",
        "carePlanItemCaption": "sample string 10",
        "carePlanItemType": 1,
        "carePlanItemAnswerType": 1,
        "carePlanItemCategoryID": 11,
        "categoryName": "sample string 12",
        "categoryDescription": "sample string 13",
        "carePlanItemIsCustom": true,
        "summary": "sample string 9"
      },
      {
        "carePlanItemLinkID": 1,
        "carePlanID": 2,
        "carePlanName": "sample string 3",
        "carePlanTitle": "sample string 4",
        "carePlanItemID": 5,
        "parentCarePlanItemLinkID": 1,
        "isDefault": true,
        "isRequired": true,
        "sortOrder": 8,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:16:56.8168543+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:16:56 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:16:56.8168543+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:16:56 AM"
        },
        "carePlanItemName": "sample string 9",
        "carePlanItemCaption": "sample string 10",
        "carePlanItemType": 1,
        "carePlanItemAnswerType": 1,
        "carePlanItemCategoryID": 11,
        "categoryName": "sample string 12",
        "categoryDescription": "sample string 13",
        "carePlanItemIsCustom": true,
        "summary": "sample string 9"
      }
    ],
    "summary": "sample string 3"
  },
  {
    "carePlanItemID": 1,
    "carePlanItemCategoryID": 2,
    "carePlanItemName": "sample string 3",
    "type": 1,
    "answerType": 1,
    "caption": "sample string 4",
    "isCustom": true,
    "clientCarePlanID": 1,
    "recordState": 1,
    "createdByUserID": 1,
    "lastUpdatedByUserID": 1,
    "created": {
      "dateUtc": "2024-12-04T08:16:56.8168543+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:16:56 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T08:16:56.8168543+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:16:56 AM"
    },
    "categoryName": "sample string 6",
    "categoryDescription": "sample string 7",
    "carePlanItemLinks": [
      {
        "carePlanItemLinkID": 1,
        "carePlanID": 2,
        "carePlanName": "sample string 3",
        "carePlanTitle": "sample string 4",
        "carePlanItemID": 5,
        "parentCarePlanItemLinkID": 1,
        "isDefault": true,
        "isRequired": true,
        "sortOrder": 8,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:16:56.8168543+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:16:56 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:16:56.8168543+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:16:56 AM"
        },
        "carePlanItemName": "sample string 9",
        "carePlanItemCaption": "sample string 10",
        "carePlanItemType": 1,
        "carePlanItemAnswerType": 1,
        "carePlanItemCategoryID": 11,
        "categoryName": "sample string 12",
        "categoryDescription": "sample string 13",
        "carePlanItemIsCustom": true,
        "summary": "sample string 9"
      },
      {
        "carePlanItemLinkID": 1,
        "carePlanID": 2,
        "carePlanName": "sample string 3",
        "carePlanTitle": "sample string 4",
        "carePlanItemID": 5,
        "parentCarePlanItemLinkID": 1,
        "isDefault": true,
        "isRequired": true,
        "sortOrder": 8,
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:16:56.8168543+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:16:56 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:16:56.8168543+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:16:56 AM"
        },
        "carePlanItemName": "sample string 9",
        "carePlanItemCaption": "sample string 10",
        "carePlanItemType": 1,
        "carePlanItemAnswerType": 1,
        "carePlanItemCategoryID": 11,
        "categoryName": "sample string 12",
        "categoryDescription": "sample string 13",
        "carePlanItemIsCustom": true,
        "summary": "sample string 9"
      }
    ],
    "summary": "sample string 3"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCarePlanItemDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <CarePlanItemDTO>
    <AnswerType>New</AnswerType>
    <Caption>sample string 4</Caption>
    <CarePlanItemCategoryID>2</CarePlanItemCategoryID>
    <CarePlanItemID>1</CarePlanItemID>
    <CarePlanItemLinks>
      <CarePlanItemLinkDTO>
        <CarePlanID>2</CarePlanID>
        <CarePlanItemAnswerType>New</CarePlanItemAnswerType>
        <CarePlanItemCaption>sample string 10</CarePlanItemCaption>
        <CarePlanItemCategoryID>11</CarePlanItemCategoryID>
        <CarePlanItemID>5</CarePlanItemID>
        <CarePlanItemIsCustom>true</CarePlanItemIsCustom>
        <CarePlanItemLinkID>1</CarePlanItemLinkID>
        <CarePlanItemName>sample string 9</CarePlanItemName>
        <CarePlanItemType>Problem</CarePlanItemType>
        <CarePlanName>sample string 3</CarePlanName>
        <CarePlanTitle>sample string 4</CarePlanTitle>
        <CategoryDescription>sample string 13</CategoryDescription>
        <CategoryName>sample string 12</CategoryName>
        <Created>
          <DateUtc>2024-12-04T08:16:56.8168543+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <IsDefault>true</IsDefault>
        <IsRequired>true</IsRequired>
        <LastUpdated>
          <DateUtc>2024-12-04T08:16:56.8168543+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <ParentCarePlanItemLinkID>1</ParentCarePlanItemLinkID>
        <RecordState>Active</RecordState>
        <SortOrder>8</SortOrder>
      </CarePlanItemLinkDTO>
      <CarePlanItemLinkDTO>
        <CarePlanID>2</CarePlanID>
        <CarePlanItemAnswerType>New</CarePlanItemAnswerType>
        <CarePlanItemCaption>sample string 10</CarePlanItemCaption>
        <CarePlanItemCategoryID>11</CarePlanItemCategoryID>
        <CarePlanItemID>5</CarePlanItemID>
        <CarePlanItemIsCustom>true</CarePlanItemIsCustom>
        <CarePlanItemLinkID>1</CarePlanItemLinkID>
        <CarePlanItemName>sample string 9</CarePlanItemName>
        <CarePlanItemType>Problem</CarePlanItemType>
        <CarePlanName>sample string 3</CarePlanName>
        <CarePlanTitle>sample string 4</CarePlanTitle>
        <CategoryDescription>sample string 13</CategoryDescription>
        <CategoryName>sample string 12</CategoryName>
        <Created>
          <DateUtc>2024-12-04T08:16:56.8168543+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <IsDefault>true</IsDefault>
        <IsRequired>true</IsRequired>
        <LastUpdated>
          <DateUtc>2024-12-04T08:16:56.8168543+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <ParentCarePlanItemLinkID>1</ParentCarePlanItemLinkID>
        <RecordState>Active</RecordState>
        <SortOrder>8</SortOrder>
      </CarePlanItemLinkDTO>
    </CarePlanItemLinks>
    <CarePlanItemName>sample string 3</CarePlanItemName>
    <CategoryDescription>sample string 7</CategoryDescription>
    <CategoryName>sample string 6</CategoryName>
    <ClientCarePlanID>1</ClientCarePlanID>
    <Created>
      <DateUtc>2024-12-04T08:16:56.8168543+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <CreatedByUserID>1</CreatedByUserID>
    <IsCustom>true</IsCustom>
    <LastUpdated>
      <DateUtc>2024-12-04T08:16:56.8168543+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <LastUpdatedByUserID>1</LastUpdatedByUserID>
    <Props xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
    <RecordState>Active</RecordState>
    <Type>Problem</Type>
  </CarePlanItemDTO>
  <CarePlanItemDTO>
    <AnswerType>New</AnswerType>
    <Caption>sample string 4</Caption>
    <CarePlanItemCategoryID>2</CarePlanItemCategoryID>
    <CarePlanItemID>1</CarePlanItemID>
    <CarePlanItemLinks>
      <CarePlanItemLinkDTO>
        <CarePlanID>2</CarePlanID>
        <CarePlanItemAnswerType>New</CarePlanItemAnswerType>
        <CarePlanItemCaption>sample string 10</CarePlanItemCaption>
        <CarePlanItemCategoryID>11</CarePlanItemCategoryID>
        <CarePlanItemID>5</CarePlanItemID>
        <CarePlanItemIsCustom>true</CarePlanItemIsCustom>
        <CarePlanItemLinkID>1</CarePlanItemLinkID>
        <CarePlanItemName>sample string 9</CarePlanItemName>
        <CarePlanItemType>Problem</CarePlanItemType>
        <CarePlanName>sample string 3</CarePlanName>
        <CarePlanTitle>sample string 4</CarePlanTitle>
        <CategoryDescription>sample string 13</CategoryDescription>
        <CategoryName>sample string 12</CategoryName>
        <Created>
          <DateUtc>2024-12-04T08:16:56.8168543+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <IsDefault>true</IsDefault>
        <IsRequired>true</IsRequired>
        <LastUpdated>
          <DateUtc>2024-12-04T08:16:56.8168543+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <ParentCarePlanItemLinkID>1</ParentCarePlanItemLinkID>
        <RecordState>Active</RecordState>
        <SortOrder>8</SortOrder>
      </CarePlanItemLinkDTO>
      <CarePlanItemLinkDTO>
        <CarePlanID>2</CarePlanID>
        <CarePlanItemAnswerType>New</CarePlanItemAnswerType>
        <CarePlanItemCaption>sample string 10</CarePlanItemCaption>
        <CarePlanItemCategoryID>11</CarePlanItemCategoryID>
        <CarePlanItemID>5</CarePlanItemID>
        <CarePlanItemIsCustom>true</CarePlanItemIsCustom>
        <CarePlanItemLinkID>1</CarePlanItemLinkID>
        <CarePlanItemName>sample string 9</CarePlanItemName>
        <CarePlanItemType>Problem</CarePlanItemType>
        <CarePlanName>sample string 3</CarePlanName>
        <CarePlanTitle>sample string 4</CarePlanTitle>
        <CategoryDescription>sample string 13</CategoryDescription>
        <CategoryName>sample string 12</CategoryName>
        <Created>
          <DateUtc>2024-12-04T08:16:56.8168543+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <IsDefault>true</IsDefault>
        <IsRequired>true</IsRequired>
        <LastUpdated>
          <DateUtc>2024-12-04T08:16:56.8168543+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <ParentCarePlanItemLinkID>1</ParentCarePlanItemLinkID>
        <RecordState>Active</RecordState>
        <SortOrder>8</SortOrder>
      </CarePlanItemLinkDTO>
    </CarePlanItemLinks>
    <CarePlanItemName>sample string 3</CarePlanItemName>
    <CategoryDescription>sample string 7</CategoryDescription>
    <CategoryName>sample string 6</CategoryName>
    <ClientCarePlanID>1</ClientCarePlanID>
    <Created>
      <DateUtc>2024-12-04T08:16:56.8168543+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <CreatedByUserID>1</CreatedByUserID>
    <IsCustom>true</IsCustom>
    <LastUpdated>
      <DateUtc>2024-12-04T08:16:56.8168543+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <LastUpdatedByUserID>1</LastUpdatedByUserID>
    <Props xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
    <RecordState>Active</RecordState>
    <Type>Problem</Type>
  </CarePlanItemDTO>
</ArrayOfCarePlanItemDTO>

application/x-compressed-json

Sample:

��V�n�0��k��B�oir�ԗ��T�`�Y�UۨBQ���~R��%PzD�o�����h�?���  �>D$YI���Q#� ��R^�)���#1g���,�YYd�I�;���5 �di���U�0�ȅLc�%ϩ��M�>��� ��T�
9U��u��W5r���xU��ɍ���c计����ޥ�<�:b�\���U[%EǄ휕&�'�<ªz[�[�р88A5�ή8,�8��h��%�`�`eT'Y�X����LF�
W;��:�L�NX�D�Ē��<�5�x�o9��X�ry�C��{�7��Rglbt���Z቙�s�g���3dG�َ�o�}���Lݎ�����ĩ$��Y�%���O��%�8�qd��IIoI������N