GET CarePlans/ItemLink

Request Information

URI Parameters

Name	Type	Additional information
IncludeActive	boolean	None.
IncludeInactive	boolean	None.
IncludeDeleted	boolean	None.
Match	MatchCriteriaStringType	None.
CarePlanItemLinkIDs	Collection of integer	None.
CarePlanID	integer	None.
CarePlans	Collection of integer	None.
CarePlanItemID	integer	None.
ParentCarePlanItemLinkID	integer	None.
ParentCarePlanItemLinkIDs	Collection of integer	None.
IsDefault	boolean	None.
IsRequired	boolean	None.
IsCustom	boolean	None.
IsCustomOnly	boolean	None.
ClientCarePlanID	integer	None.
SortOrder	integer	None.
CreatedDateUtcMin	date	None.
CreatedDateUtcMax	date	None.
LastUpdatedDateUtcMin	date	None.
LastUpdatedDateUtcMax	date	None.

Body Parameters

None.

Response Information

Resource Description

Collection of CarePlanItemLinkDTO

Name	Type	Additional information
CarePlanItemLinkID	integer	None.
CarePlanID	integer	None.
CarePlanName	string	None.
CarePlanTitle	string	None.
CarePlanItemID	integer	None.
ParentCarePlanItemLinkID	integer	None.
IsDefault	boolean	None.
IsRequired	boolean	None.
SortOrder	integer	None.
RecordState	RecordState	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
CarePlanItemName	string	None.
CarePlanItemCaption	string	None.
CarePlanItemType	CarePlanItemType	None.
CarePlanItemAnswerType	CarePlanItemAnswerType	None.
CarePlanItemCategoryID	integer	None.
CategoryName	string	None.
CategoryDescription	string	None.
CarePlanItemIsCustom	boolean	None.
Summary	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "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-04T07:53:45.7810403+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:53:45 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T07:53:45.7810403+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:53:45 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-04T07:53:45.7810403+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:53:45 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T07:53:45.7810403+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 7:53:45 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"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCarePlanItemLinkDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <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-04T07:53:45.7810403+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <IsDefault>true</IsDefault>
    <IsRequired>true</IsRequired>
    <LastUpdated>
      <DateUtc>2024-12-04T07:53:45.7810403+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-04T07:53:45.7810403+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <IsDefault>true</IsDefault>
    <IsRequired>true</IsRequired>
    <LastUpdated>
      <DateUtc>2024-12-04T07:53:45.7810403+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <ParentCarePlanItemLinkID>1</ParentCarePlanItemLinkID>
    <RecordState>Active</RecordState>
    <SortOrder>8</SortOrder>
  </CarePlanItemLinkDTO>
</ArrayOfCarePlanItemLinkDTO>

application/x-compressed-json

Sample:

��S�N�@~�f��nK����B�_N�æ��v[g�1
��<�H��[�P���|�e替����5���.�zn��R�e���v.��Y 0��r�%�W^a�l~̈�m�6�ȇ�A���
�I�Yֹa�����Zf;Ĕdo)C1�0-){���Bg:�2g,m�tqƣA�,Z���"]�'�Xx��`�)�
Ro��M]���Wj/��hؖ�~r{�kx�!��.����_Eo����bYYU�#^����¿����6oH���MbUR���&��{U:F�&%uBVxxo&��-���91�����%�/q~���x��Yb�*