GET CarePlans/CarePlan/export
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
IncludeActive | boolean |
None. |
|
IncludeInactive | boolean |
None. |
|
IncludeDeleted | boolean |
None. |
|
Match | MatchCriteriaStringType |
None. |
|
CarePlanIDs | Collection of integer |
None. |
|
CarePlanNames | Collection of string |
None. |
|
CarePlanResponseCodeTableID | integer |
None. |
|
CarePlanName | string |
None. |
|
Type | CarePlanType |
None. |
|
Title | string |
None. |
|
Props | Collection of Object |
None. |
|
BusinessUnits | Collection of integer |
None. |
|
SortOrder | integer |
None. |
|
Comments | string |
None. |
|
CreatedDateUtcMin | date |
None. |
|
CreatedDateUtcMax | date |
None. |
|
LastUpdatedDateUtcMin | date |
None. |
|
LastUpdatedDateUtcMax | date |
None. |
|
IncludePayload | boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of CarePlanPackageName | Description | Type | Additional information |
---|---|---|---|
CarePlans | Collection of CarePlan |
None. |
|
CarePlanItems | Collection of CarePlanItem |
None. |
|
CarePlanItemLinks | Collection of CarePlanItemLink |
None. |
Response Formats
application/json, text/json
Sample:
[ { "carePlans": [ { "carePlanID": 1, "carePlanResponseCodeTableID": 2, "carePlanResponseCodeTableName": "sample string 3", "carePlanName": "sample string 4", "type": 1, "title": "sample string 5", "sortOrder": 6, "comments": "sample string 7", "recordState": 1, "businessUnits": [ { "buid": 1, "carePlanID": 2, "businessUnitName": "sample string 3", "recordState": 1 }, { "buid": 1, "carePlanID": 2, "businessUnitName": "sample string 3", "recordState": 1 } ] }, { "carePlanID": 1, "carePlanResponseCodeTableID": 2, "carePlanResponseCodeTableName": "sample string 3", "carePlanName": "sample string 4", "type": 1, "title": "sample string 5", "sortOrder": 6, "comments": "sample string 7", "recordState": 1, "businessUnits": [ { "buid": 1, "carePlanID": 2, "businessUnitName": "sample string 3", "recordState": 1 }, { "buid": 1, "carePlanID": 2, "businessUnitName": "sample string 3", "recordState": 1 } ] } ], "carePlanItems": [ { "carePlanItemID": 1, "categoryName": "sample string 2", "carePlanName": "sample string 3", "categoryDescription": "sample string 4", "carePlanItemName": "sample string 5", "type": 1, "answerType": 1, "caption": "sample string 6", "isCustom": true, "clientCarePlanID": 1, "props": [], "recordState": 1 }, { "carePlanItemID": 1, "categoryName": "sample string 2", "carePlanName": "sample string 3", "categoryDescription": "sample string 4", "carePlanItemName": "sample string 5", "type": 1, "answerType": 1, "caption": "sample string 6", "isCustom": true, "clientCarePlanID": 1, "props": [], "recordState": 1 } ], "carePlanItemLinks": [ { "carePlanItemLinkID": 1, "carePlanID": 2, "carePlanName": "sample string 3", "carePlanTitle": "sample string 4", "carePlanItemID": 5, "parentCarePlanItemLinkID": 1, "parentCarePlanItemLinkName": "sample string 6", "problem": "sample string 7", "goal": "sample string 8", "isDefault": true, "isRequired": true, "sortOrder": 11, "recordState": 1, "created": { "dateUtc": "2024-12-04T08:06:27.0483666+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:06:27 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T08:06:27.0483666+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:06:27 AM" }, "carePlanItemName": "sample string 12", "carePlanItemCaption": "sample string 13", "carePlanItemType": 1, "carePlanItemAnswerType": 1, "carePlanItemCategoryID": 14, "categoryName": "sample string 15", "categoryDescription": "sample string 16", "summary": "sample string 12" }, { "carePlanItemLinkID": 1, "carePlanID": 2, "carePlanName": "sample string 3", "carePlanTitle": "sample string 4", "carePlanItemID": 5, "parentCarePlanItemLinkID": 1, "parentCarePlanItemLinkName": "sample string 6", "problem": "sample string 7", "goal": "sample string 8", "isDefault": true, "isRequired": true, "sortOrder": 11, "recordState": 1, "created": { "dateUtc": "2024-12-04T08:06:27.0483666+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:06:27 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T08:06:27.0483666+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:06:27 AM" }, "carePlanItemName": "sample string 12", "carePlanItemCaption": "sample string 13", "carePlanItemType": 1, "carePlanItemAnswerType": 1, "carePlanItemCategoryID": 14, "categoryName": "sample string 15", "categoryDescription": "sample string 16", "summary": "sample string 12" } ] }, { "carePlans": [ { "carePlanID": 1, "carePlanResponseCodeTableID": 2, "carePlanResponseCodeTableName": "sample string 3", "carePlanName": "sample string 4", "type": 1, "title": "sample string 5", "sortOrder": 6, "comments": "sample string 7", "recordState": 1, "businessUnits": [ { "buid": 1, "carePlanID": 2, "businessUnitName": "sample string 3", "recordState": 1 }, { "buid": 1, "carePlanID": 2, "businessUnitName": "sample string 3", "recordState": 1 } ] }, { "carePlanID": 1, "carePlanResponseCodeTableID": 2, "carePlanResponseCodeTableName": "sample string 3", "carePlanName": "sample string 4", "type": 1, "title": "sample string 5", "sortOrder": 6, "comments": "sample string 7", "recordState": 1, "businessUnits": [ { "buid": 1, "carePlanID": 2, "businessUnitName": "sample string 3", "recordState": 1 }, { "buid": 1, "carePlanID": 2, "businessUnitName": "sample string 3", "recordState": 1 } ] } ], "carePlanItems": [ { "carePlanItemID": 1, "categoryName": "sample string 2", "carePlanName": "sample string 3", "categoryDescription": "sample string 4", "carePlanItemName": "sample string 5", "type": 1, "answerType": 1, "caption": "sample string 6", "isCustom": true, "clientCarePlanID": 1, "props": [], "recordState": 1 }, { "carePlanItemID": 1, "categoryName": "sample string 2", "carePlanName": "sample string 3", "categoryDescription": "sample string 4", "carePlanItemName": "sample string 5", "type": 1, "answerType": 1, "caption": "sample string 6", "isCustom": true, "clientCarePlanID": 1, "props": [], "recordState": 1 } ], "carePlanItemLinks": [ { "carePlanItemLinkID": 1, "carePlanID": 2, "carePlanName": "sample string 3", "carePlanTitle": "sample string 4", "carePlanItemID": 5, "parentCarePlanItemLinkID": 1, "parentCarePlanItemLinkName": "sample string 6", "problem": "sample string 7", "goal": "sample string 8", "isDefault": true, "isRequired": true, "sortOrder": 11, "recordState": 1, "created": { "dateUtc": "2024-12-04T08:06:27.0483666+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:06:27 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T08:06:27.0483666+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:06:27 AM" }, "carePlanItemName": "sample string 12", "carePlanItemCaption": "sample string 13", "carePlanItemType": 1, "carePlanItemAnswerType": 1, "carePlanItemCategoryID": 14, "categoryName": "sample string 15", "categoryDescription": "sample string 16", "summary": "sample string 12" }, { "carePlanItemLinkID": 1, "carePlanID": 2, "carePlanName": "sample string 3", "carePlanTitle": "sample string 4", "carePlanItemID": 5, "parentCarePlanItemLinkID": 1, "parentCarePlanItemLinkName": "sample string 6", "problem": "sample string 7", "goal": "sample string 8", "isDefault": true, "isRequired": true, "sortOrder": 11, "recordState": 1, "created": { "dateUtc": "2024-12-04T08:06:27.0483666+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:06:27 AM" }, "lastUpdated": { "dateUtc": "2024-12-04T08:06:27.0483666+00:00", "userName": "sample string 2", "summary": "sample string 2 on 12/4/2024 8:06:27 AM" }, "carePlanItemName": "sample string 12", "carePlanItemCaption": "sample string 13", "carePlanItemType": 1, "carePlanItemAnswerType": 1, "carePlanItemCategoryID": 14, "categoryName": "sample string 15", "categoryDescription": "sample string 16", "summary": "sample string 12" } ] } ]
application/xml, text/xml
Sample:
<ArrayOfCarePlanPackage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models.ImportExport"> <CarePlanPackage> <CarePlanItemLinks> <CarePlanItemLink> <CarePlanID>2</CarePlanID> <CarePlanItemAnswerType>New</CarePlanItemAnswerType> <CarePlanItemCaption>sample string 13</CarePlanItemCaption> <CarePlanItemCategoryID>14</CarePlanItemCategoryID> <CarePlanItemID>5</CarePlanItemID> <CarePlanItemLinkID>1</CarePlanItemLinkID> <CarePlanItemName>sample string 12</CarePlanItemName> <CarePlanItemType>Problem</CarePlanItemType> <CarePlanName>sample string 3</CarePlanName> <CarePlanTitle>sample string 4</CarePlanTitle> <CategoryDescription>sample string 16</CategoryDescription> <CategoryName>sample string 15</CategoryName> <Created xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models"> <d5p1:DateUtc>2024-12-04T08:06:27.0483666+00:00</d5p1:DateUtc> <d5p1:UserName>sample string 2</d5p1:UserName> </Created> <Goal>sample string 8</Goal> <IsDefault>true</IsDefault> <IsRequired>true</IsRequired> <LastUpdated xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models"> <d5p1:DateUtc>2024-12-04T08:06:27.0483666+00:00</d5p1:DateUtc> <d5p1:UserName>sample string 2</d5p1:UserName> </LastUpdated> <ParentCarePlanItemLinkID>1</ParentCarePlanItemLinkID> <ParentCarePlanItemLinkName>sample string 6</ParentCarePlanItemLinkName> <Problem>sample string 7</Problem> <RecordState>Active</RecordState> <SortOrder>11</SortOrder> </CarePlanItemLink> <CarePlanItemLink> <CarePlanID>2</CarePlanID> <CarePlanItemAnswerType>New</CarePlanItemAnswerType> <CarePlanItemCaption>sample string 13</CarePlanItemCaption> <CarePlanItemCategoryID>14</CarePlanItemCategoryID> <CarePlanItemID>5</CarePlanItemID> <CarePlanItemLinkID>1</CarePlanItemLinkID> <CarePlanItemName>sample string 12</CarePlanItemName> <CarePlanItemType>Problem</CarePlanItemType> <CarePlanName>sample string 3</CarePlanName> <CarePlanTitle>sample string 4</CarePlanTitle> <CategoryDescription>sample string 16</CategoryDescription> <CategoryName>sample string 15</CategoryName> <Created xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models"> <d5p1:DateUtc>2024-12-04T08:06:27.0483666+00:00</d5p1:DateUtc> <d5p1:UserName>sample string 2</d5p1:UserName> </Created> <Goal>sample string 8</Goal> <IsDefault>true</IsDefault> <IsRequired>true</IsRequired> <LastUpdated xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models"> <d5p1:DateUtc>2024-12-04T08:06:27.0483666+00:00</d5p1:DateUtc> <d5p1:UserName>sample string 2</d5p1:UserName> </LastUpdated> <ParentCarePlanItemLinkID>1</ParentCarePlanItemLinkID> <ParentCarePlanItemLinkName>sample string 6</ParentCarePlanItemLinkName> <Problem>sample string 7</Problem> <RecordState>Active</RecordState> <SortOrder>11</SortOrder> </CarePlanItemLink> </CarePlanItemLinks> <CarePlanItems> <CarePlanItem> <AnswerType>New</AnswerType> <Caption>sample string 6</Caption> <CarePlanItemID>1</CarePlanItemID> <CarePlanItemName>sample string 5</CarePlanItemName> <CarePlanName>sample string 3</CarePlanName> <CategoryDescription>sample string 4</CategoryDescription> <CategoryName>sample string 2</CategoryName> <ClientCarePlanID>1</ClientCarePlanID> <IsCustom>true</IsCustom> <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" /> <RecordState>Active</RecordState> <Type>Problem</Type> </CarePlanItem> <CarePlanItem> <AnswerType>New</AnswerType> <Caption>sample string 6</Caption> <CarePlanItemID>1</CarePlanItemID> <CarePlanItemName>sample string 5</CarePlanItemName> <CarePlanName>sample string 3</CarePlanName> <CategoryDescription>sample string 4</CategoryDescription> <CategoryName>sample string 2</CategoryName> <ClientCarePlanID>1</ClientCarePlanID> <IsCustom>true</IsCustom> <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" /> <RecordState>Active</RecordState> <Type>Problem</Type> </CarePlanItem> </CarePlanItems> <CarePlans> <CarePlan> <BusinessUnits> <CarePlanBusinessUnit> <BUID>1</BUID> <BusinessUnitName>sample string 3</BusinessUnitName> <CarePlanID>2</CarePlanID> <RecordState>Active</RecordState> </CarePlanBusinessUnit> <CarePlanBusinessUnit> <BUID>1</BUID> <BusinessUnitName>sample string 3</BusinessUnitName> <CarePlanID>2</CarePlanID> <RecordState>Active</RecordState> </CarePlanBusinessUnit> </BusinessUnits> <CarePlanID>1</CarePlanID> <CarePlanName>sample string 4</CarePlanName> <CarePlanResponseCodeTableID>2</CarePlanResponseCodeTableID> <CarePlanResponseCodeTableName>sample string 3</CarePlanResponseCodeTableName> <Comments>sample string 7</Comments> <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" /> <RecordState>Active</RecordState> <SortOrder>6</SortOrder> <Title>sample string 5</Title> <Type>Primary</Type> </CarePlan> <CarePlan> <BusinessUnits> <CarePlanBusinessUnit> <BUID>1</BUID> <BusinessUnitName>sample string 3</BusinessUnitName> <CarePlanID>2</CarePlanID> <RecordState>Active</RecordState> </CarePlanBusinessUnit> <CarePlanBusinessUnit> <BUID>1</BUID> <BusinessUnitName>sample string 3</BusinessUnitName> <CarePlanID>2</CarePlanID> <RecordState>Active</RecordState> </CarePlanBusinessUnit> </BusinessUnits> <CarePlanID>1</CarePlanID> <CarePlanName>sample string 4</CarePlanName> <CarePlanResponseCodeTableID>2</CarePlanResponseCodeTableID> <CarePlanResponseCodeTableName>sample string 3</CarePlanResponseCodeTableName> <Comments>sample string 7</Comments> <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" /> <RecordState>Active</RecordState> <SortOrder>6</SortOrder> <Title>sample string 5</Title> <Type>Primary</Type> </CarePlan> </CarePlans> </CarePlanPackage> <CarePlanPackage> <CarePlanItemLinks> <CarePlanItemLink> <CarePlanID>2</CarePlanID> <CarePlanItemAnswerType>New</CarePlanItemAnswerType> <CarePlanItemCaption>sample string 13</CarePlanItemCaption> <CarePlanItemCategoryID>14</CarePlanItemCategoryID> <CarePlanItemID>5</CarePlanItemID> <CarePlanItemLinkID>1</CarePlanItemLinkID> <CarePlanItemName>sample string 12</CarePlanItemName> <CarePlanItemType>Problem</CarePlanItemType> <CarePlanName>sample string 3</CarePlanName> <CarePlanTitle>sample string 4</CarePlanTitle> <CategoryDescription>sample string 16</CategoryDescription> <CategoryName>sample string 15</CategoryName> <Created xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models"> <d5p1:DateUtc>2024-12-04T08:06:27.0483666+00:00</d5p1:DateUtc> <d5p1:UserName>sample string 2</d5p1:UserName> </Created> <Goal>sample string 8</Goal> <IsDefault>true</IsDefault> <IsRequired>true</IsRequired> <LastUpdated xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models"> <d5p1:DateUtc>2024-12-04T08:06:27.0483666+00:00</d5p1:DateUtc> <d5p1:UserName>sample string 2</d5p1:UserName> </LastUpdated> <ParentCarePlanItemLinkID>1</ParentCarePlanItemLinkID> <ParentCarePlanItemLinkName>sample string 6</ParentCarePlanItemLinkName> <Problem>sample string 7</Problem> <RecordState>Active</RecordState> <SortOrder>11</SortOrder> </CarePlanItemLink> <CarePlanItemLink> <CarePlanID>2</CarePlanID> <CarePlanItemAnswerType>New</CarePlanItemAnswerType> <CarePlanItemCaption>sample string 13</CarePlanItemCaption> <CarePlanItemCategoryID>14</CarePlanItemCategoryID> <CarePlanItemID>5</CarePlanItemID> <CarePlanItemLinkID>1</CarePlanItemLinkID> <CarePlanItemName>sample string 12</CarePlanItemName> <CarePlanItemType>Problem</CarePlanItemType> <CarePlanName>sample string 3</CarePlanName> <CarePlanTitle>sample string 4</CarePlanTitle> <CategoryDescription>sample string 16</CategoryDescription> <CategoryName>sample string 15</CategoryName> <Created xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models"> <d5p1:DateUtc>2024-12-04T08:06:27.0483666+00:00</d5p1:DateUtc> <d5p1:UserName>sample string 2</d5p1:UserName> </Created> <Goal>sample string 8</Goal> <IsDefault>true</IsDefault> <IsRequired>true</IsRequired> <LastUpdated xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models"> <d5p1:DateUtc>2024-12-04T08:06:27.0483666+00:00</d5p1:DateUtc> <d5p1:UserName>sample string 2</d5p1:UserName> </LastUpdated> <ParentCarePlanItemLinkID>1</ParentCarePlanItemLinkID> <ParentCarePlanItemLinkName>sample string 6</ParentCarePlanItemLinkName> <Problem>sample string 7</Problem> <RecordState>Active</RecordState> <SortOrder>11</SortOrder> </CarePlanItemLink> </CarePlanItemLinks> <CarePlanItems> <CarePlanItem> <AnswerType>New</AnswerType> <Caption>sample string 6</Caption> <CarePlanItemID>1</CarePlanItemID> <CarePlanItemName>sample string 5</CarePlanItemName> <CarePlanName>sample string 3</CarePlanName> <CategoryDescription>sample string 4</CategoryDescription> <CategoryName>sample string 2</CategoryName> <ClientCarePlanID>1</ClientCarePlanID> <IsCustom>true</IsCustom> <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" /> <RecordState>Active</RecordState> <Type>Problem</Type> </CarePlanItem> <CarePlanItem> <AnswerType>New</AnswerType> <Caption>sample string 6</Caption> <CarePlanItemID>1</CarePlanItemID> <CarePlanItemName>sample string 5</CarePlanItemName> <CarePlanName>sample string 3</CarePlanName> <CategoryDescription>sample string 4</CategoryDescription> <CategoryName>sample string 2</CategoryName> <ClientCarePlanID>1</ClientCarePlanID> <IsCustom>true</IsCustom> <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" /> <RecordState>Active</RecordState> <Type>Problem</Type> </CarePlanItem> </CarePlanItems> <CarePlans> <CarePlan> <BusinessUnits> <CarePlanBusinessUnit> <BUID>1</BUID> <BusinessUnitName>sample string 3</BusinessUnitName> <CarePlanID>2</CarePlanID> <RecordState>Active</RecordState> </CarePlanBusinessUnit> <CarePlanBusinessUnit> <BUID>1</BUID> <BusinessUnitName>sample string 3</BusinessUnitName> <CarePlanID>2</CarePlanID> <RecordState>Active</RecordState> </CarePlanBusinessUnit> </BusinessUnits> <CarePlanID>1</CarePlanID> <CarePlanName>sample string 4</CarePlanName> <CarePlanResponseCodeTableID>2</CarePlanResponseCodeTableID> <CarePlanResponseCodeTableName>sample string 3</CarePlanResponseCodeTableName> <Comments>sample string 7</Comments> <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" /> <RecordState>Active</RecordState> <SortOrder>6</SortOrder> <Title>sample string 5</Title> <Type>Primary</Type> </CarePlan> <CarePlan> <BusinessUnits> <CarePlanBusinessUnit> <BUID>1</BUID> <BusinessUnitName>sample string 3</BusinessUnitName> <CarePlanID>2</CarePlanID> <RecordState>Active</RecordState> </CarePlanBusinessUnit> <CarePlanBusinessUnit> <BUID>1</BUID> <BusinessUnitName>sample string 3</BusinessUnitName> <CarePlanID>2</CarePlanID> <RecordState>Active</RecordState> </CarePlanBusinessUnit> </BusinessUnits> <CarePlanID>1</CarePlanID> <CarePlanName>sample string 4</CarePlanName> <CarePlanResponseCodeTableID>2</CarePlanResponseCodeTableID> <CarePlanResponseCodeTableName>sample string 3</CarePlanResponseCodeTableName> <Comments>sample string 7</Comments> <Props xmlns:d5p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" /> <RecordState>Active</RecordState> <SortOrder>6</SortOrder> <Title>sample string 5</Title> <Type>Primary</Type> </CarePlan> </CarePlans> </CarePlanPackage> </ArrayOfCarePlanPackage>
application/x-compressed-json
Sample:
� �W�n�0~Cץ��8n�[�\���%�!�����J2����G�+���V����H�,��(�|����$c ���$�N_�$ G��[Е,5�d�.��G�诙 ��DU@����&��?�1�m;߆�bh2A-��Q9(�&�(������*ȤʿfZ�u�y Z/Knڈ�5�;�>�f[���8z_�U�+rRYY8D�5(y����T['rt,�m]Z�9�L��pY:�c;w�M�"��Z�s'�׳Z)HjT h[p��ۏ��U���+�>/���:�+/�]�H{���(�N��3ӠN�(�b����t^�����p�#Y1PLwI��OVf�U�o�� ��zd�p��d ��H�K����F�Y��xA�)M���3���$I>Q�R��k �`;�Z��C] � �����E�\^��)�6�*?��eB��bv���q��"̋��%�%﮳�#�A8y#����`p��ȳ˳˳���ՙS�q�S��#N�"~��{��#���'��4��=³˳�����5Å�