POST CarePlans/Item?validateOnly={validateOnly}

Request Information

URI Parameters

Name	Description	Type	Additional information
validateOnly		boolean	Default value is False

Body Parameters

CarePlanItemDTO

Name	Type	Additional information
CarePlanItemID	integer	None.
CarePlanItemCategoryID	integer	None.
CarePlanItemName	string	None.
Type	CarePlanItemType	None.
AnswerType	CarePlanItemAnswerType	None.
Caption	string	None.
IsCustom	boolean	None.
ClientCarePlanID	integer	None.
Props	Collection of Object	None.
RecordState	ClinicalRecordState	None.
CreatedByUserID	integer	None.
LastUpdatedByUserID	integer	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
CategoryName	string	None.
CategoryDescription	string	None.
CarePlanItemLinks	Collection of CarePlanItemLinkDTO	None.
Summary	string	None.

Request Formats

application/json, text/json

Sample:

{
  "carePlanItemID": 1,
  "carePlanItemCategoryID": 2,
  "carePlanItemName": "sample string 3",
  "type": 1,
  "answerType": 1,
  "caption": "sample string 4",
  "isCustom": true,
  "clientCarePlanID": 1,
  "recordState": 1,
  "createdByUserID": 1,
  "lastUpdatedByUserID": 1,
  "created": {
    "dateUtc": "2024-12-04T07:46:05.8281653+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:46:05 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T07:46:05.8281653+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:46:05 AM"
  },
  "categoryName": "sample string 6",
  "categoryDescription": "sample string 7",
  "carePlanItemLinks": [
    {
      "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:46:05.8281653+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:46:05 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:46:05.8281653+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:46:05 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:46:05.8281653+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:46:05 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:46:05.8281653+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:46:05 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"
    }
  ],
  "summary": "sample string 3"
}

application/xml, text/xml

Sample:

<CarePlanItemDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <AnswerType>New</AnswerType>
  <Caption>sample string 4</Caption>
  <CarePlanItemCategoryID>2</CarePlanItemCategoryID>
  <CarePlanItemID>1</CarePlanItemID>
  <CarePlanItemLinks>
    <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:46:05.8281653+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <IsDefault>true</IsDefault>
      <IsRequired>true</IsRequired>
      <LastUpdated>
        <DateUtc>2024-12-04T07:46:05.8281653+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:46:05.8281653+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <IsDefault>true</IsDefault>
      <IsRequired>true</IsRequired>
      <LastUpdated>
        <DateUtc>2024-12-04T07:46:05.8281653+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </LastUpdated>
      <ParentCarePlanItemLinkID>1</ParentCarePlanItemLinkID>
      <RecordState>Active</RecordState>
      <SortOrder>8</SortOrder>
    </CarePlanItemLinkDTO>
  </CarePlanItemLinks>
  <CarePlanItemName>sample string 3</CarePlanItemName>
  <CategoryDescription>sample string 7</CategoryDescription>
  <CategoryName>sample string 6</CategoryName>
  <ClientCarePlanID>1</ClientCarePlanID>
  <Created>
    <DateUtc>2024-12-04T07:46:05.8281653+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </Created>
  <CreatedByUserID>1</CreatedByUserID>
  <IsCustom>true</IsCustom>
  <LastUpdated>
    <DateUtc>2024-12-04T07:46:05.8281653+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </LastUpdated>
  <LastUpdatedByUserID>1</LastUpdatedByUserID>
  <Props xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
  <RecordState>Active</RecordState>
  <Type>Problem</Type>
</CarePlanItemDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/x-compressed-json

Sample:

��T�n�0��h��b'a����Z8U=X�Y�V�Q!���~R�NI�D��%�g�=o���{���h�1\.��^%4�7��rȮB�<D`�x�h)-E�����K�#��rU�z<�"�g\sF�y�t�2E�
Fz^�������F�>�D���dk���\�u�7��rp�=��&�ۧv��+2f��Ğ��й"�b��&G�Um�4�̚�G�� /a����*�A�W��5��*O����j�[�+`/�F�n���:MUVBM�[+�g� 1�#U��7���PO��
��eQ���G	l�i�s���Y�Ě�B}ʹۊ��h�����i�_��0;���v���V[_]�65�s��H\F�x$^�Qv�g)Fק

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.