GET Clients/CarePlanEntryItem/Initialize?BUID={BUID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
BUID

integer

None.

Body Parameters

None.

Response Information

Resource Description

ClientCarePlanEntryItemDTO
NameDescriptionTypeAdditional information
ClientCarePlanEntryID

integer

None.

CarePlanItemID

integer

None.

OriginalClientCarePlanEntryID

integer

None.

Type

CarePlanType

None.

ResponseType

ClientCarePlanItemResponseType

None.

CarePlanResponseSubCodeID

integer

None.

RecordState

ClinicalRecordState

None.

CreatedByUserID

integer

None.

LastUpdatedByUserID

integer

None.

Created

AuditDataDTO

None.

LastUpdated

AuditDataDTO

None.

ClientCarePlanEntryItemNotes

Collection of ClientCarePlanEntryItemNoteDTO

None.

CarePlanItemName

string

None.

CarePlanItemCaption

string

None.

CarePlanItemType

CarePlanItemType

None.

CarePlanItemCategoryID

integer

None.

ResponseSubCodeName

string

None.

ResponseSubCode

string

None.

ResponseSubCodeDescription

string

None.

ClientCarePlanID

integer

None.

CarePlanItemLinkID

integer

None.

ParentCarePlanItemLinkID

integer

None.

IsDefault

boolean

None.

IsRequired

boolean

None.

IsPersonalized

boolean

None.

IsFromRecommendation

boolean

None.

Summary

string

None.

CarePlanItemIsCustom

boolean

None.

CarePlanItemAnswerType

CarePlanItemAnswerType

None.

SortOrders

Collection of ClientCarePlanEntryItemsSortOrderDTO

None.

Response Formats

application/json, text/json

Sample:
{
  "clientCarePlanEntryID": 1,
  "carePlanItemID": 2,
  "originalClientCarePlanEntryID": 1,
  "type": 1,
  "responseType": 1,
  "carePlanResponseSubCodeID": 1,
  "recordState": 1,
  "createdByUserID": 3,
  "lastUpdatedByUserID": 4,
  "created": {
    "dateUtc": "2024-12-04T08:02:48.2279003+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 8:02:48 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T08:02:48.2279003+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 8:02:48 AM"
  },
  "clientCarePlanEntryItemNotes": [
    {
      "clientCarePlanEntryItemNoteID": 1,
      "clientCarePlanEntryID": 2,
      "carePlanItemID": 3,
      "contents": "sample string 4",
      "carePlanItemType": 1,
      "carePlanName": "sample string 5",
      "carePlanItemName": "sample string 6",
      "carePlanItemCaption": "sample string 7",
      "recordState": 1,
      "createdByUserID": 8,
      "lastUpdatedByUserID": 9,
      "created": {
        "dateUtc": "2024-12-04T08:02:48.2279003+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:02:48 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:02:48.2279003+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:02:48 AM"
      },
      "summary": "sample string 4"
    },
    {
      "clientCarePlanEntryItemNoteID": 1,
      "clientCarePlanEntryID": 2,
      "carePlanItemID": 3,
      "contents": "sample string 4",
      "carePlanItemType": 1,
      "carePlanName": "sample string 5",
      "carePlanItemName": "sample string 6",
      "carePlanItemCaption": "sample string 7",
      "recordState": 1,
      "createdByUserID": 8,
      "lastUpdatedByUserID": 9,
      "created": {
        "dateUtc": "2024-12-04T08:02:48.2279003+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:02:48 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:02:48.2279003+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:02:48 AM"
      },
      "summary": "sample string 4"
    }
  ],
  "carePlanItemName": "sample string 5",
  "carePlanItemCaption": "sample string 6",
  "carePlanItemType": 1,
  "carePlanItemCategoryID": 7,
  "responseSubCodeName": "sample string 8",
  "responseSubCode": "sample string 9",
  "responseSubCodeDescription": "sample string 10",
  "clientCarePlanID": 1,
  "carePlanItemLinkID": 11,
  "parentCarePlanItemLinkID": 1,
  "isDefault": true,
  "isRequired": true,
  "isPersonalized": true,
  "isFromRecommendation": true,
  "summary": "sample string 5, sample string 8: sample string 9",
  "carePlanItemIsCustom": true,
  "carePlanItemAnswerType": 1,
  "sortOrders": [
    {
      "carePlanItemLinkID": 1,
      "sortOrder": 2
    },
    {
      "carePlanItemLinkID": 1,
      "sortOrder": 2
    }
  ]
}

application/xml, text/xml

Sample:
<ClientCarePlanEntryItemDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <CarePlanItemAnswerType>New</CarePlanItemAnswerType>
  <CarePlanItemCaption>sample string 6</CarePlanItemCaption>
  <CarePlanItemCategoryID>7</CarePlanItemCategoryID>
  <CarePlanItemID>2</CarePlanItemID>
  <CarePlanItemIsCustom>true</CarePlanItemIsCustom>
  <CarePlanItemLinkID>11</CarePlanItemLinkID>
  <CarePlanItemName>sample string 5</CarePlanItemName>
  <CarePlanItemType>Problem</CarePlanItemType>
  <CarePlanResponseSubCodeID>1</CarePlanResponseSubCodeID>
  <ClientCarePlanEntryID>1</ClientCarePlanEntryID>
  <ClientCarePlanEntryItemNotes>
    <ClientCarePlanEntryItemNoteDTO>
      <CarePlanItemCaption>sample string 7</CarePlanItemCaption>
      <CarePlanItemID>3</CarePlanItemID>
      <CarePlanItemName>sample string 6</CarePlanItemName>
      <CarePlanItemType>Problem</CarePlanItemType>
      <CarePlanName>sample string 5</CarePlanName>
      <ClientCarePlanEntryID>2</ClientCarePlanEntryID>
      <ClientCarePlanEntryItemNoteID>1</ClientCarePlanEntryItemNoteID>
      <Contents>sample string 4</Contents>
      <Created>
        <DateUtc>2024-12-04T08:02:48.2279003+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <CreatedByUserID>8</CreatedByUserID>
      <LastUpdated>
        <DateUtc>2024-12-04T08:02:48.2279003+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <LastUpdatedByUserID>9</LastUpdatedByUserID>
      <RecordState>Active</RecordState>
    </ClientCarePlanEntryItemNoteDTO>
    <ClientCarePlanEntryItemNoteDTO>
      <CarePlanItemCaption>sample string 7</CarePlanItemCaption>
      <CarePlanItemID>3</CarePlanItemID>
      <CarePlanItemName>sample string 6</CarePlanItemName>
      <CarePlanItemType>Problem</CarePlanItemType>
      <CarePlanName>sample string 5</CarePlanName>
      <ClientCarePlanEntryID>2</ClientCarePlanEntryID>
      <ClientCarePlanEntryItemNoteID>1</ClientCarePlanEntryItemNoteID>
      <Contents>sample string 4</Contents>
      <Created>
        <DateUtc>2024-12-04T08:02:48.2279003+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <CreatedByUserID>8</CreatedByUserID>
      <LastUpdated>
        <DateUtc>2024-12-04T08:02:48.2279003+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <LastUpdatedByUserID>9</LastUpdatedByUserID>
      <RecordState>Active</RecordState>
    </ClientCarePlanEntryItemNoteDTO>
  </ClientCarePlanEntryItemNotes>
  <ClientCarePlanID>1</ClientCarePlanID>
  <Created>
    <DateUtc>2024-12-04T08:02:48.2279003+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </Created>
  <CreatedByUserID>3</CreatedByUserID>
  <IsDefault>true</IsDefault>
  <IsFromRecommendation>true</IsFromRecommendation>
  <IsPersonalized>true</IsPersonalized>
  <IsRequired>true</IsRequired>
  <LastUpdated>
    <DateUtc>2024-12-04T08:02:48.2279003+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </LastUpdated>
  <LastUpdatedByUserID>4</LastUpdatedByUserID>
  <OriginalClientCarePlanEntryID>1</OriginalClientCarePlanEntryID>
  <ParentCarePlanItemLinkID>1</ParentCarePlanItemLinkID>
  <RecordState>Active</RecordState>
  <ResponseSubCode>sample string 9</ResponseSubCode>
  <ResponseSubCodeDescription>sample string 10</ResponseSubCodeDescription>
  <ResponseSubCodeName>sample string 8</ResponseSubCodeName>
  <ResponseType>NotDone</ResponseType>
  <SortOrders>
    <ClientCarePlanEntryItemsSortOrderDTO>
      <CarePlanItemLinkID>1</CarePlanItemLinkID>
      <SortOrder>2</SortOrder>
    </ClientCarePlanEntryItemsSortOrderDTO>
    <ClientCarePlanEntryItemsSortOrderDTO>
      <CarePlanItemLinkID>1</CarePlanItemLinkID>
      <SortOrder>2</SortOrder>
    </ClientCarePlanEntryItemsSortOrderDTO>
  </SortOrders>
  <Type>Primary</Type>
</ClientCarePlanEntryItemDTO>

application/x-compressed-json

Sample:
��UAn�0����*
�(��[*�@�6
��T��H[��H�$��
���~!�-��(���7bvv����y���\�
�\}P�l��&1d
v�P��A���h�۔�]��V�[�-�lw�c�sl�f��w���m�/����ESs.b(�u�2��ɞ�	���e����M�I�Ɍʒ�[J�sB.���*_�K�#X.�#�P������f�"��	=O��-��vt��;-��v���j�h���a�B�a�i��P���lt�@��b�ܗ��Aһ)�Z�)�و��'���3�����b'��_�=!`_�1�B�%;\�G��]3���A�8�@�1�ꤾ����۟����=^z��|�A�~�U�9Sa
,�G%L��ܢ�ڏ���h�\z�K���d��.6��e��E�et�M+�l+Ʈ���f/���}1�ou7�ϻg�f�KA{x~^��2