GET Clients/CarePlanEntry/Initialize?BUID={BUID}&CarePlanID={CarePlanID}&ClientCarePlanID={ClientCarePlanID}

Request Information

URI Parameters

Name	Type	Additional information
BUID	integer	None.
CarePlanID	integer	None.
ClientCarePlanID	integer	None.

Body Parameters

None.

Response Information

Resource Description

ClientCarePlanEntryDTO

Name	Type	Additional information
ClientCarePlanEntryID	integer	None.
ClientCarePlanID	integer	None.
ClientID	integer	None.
CarePlanID	integer	None.
StartDateUtc	date	None.
StopDateUtc	date	None.
Comments	string	None.
RecordState	ClinicalRecordState	None.
RecordStateReason	string	None.
CreatedByUserID	integer	None.
LastUpdatedByUserID	integer	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
ClientCarePlanEntryItems	Collection of ClientCarePlanEntryItemDTO	None.
CarePlanName	string	None.
Title	string	None.
Summary	string	None.

Response Formats

application/json, text/json

Sample:

{
  "clientCarePlanEntryID": 1,
  "clientCarePlanID": 2,
  "clientID": 3,
  "carePlanID": 4,
  "startDateUtc": "2024-12-04T08:14:15.4166677+00:00",
  "stopDateUtc": "2024-12-04T08:14:15.4166677+00:00",
  "comments": "sample string 7",
  "recordState": 1,
  "recordStateReason": "sample string 8",
  "createdByUserID": 9,
  "lastUpdatedByUserID": 10,
  "created": {
    "dateUtc": "2024-12-04T08:14:15.4166677+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 8:14:15 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T08:14:15.4166677+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 8:14:15 AM"
  },
  "clientCarePlanEntryItems": [
    {
      "clientCarePlanEntryID": 1,
      "carePlanItemID": 2,
      "originalClientCarePlanEntryID": 1,
      "type": 1,
      "responseType": 1,
      "carePlanResponseSubCodeID": 1,
      "recordState": 1,
      "createdByUserID": 3,
      "lastUpdatedByUserID": 4,
      "created": {
        "dateUtc": "2024-12-04T08:14:15.4166677+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:14:15 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:14:15.4166677+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:14:15 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:14:15.4166677+00:00",
            "userName": "sample string 2",
            "summary": "sample string 2 on 12/4/2024 8:14:15 AM"
          },
          "lastUpdated": {
            "dateUtc": "2024-12-04T08:14:15.4166677+00:00",
            "userName": "sample string 2",
            "summary": "sample string 2 on 12/4/2024 8:14:15 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:14:15.4166677+00:00",
            "userName": "sample string 2",
            "summary": "sample string 2 on 12/4/2024 8:14:15 AM"
          },
          "lastUpdated": {
            "dateUtc": "2024-12-04T08:14:15.4166677+00:00",
            "userName": "sample string 2",
            "summary": "sample string 2 on 12/4/2024 8:14:15 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
        }
      ]
    },
    {
      "clientCarePlanEntryID": 1,
      "carePlanItemID": 2,
      "originalClientCarePlanEntryID": 1,
      "type": 1,
      "responseType": 1,
      "carePlanResponseSubCodeID": 1,
      "recordState": 1,
      "createdByUserID": 3,
      "lastUpdatedByUserID": 4,
      "created": {
        "dateUtc": "2024-12-04T08:14:15.4166677+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:14:15 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T08:14:15.4166677+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 8:14:15 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:14:15.4166677+00:00",
            "userName": "sample string 2",
            "summary": "sample string 2 on 12/4/2024 8:14:15 AM"
          },
          "lastUpdated": {
            "dateUtc": "2024-12-04T08:14:15.4166677+00:00",
            "userName": "sample string 2",
            "summary": "sample string 2 on 12/4/2024 8:14:15 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:14:15.4166677+00:00",
            "userName": "sample string 2",
            "summary": "sample string 2 on 12/4/2024 8:14:15 AM"
          },
          "lastUpdated": {
            "dateUtc": "2024-12-04T08:14:15.4166677+00:00",
            "userName": "sample string 2",
            "summary": "sample string 2 on 12/4/2024 8:14:15 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
        }
      ]
    }
  ],
  "carePlanName": "sample string 11",
  "title": "sample string 12",
  "summary": "ClientCarePlanEntryDTO"
}

application/xml, text/xml

Sample:

<ClientCarePlanEntryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <CarePlanID>4</CarePlanID>
  <CarePlanName>sample string 11</CarePlanName>
  <ClientCarePlanEntryID>1</ClientCarePlanEntryID>
  <ClientCarePlanEntryItems>
    <ClientCarePlanEntryItemDTO>
      <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:14:15.4166677+00:00</DateUtc>
            <UserName>sample string 2</UserName>
          </Created>
          <CreatedByUserID>8</CreatedByUserID>
          <LastUpdated>
            <DateUtc>2024-12-04T08:14:15.4166677+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:14:15.4166677+00:00</DateUtc>
            <UserName>sample string 2</UserName>
          </Created>
          <CreatedByUserID>8</CreatedByUserID>
          <LastUpdated>
            <DateUtc>2024-12-04T08:14:15.4166677+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:14:15.4166677+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:14:15.4166677+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>
    <ClientCarePlanEntryItemDTO>
      <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:14:15.4166677+00:00</DateUtc>
            <UserName>sample string 2</UserName>
          </Created>
          <CreatedByUserID>8</CreatedByUserID>
          <LastUpdated>
            <DateUtc>2024-12-04T08:14:15.4166677+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:14:15.4166677+00:00</DateUtc>
            <UserName>sample string 2</UserName>
          </Created>
          <CreatedByUserID>8</CreatedByUserID>
          <LastUpdated>
            <DateUtc>2024-12-04T08:14:15.4166677+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:14:15.4166677+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:14:15.4166677+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>
  </ClientCarePlanEntryItems>
  <ClientCarePlanID>2</ClientCarePlanID>
  <ClientID>3</ClientID>
  <Comments>sample string 7</Comments>
  <Created>
    <DateUtc>2024-12-04T08:14:15.4166677+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </Created>
  <CreatedByUserID>9</CreatedByUserID>
  <LastUpdated>
    <DateUtc>2024-12-04T08:14:15.4166677+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </LastUpdated>
  <LastUpdatedByUserID>10</LastUpdatedByUserID>
  <RecordState>Active</RecordState>
  <RecordStateReason>sample string 8</RecordStateReason>
  <StartDateUtc>2024-12-04T08:14:15.4166677+00:00</StartDateUtc>
  <StopDateUtc>2024-12-04T08:14:15.4166677+00:00</StopDateUtc>
  <Title>sample string 12</Title>
</ClientCarePlanEntryDTO>

application/x-compressed-json

Sample:

��V�n�0���*���/�R�
�I�ا�F�D%R%)n�/롟�_eK�$Ri|hQ<rw�ZrF�����=J2
L͉�����L�������T��	V��h�"IE�Zk���A���,�V�4�Q�G�#<�'�WA�JxqZE��\w 5\�����JP��&:) �"�Uz��Z�%əQ5�����Z���2�QF�Zi7��#��(=��RorEr0Z�{(󜈝��8�px�W��꽽ˏ����ЎMI
r�ԧ'eֈHck�qA���l>X�vEð,8��j�v�:q[��y
u]_ ��G������
�ٯ�as�:4�Q�ΔuD��7Ta=��We�{�9)��2T6P�̩l����H'�Ĝ����6� ����}�

�l�A���]��Y�?E���L�d"��U��\������/���:���>�r�I�)+QBX�ג���&rB[5�����;��%��ɾ�Cn������'������r^jK�7;�s�L~q�Jr��E�[=�p��Qz���3`��q���3�/����%'��,1痜_�W~i�i���[Q�YR]�[�bu�Ǆi+