GET CarePlans/CarePlan/{carePlanID}?includePayload={includePayload}

Request Information

URI Parameters

Name	Description	Type	Additional information
carePlanID		integer	Required
includePayload		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

CarePlanDTO

Name	Type	Additional information
CarePlanID	integer	None.
CarePlanResponseCodeTableID	integer	None.
CarePlanResponseCodeTableName	string	None.
CarePlanName	string	None.
Type	CarePlanType	None.
Title	string	None.
Props	Collection of Object	None.
SortOrder	integer	None.
Comments	string	None.
RecordState	RecordState	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
BusinessUnits	Collection of CarePlanBusinessUnitDTO	None.
CarePlanItems	Collection of CarePlanItemLinkDTO	None.
ResponseSubCodes	Collection of CarePlanResponseSubCodeDTO	None.
Summary	string	None.

Response Formats

application/json, text/json

Sample:

{
  "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,
  "created": {
    "dateUtc": "2024-12-04T07:48:56.7293848+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:48:56 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T07:48:56.7293848+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:48:56 AM"
  },
  "businessUnits": [
    {
      "buid": 1,
      "carePlanID": 2,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:48:56.7293848+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:48:56 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:48:56.7293848+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:48:56 AM"
      },
      "businessUnitName": "sample string 3",
      "summary": "sample string 3"
    },
    {
      "buid": 1,
      "carePlanID": 2,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:48:56.7293848+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:48:56 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:48:56.7293848+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:48:56 AM"
      },
      "businessUnitName": "sample string 3",
      "summary": "sample string 3"
    }
  ],
  "carePlanItems": [
    {
      "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:48:56.7293848+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:48:56 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:48:56.7293848+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:48: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-04T07:48:56.7293848+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:48:56 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:48:56.7293848+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:48: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"
    }
  ],
  "responseSubCodes": [
    {
      "carePlanResponseSubCodeID": 1,
      "carePlanResponseCodeID": 2,
      "responseSubCodeName": "sample string 3",
      "responseSubCode": "sample string 4",
      "responseSubCodeDescription": "sample string 5",
      "sortOrder": 6,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:48:56.7293848+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:48:56 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:48:56.7293848+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:48:56 AM"
      },
      "responseCodeName": "sample string 7",
      "responseCode": "sample string 8",
      "responseCodeDescription": "sample string 9",
      "summary": "sample string 7, sample string 3: sample string 5"
    },
    {
      "carePlanResponseSubCodeID": 1,
      "carePlanResponseCodeID": 2,
      "responseSubCodeName": "sample string 3",
      "responseSubCode": "sample string 4",
      "responseSubCodeDescription": "sample string 5",
      "sortOrder": 6,
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:48:56.7293848+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:48:56 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:48:56.7293848+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:48:56 AM"
      },
      "responseCodeName": "sample string 7",
      "responseCode": "sample string 8",
      "responseCodeDescription": "sample string 9",
      "summary": "sample string 7, sample string 3: sample string 5"
    }
  ],
  "summary": "sample string 4"
}

application/xml, text/xml

Sample:

<CarePlanDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <BusinessUnits>
    <CarePlanBusinessUnitDTO>
      <BUID>1</BUID>
      <BusinessUnitName>sample string 3</BusinessUnitName>
      <CarePlanID>2</CarePlanID>
      <Created>
        <DateUtc>2024-12-04T07:48:56.7293848+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <LastUpdated>
        <DateUtc>2024-12-04T07:48:56.7293848+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <RecordState>Active</RecordState>
    </CarePlanBusinessUnitDTO>
    <CarePlanBusinessUnitDTO>
      <BUID>1</BUID>
      <BusinessUnitName>sample string 3</BusinessUnitName>
      <CarePlanID>2</CarePlanID>
      <Created>
        <DateUtc>2024-12-04T07:48:56.7293848+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <LastUpdated>
        <DateUtc>2024-12-04T07:48:56.7293848+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <RecordState>Active</RecordState>
    </CarePlanBusinessUnitDTO>
  </BusinessUnits>
  <CarePlanID>1</CarePlanID>
  <CarePlanItems>
    <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:48:56.7293848+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <IsDefault>true</IsDefault>
      <IsRequired>true</IsRequired>
      <LastUpdated>
        <DateUtc>2024-12-04T07:48:56.7293848+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:48:56.7293848+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <IsDefault>true</IsDefault>
      <IsRequired>true</IsRequired>
      <LastUpdated>
        <DateUtc>2024-12-04T07:48:56.7293848+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <ParentCarePlanItemLinkID>1</ParentCarePlanItemLinkID>
      <RecordState>Active</RecordState>
      <SortOrder>8</SortOrder>
    </CarePlanItemLinkDTO>
  </CarePlanItems>
  <CarePlanName>sample string 4</CarePlanName>
  <CarePlanResponseCodeTableID>2</CarePlanResponseCodeTableID>
  <CarePlanResponseCodeTableName>sample string 3</CarePlanResponseCodeTableName>
  <Comments>sample string 7</Comments>
  <Created>
    <DateUtc>2024-12-04T07:48:56.7293848+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </Created>
  <LastUpdated>
    <DateUtc>2024-12-04T07:48:56.7293848+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </LastUpdated>
  <Props xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
  <RecordState>Active</RecordState>
  <ResponseSubCodes>
    <CarePlanResponseSubCodeDTO>
      <CarePlanResponseCodeID>2</CarePlanResponseCodeID>
      <CarePlanResponseSubCodeID>1</CarePlanResponseSubCodeID>
      <Created>
        <DateUtc>2024-12-04T07:48:56.7293848+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <LastUpdated>
        <DateUtc>2024-12-04T07:48:56.7293848+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <RecordState>Active</RecordState>
      <ResponseCode>sample string 8</ResponseCode>
      <ResponseCodeDescription>sample string 9</ResponseCodeDescription>
      <ResponseCodeName>sample string 7</ResponseCodeName>
      <ResponseSubCode>sample string 4</ResponseSubCode>
      <ResponseSubCodeDescription>sample string 5</ResponseSubCodeDescription>
      <ResponseSubCodeName>sample string 3</ResponseSubCodeName>
      <SortOrder>6</SortOrder>
    </CarePlanResponseSubCodeDTO>
    <CarePlanResponseSubCodeDTO>
      <CarePlanResponseCodeID>2</CarePlanResponseCodeID>
      <CarePlanResponseSubCodeID>1</CarePlanResponseSubCodeID>
      <Created>
        <DateUtc>2024-12-04T07:48:56.7293848+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <LastUpdated>
        <DateUtc>2024-12-04T07:48:56.7293848+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <RecordState>Active</RecordState>
      <ResponseCode>sample string 8</ResponseCode>
      <ResponseCodeDescription>sample string 9</ResponseCodeDescription>
      <ResponseCodeName>sample string 7</ResponseCodeName>
      <ResponseSubCode>sample string 4</ResponseSubCode>
      <ResponseSubCodeDescription>sample string 5</ResponseSubCodeDescription>
      <ResponseSubCodeName>sample string 3</ResponseSubCodeName>
      <SortOrder>6</SortOrder>
    </CarePlanResponseSubCodeDTO>
  </ResponseSubCodes>
  <SortOrder>6</SortOrder>
  <Title>sample string 5</Title>
  <Type>Primary</Type>
</CarePlanDTO>

application/x-compressed-json

Sample:

��VKn�0���m�F��H�.�7��c�/hi�H��PFN�E��+��R[�>
�Iܑ3���y3C�����2"�kA؇���]��8���6d_���Ϥ��$eU�'������ˉA@��P��nEUч,4Dr����7���%0%{�XCd\�w���4��9�G���Ve�X��U^��Əq�����8\Γ(y����5Q-A����$���y�yAx]�+�'n��z���H���ξ����[FM.��B�N<��r����v��\38^_�]+�
ʦ7ږ��}��5�;
7��.Bݫ
�b�*mb*���|#u�V�cXÏ�
#Fci������iK1ȼ��JI�(g=\�[�Ϳ7�m�e�'�AW�3���������
BtA�@f���5��M��T�<�H֖�I�Zµ�k�KK�L!5��zo~�ݧc�uN���O~��hY���0S9���]<7�Rq�9F]P�X�)��a�3Ϫ��:����NW�o�:w��#��8�Sx�