POST PlanCare2Api/CareRegistration/Catheter
Saves a new catheter registration
Requires 'Start' permission for function CatheterOverview {7B6BDDF7-0982-4C3F-9446-CF4286B1A012}
Request Information
URI Parameters
None.
Body Parameters
The catheter instance to save
Catheter| Name | Description | Type | Additional information |
|---|---|---|---|
| IntermittingCatheterExplanation |
Intermitting catheter explanation |
string |
None. |
| IntermittingCatheterSize |
The value of the choice for ChoiceType 'KATHETER INTER MAAT'. This property is for reading purposes only. |
string |
None. |
| IntermittingCatheterSizeId |
References to a Choice of ChoiceType 'KATHETER INTER MAAT' |
integer |
None. |
| IntermittingCatheterType |
The value of the choice for ChoiceType 'KATHETER INTER TYPE'. This property is for reading purposes only. |
string |
None. |
| IntermittingCatheterTypeId |
References to a Choice of ChoiceType 'KATHETER INTER TYPE' |
integer |
None. |
| IsIntermittingCatheter |
Is intermitting catheter |
boolean |
None. |
| IsOlderThanTwoWeeks |
The value of the choice for ChoiceType 'KATHETER OUD'. This property is for reading purposes only. |
string |
None. |
| IsOlderThanTwoWeeksId |
References to a Choice of ChoiceType 'KATHETER OUD' |
integer |
None. |
| StayCatheterBagChange |
The value of the choice for ChoiceType 'KATHETER ZAKWISSELFREQUENTIE'. This property is for reading purposes only. |
string |
None. |
| StayCatheterBagChangeId |
References to a Choice of ChoiceType 'KATHETER ZAKWISSELFREQUENTIE' |
integer |
None. |
| StayCatheterBagTypeDay |
The value of the choice for ChoiceType 'KATHETER ZAKTYPE DAG'. This property is for reading purposes only. |
string |
None. |
| StayCatheterBagTypeDayId |
References to a Choice of ChoiceType 'KATHETER ZAKTYPE DAG' |
integer |
None. |
| StayCatheterBagVolumeNight |
The value of the choice for ChoiceType 'KATHETER ZAKTYPE NACHT'. This property is for reading purposes only. |
string |
None. |
| StayCatheterBagVolumeNightId |
References to a Choice of ChoiceType 'KATHETER ZAKVOLUME NACHT' |
integer |
None. |
| StayCatheterChangeFrequency |
The value of the choice for ChoiceType 'KATHETER WISSELFREQUENTIE'. This property is for reading purposes only. |
string |
None. |
| StayCatheterChangeFrequencyId |
References to a Choice of ChoiceType 'KATHETER WISSELFREQUENTIE' |
integer |
None. |
| StayCatheterFlushConcentration |
The value of the choice for ChoiceType 'KATHETER SPOELVOLUME'. This property is for reading purposes only. |
string |
None. |
| StayCatheterFlushConcentrationId |
References to a Choice of ChoiceType 'KATHETER SPOELVOLUME' |
integer |
None. |
| StayCatheterFlushFrequency |
The value of the choice for ChoiceType 'KATHETER SPOELFREQUENTIE'. This property is for reading purposes only. |
string |
None. |
| StayCatheterFlushFrequencyId |
References to a Choice of ChoiceType 'KATHETER SPOELFREQUENTIE' |
integer |
None. |
| StayCatheterLastChangeDate |
Date of last stay catheter change |
date |
None. |
| StayCatheterNextChangeDate |
Date of next stay catheter change |
date |
None. |
| StayCatheterSize |
The value of the choice for ChoiceType 'KATHETER MAAT'. This property is for reading purposes only. |
string |
None. |
| StayCatheterSizeId |
References to a Choice of ChoiceType 'KATHETER MAAT' |
integer |
None. |
| StayCatheterType |
The value of the choice for ChoiceType 'KATHETER SOORT'. This property is for reading purposes only. |
string |
None. |
| StayCatheterTypeId |
References to a Choice of ChoiceType 'KATHETER SOORT' |
integer |
None. |
| StayCatheterVolume |
The stay catheter volume |
integer |
None. |
| HasStayCatheter |
Has client stay catheter |
boolean |
None. |
| AppliedInInstitution |
The value of the choice for ChoiceType 'KATHETER INGEBRACHT'. This property is for reading purposes only. |
string |
None. |
| AppliedInInstitutionId |
References to a Choice of ChoiceType 'KATHETER INGEBRACHT' |
integer |
None. |
| StayCatheterBagTypeNight |
The value of the choice for ChoiceType 'KATHETER ZAKTYPE NACHT'. This property is for reading purposes only. |
string |
None. |
| StayCatheterBagTypeNightId |
References to a Choice of ChoiceType 'KATHETER ZAKTYPE NACHT' |
integer |
None. |
| StayCatheterBagVolumeDay |
The value of the choice for ChoiceType 'KATHETER ZAKTYPE DAG'. This property is for reading purposes only. |
string |
None. |
| StayCatheterBagVolumeDayId |
References to a Choice of ChoiceType 'KATHETER ZAKVOLUME DAG' |
integer |
None. |
| IntermittingCatheterFrequency |
The value of the choice for ChoiceType 'KATHETER INTER FREQUENTIE'. This property is for reading purposes only. |
string |
None. |
| IntermittingCatheterFrequencyId |
References to a Choice of ChoiceType 'KATHETER INTER FREQUENTIE' |
integer |
None. |
| Id |
The internal id of the registration. Should be 0 for new instance. |
integer |
Required |
| EmployeeId |
The internal id of the employee who has done the registration. When the EmployeeId is not the same as the logged on employee, then the logged on employee must be authorized in Plancare2 to store information on behalf of the given EmployeeId. |
integer |
Required |
| EmployeeName |
The name of the employee. This property is for reading purposes only. |
string |
None. |
| ClientId |
The internal id of the client. |
integer |
Required |
| ClientName |
The name of the client. This property is for reading purposes only. |
string |
None. |
| CreationDate |
The date when the registration is created. This property is for reading purposes only. |
date |
None. |
| RegistrationDate |
The registration date. |
date |
Required |
Request Formats
application/json, text/json
{
"IntermittingCatheterExplanation": "sample string 1",
"IntermittingCatheterSize": "sample string 2",
"IntermittingCatheterSizeId": 1,
"IntermittingCatheterType": "sample string 3",
"IntermittingCatheterTypeId": 1,
"IsIntermittingCatheter": true,
"IsOlderThanTwoWeeks": "sample string 5",
"IsOlderThanTwoWeeksId": 1,
"StayCatheterBagChange": "sample string 6",
"StayCatheterBagChangeId": 1,
"StayCatheterBagTypeDay": "sample string 7",
"StayCatheterBagTypeDayId": 1,
"StayCatheterBagVolumeNight": "sample string 8",
"StayCatheterBagVolumeNightId": 1,
"StayCatheterChangeFrequency": "sample string 9",
"StayCatheterChangeFrequencyId": 1,
"StayCatheterFlushConcentration": "sample string 10",
"StayCatheterFlushConcentrationId": 1,
"StayCatheterFlushFrequency": "sample string 11",
"StayCatheterFlushFrequencyId": 1,
"StayCatheterLastChangeDate": "2026-05-26T22:10:09.3969472+02:00",
"StayCatheterNextChangeDate": "2026-05-26T22:10:09.3969472+02:00",
"StayCatheterSize": "sample string 12",
"StayCatheterSizeId": 1,
"StayCatheterType": "sample string 13",
"StayCatheterTypeId": 1,
"StayCatheterVolume": 1,
"HasStayCatheter": true,
"AppliedInInstitution": "sample string 15",
"AppliedInInstitutionId": 1,
"StayCatheterBagTypeNight": "sample string 16",
"StayCatheterBagTypeNightId": 1,
"StayCatheterBagVolumeDay": "sample string 17",
"StayCatheterBagVolumeDayId": 1,
"IntermittingCatheterFrequency": "sample string 18",
"IntermittingCatheterFrequencyId": 1,
"Id": 19,
"EmployeeId": 20,
"EmployeeName": "sample string 21",
"ClientId": 22,
"ClientName": "sample string 23",
"CreationDate": "2026-05-26T22:10:09.3969472+02:00",
"RegistrationDate": "2026-05-26T22:10:09.3969472+02:00"
}
application/xml, text/xml
<Catheter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.CareRegistration"> <ClientId>22</ClientId> <ClientName>sample string 23</ClientName> <CreationDate>2026-05-26T22:10:09.3969472+02:00</CreationDate> <EmployeeId>20</EmployeeId> <EmployeeName>sample string 21</EmployeeName> <Id>19</Id> <RegistrationDate>2026-05-26T22:10:09.3969472+02:00</RegistrationDate> <AppliedInInstitution>sample string 15</AppliedInInstitution> <AppliedInInstitutionId>1</AppliedInInstitutionId> <HasStayCatheter>true</HasStayCatheter> <IntermittingCatheterExplanation>sample string 1</IntermittingCatheterExplanation> <IntermittingCatheterFrequency>sample string 18</IntermittingCatheterFrequency> <IntermittingCatheterFrequencyId>1</IntermittingCatheterFrequencyId> <IntermittingCatheterSize>sample string 2</IntermittingCatheterSize> <IntermittingCatheterSizeId>1</IntermittingCatheterSizeId> <IntermittingCatheterType>sample string 3</IntermittingCatheterType> <IntermittingCatheterTypeId>1</IntermittingCatheterTypeId> <IsIntermittingCatheter>true</IsIntermittingCatheter> <IsOlderThanTwoWeeks>sample string 5</IsOlderThanTwoWeeks> <IsOlderThanTwoWeeksId>1</IsOlderThanTwoWeeksId> <StayCatheterBagChange>sample string 6</StayCatheterBagChange> <StayCatheterBagChangeId>1</StayCatheterBagChangeId> <StayCatheterBagTypeDay>sample string 7</StayCatheterBagTypeDay> <StayCatheterBagTypeDayId>1</StayCatheterBagTypeDayId> <StayCatheterBagTypeNight>sample string 16</StayCatheterBagTypeNight> <StayCatheterBagTypeNightId>1</StayCatheterBagTypeNightId> <StayCatheterBagVolumeDay>sample string 17</StayCatheterBagVolumeDay> <StayCatheterBagVolumeDayId>1</StayCatheterBagVolumeDayId> <StayCatheterBagVolumeNight>sample string 8</StayCatheterBagVolumeNight> <StayCatheterBagVolumeNightId>1</StayCatheterBagVolumeNightId> <StayCatheterChangeFrequency>sample string 9</StayCatheterChangeFrequency> <StayCatheterChangeFrequencyId>1</StayCatheterChangeFrequencyId> <StayCatheterFlushConcentration>sample string 10</StayCatheterFlushConcentration> <StayCatheterFlushConcentrationId>1</StayCatheterFlushConcentrationId> <StayCatheterFlushFrequency>sample string 11</StayCatheterFlushFrequency> <StayCatheterFlushFrequencyId>1</StayCatheterFlushFrequencyId> <StayCatheterLastChangeDate>2026-05-26T22:10:09.3969472+02:00</StayCatheterLastChangeDate> <StayCatheterNextChangeDate>2026-05-26T22:10:09.3969472+02:00</StayCatheterNextChangeDate> <StayCatheterSize>sample string 12</StayCatheterSize> <StayCatheterSizeId>1</StayCatheterSizeId> <StayCatheterType>sample string 13</StayCatheterType> <StayCatheterTypeId>1</StayCatheterTypeId> <StayCatheterVolume>1</StayCatheterVolume> </Catheter>
Response Information
Resource Description
Returns the HttpResponseMessage which contains the saved catheter instance
HttpResponseMessage| Name | Description | 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. |