AccessUsers

Obtain AccessUsers

At least one of these modules is required: Base

APIDescription
POST PlanCare2Api/AccessUsers/ChangePasswordAccessUser

Post new password for accessuser.

Requires 'Start' permission for function BackOfficeOverview {FA1038EC-0FED-49E9-9376-D5DCE92D694E}

POST PlanCare2Api/AccessUsers/ChangePasswordCurrentAccessUser

Post new password for current accessuser.

Actions

Provides the ability to load actions. Only returns actions created in legacy clientplans

At least one of these modules is required: ICP

APIDescription
GET PlanCare2Api/Actions?clientId={clientId}

Retrieves a list of actions that belong to legacy clientplans of the client that have the status 'In progress'. Note: This endpoint is obsolete and will be deleted in a future version of the API. Use the endpoint PlanCare2Api/ActionsV2/ instead. This endpoint will return both legacy and current clientplan actions.

Deprecated: use PlanCare2Api/ActionsV2 instead

ActionsV2

Provides the ability to load actions.

At least one of these modules is required: ICP

APIDescription
GET PlanCare2Api/ActionsV2?clientId={clientId}

Retrieves a list of actions that belong to clientplans of the client that have the status 'In progress'.

GET PlanCare2Api/ActionsV2?actionIds[0]={actionIds[0]}&actionIds[1]={actionIds[1]}

Retrieves a list of actions by ids.

AdlCards

Obtain ADL data

At least one of these modules is required: ICP

APIDescription
GET PlanCare2Api/CareRegistration/AdlCards?clientId={clientId}&cardStatus={cardStatus}

Gets the ADL Cards with the specified status for the specified client

Requires 'Start' permission for function ADLCardOverview {6236CECC-0D36-4936-B5EF-F23BDD6A8D26}

GET PlanCare2Api/CareRegistration/AdlCards?clientId={clientId}

Gets the ADL Cards for the specified client

Requires 'Start' permission for function ADLCardOverview {6236CECC-0D36-4936-B5EF-F23BDD6A8D26}

AncClientInformation

Obtain information for ANC

At least one of these modules is required: ANC

APIDescription
GET PlanCare2Api/Anc/AncClientInformation

Retrieves client details for Anc Clientinformation

GET PlanCare2Api/Anc/AncClientInformation/ForClients?clientIds[0]={clientIds[0]}&clientIds[1]={clientIds[1]}

Retrieves client details for Anc Clientinformation

Appointments

Obtains appointments from calendars

At least one of these modules is required: GroupCalendar

APIDescription
GET PlanCare2Api/Appointments?dateFrom={dateFrom}&dateUntil={dateUntil}&clientIds[0]={clientIds[0]}&clientIds[1]={clientIds[1]}

Gets all appointments for the specified clients that occur in the specified period

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

GET PlanCare2Api/Appointments/Employee?dateFrom={dateFrom}&dateUntil={dateUntil}

Gets all appointments for the logged on employee that occur in the specified period

Requires 'Start' permission for function EmployeeCalendar {2B7BC787-80B4-41AD-8975-FD07F3CC1746}

POST PlanCare2Api/Appointments/AppointmentCompletion

Completes an appointment.

POST PlanCare2Api/Appointments/AppointmentCompletions

Completes an appointment. Note: This endpoint is obsolete and will be deleted in a future version of the API.

Deprecated: Use the endpoint PlanCare2Api/Appointments/AppointmentCompletion instead

POST PlanCare2Api/Appointments/CompleteAppointmentWithNotCompletedStatus

Closes the appointment and set status as 'Not-Completed'.

POST PlanCare2Api/Appointments/ReopenAppointment

Reopens an appointment. Appointment without time registration would not be reopened. This functionality is not supported yet. (Status Code: 'NotImplemented')

ArrangementProductActs

Obtains ArrangementProductActs

At least one of these modules is required: Base

APIDescription
GET PlanCare2Api/ArrangementProductActs?clientId={clientId}&referenceDate={referenceDate}

Fetches all ArrangementProductActs related to the provided client that are valid on the specified reference date

Calendars

Get calendar information

At least one of these modules is required: EmployeeCalendar, GroupCalendar

APIDescription
DELETE PlanCare2Api/Calendars/GroupCalendars/{groupcalendarId}/Clients?clientIds[0]={clientIds[0]}&clientIds[1]={clientIds[1]}

Deletes a list of clients for the specified group calendar

At least one of these modules is required: GroupCalendar

GET PlanCare2Api/Calendars

Gets all group calendars

Deprecated: use PlanCare2Api/Calendars/GroupCalendars instead

At least one of these modules is required: GroupCalendar

GET PlanCare2Api/Calendars/{calendarId}/AllowedClients

Gets allowed clients in the given calendar for logged on employee. In case of a team calendar the clients of the associated group calendars are returned.

GET PlanCare2Api/Calendars/{calendarId}/Shifts

Retrieve all shifts for a Calendar

GET PlanCare2Api/Calendars/GroupCalendars

Gets all group calendars

At least one of these modules is required: GroupCalendar

GET PlanCare2Api/Calendars/GroupCalendars/HasSelectClientsPermission

Gets the selectclientpermission for the selected employee

GET PlanCare2Api/Calendars/TeamCalendars

Gets all team calendars

GET PlanCare2Api/Calendars/TeamCalendars/{teamCalendarId}/GroupCalendars

Gets all group calendars in team calendar for loggedon employee Id of the team calendar for which to get the group calendars

POST PlanCare2Api/Calendars/GroupCalendars/{groupCalendarId}/Clients?clientIds[0]={clientIds[0]}&clientIds[1]={clientIds[1]}

Saves a list of clients for the specified group calendar. Ignores clients already member of the group calendar.

At least one of these modules is required: GroupCalendar

Call

Provides the ability to load calls.

At least one of these modules is required: Call

APIDescription
DELETE PlanCare2Api/Call/{id}

Delete call.

Requires 'Start' permission for function CallOverview {0D159E1F-6728-4243-9A43-996F7DC5AD8A}

GET PlanCare2Api/Call?dateIncidentFrom={dateIncidentFrom}&dateIncidentUntil={dateIncidentUntil}

Gets calls.

Requires 'Start' permission for function CallOverview {0D159E1F-6728-4243-9A43-996F7DC5AD8A}

GET PlanCare2Api/Call/{id}

Gets call by id.

Requires 'Start' permission for function CallOverview {0D159E1F-6728-4243-9A43-996F7DC5AD8A}

GET PlanCare2Api/Call/ActiveCallTypes

Gets active types of call.

Requires 'Start' permission for function CallOverview {0D159E1F-6728-4243-9A43-996F7DC5AD8A}

GET PlanCare2Api/Call/CallOptions?callTypeGuid={callTypeGuid}

Gets options of call.

Requires 'Start' permission for function CallOverview {0D159E1F-6728-4243-9A43-996F7DC5AD8A}

GET PlanCare2Api/Call/CallOptions?callId={callId}

Gets options of call.

Requires 'Start' permission for function CallOverview {0D159E1F-6728-4243-9A43-996F7DC5AD8A}

POST PlanCare2Api/Call

Insert call.

Requires 'Start' permission for function CallOverview {0D159E1F-6728-4243-9A43-996F7DC5AD8A}

POST PlanCare2Api/Call/Update

Update call.

Requires 'Start' permission for function CallOverview {0D159E1F-6728-4243-9A43-996F7DC5AD8A}

Catheter

Obtain and create Catheter registration

At least one of these modules is required: CareRegistration

APIDescription
DELETE PlanCare2Api/CareRegistration/Catheter/{id}

Deletes a catheter instance

Requires 'Start' permission for function CatheterOverview {7B6BDDF7-0982-4C3F-9446-CF4286B1A012}

GET PlanCare2Api/CareRegistration/Catheter?clientId={clientId}&from={from}&maxRecordCount={maxRecordCount}

Gets the catheter registrations of the specified client

Requires 'Start' permission for function CatheterOverview {7B6BDDF7-0982-4C3F-9446-CF4286B1A012}

GET PlanCare2Api/CareRegistration/Catheter?bsn={bsn}&from={from}&maxRecordCount={maxRecordCount}

Gets the catheter registrations of the specified client

Requires 'Start' permission for function CatheterOverview {7B6BDDF7-0982-4C3F-9446-CF4286B1A012}

POST PlanCare2Api/CareRegistration/Catheter

Saves a new catheter registration

Requires 'Start' permission for function CatheterOverview {7B6BDDF7-0982-4C3F-9446-CF4286B1A012}

POST PlanCare2Api/CareRegistration/Catheter/ChangeOfCatheters

Updates a catheter registration

Requires 'Start' permission for function CatheterOverview {7B6BDDF7-0982-4C3F-9446-CF4286B1A012}

ChoiceTypes

Obtain choices and choice types

Deprecated: ChoiceTypes should be accessed using the RootData API, please use the 'RootData' api

APIDescription
GET PlanCare2Api/ChoiceTypes

Gets all choice types

Deprecated: use PlanCare2ApiRootdata/ChoiceTypes instead

GET PlanCare2Api/ChoiceTypes/{choiceType}/Choices

Gets the choices of the specified choice type.

Deprecated: use PlanCare2Api/RootData/ChoiceTypes/{choiceType}/Choices instead

ClientAgreements

Obtains client agreements

At least one of these modules is required: ICP

APIDescription
GET PlanCare2Api/ClientAgreements?clientId={clientId}

Retrieves all agreements for the specified client that have no related clientplan. Also retrieves all agreements for the selected client that occur in clientplans with the status 'in progress'.

GET PlanCare2Api/ClientAgreements?clientIds[0]={clientIds[0]}&clientIds[1]={clientIds[1]}

Retrieves all agreements for the specified client that have no related clientplan. Also retrieves all agreements for the selected client that occur in clientplans with the status 'in progress'.

ClientAppointments

Obtain Client Appointments

At least one of these modules is required: GroupCalendar

APIDescription
DELETE PlanCare2Api/ClientAppointments/{appointmentId}

Deletes a client appointment instance

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

DELETE PlanCare2Api/ClientAppointments/{appointmentId}/OccurrenceIndex/{occurrenceIndex}

Deletes a client appointment occurrence

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

GET PlanCare2Api/ClientAppointments?clientIds[0]={clientIds[0]}&clientIds[1]={clientIds[1]}&dateFrom={dateFrom}&dateUntil={dateUntil}

Obtains all appointments

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

GET PlanCare2Api/ClientAppointments?clientId={clientId}&dateFrom={dateFrom}&dateUntil={dateUntil}

Obtains all appointments

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

GET PlanCare2Api/ClientAppointments?socialSecurityNumber={socialSecurityNumber}&dateFrom={dateFrom}&dateUntil={dateUntil}

Obtains all appointments

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

GET PlanCare2Api/ClientAppointments/ActionAppointments/{appointmentId}?occurrenceRangeFrom={occurrenceRangeFrom}&occurrenceRangeUntil={occurrenceRangeUntil}

Obtains the action appointment

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

GET PlanCare2Api/ClientAppointments/AgreementAppointments/{appointmentId}?occurrenceRangeFrom={occurrenceRangeFrom}&occurrenceRangeUntil={occurrenceRangeUntil}

Obtains the agreement appointment

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

GET PlanCare2Api/ClientAppointments/ArrangementProductActAppointments/{appointmentId}?occurrenceRangeFrom={occurrenceRangeFrom}&occurrenceRangeUntil={occurrenceRangeUntil}

Obtains the arrangement product act appointment

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

GET PlanCare2Api/ClientAppointments/ContractAppointments?clientIds[0]={clientIds[0]}&clientIds[1]={clientIds[1]}&dateFrom={dateFrom}&dateUntil={dateUntil}

Obtains all contract appointments

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

GET PlanCare2Api/ClientAppointments/ContractAppointments?clientId={clientId}&dateFrom={dateFrom}&dateUntil={dateUntil}

Obtains all contract appointments

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

GET PlanCare2Api/ClientAppointments/ContractAppointments?socialSecurityNumber={socialSecurityNumber}&dateFrom={dateFrom}&dateUntil={dateUntil}

Obtains all contract appointments

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

GET PlanCare2Api/ClientAppointments/ContractAppointments/{appointmentId}?occurrenceRangeFrom={occurrenceRangeFrom}&occurrenceRangeUntil={occurrenceRangeUntil}

Obtains the contract appointment

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

GET PlanCare2Api/ClientAppointments/GeneralAppointments/{appointmentId}?occurrenceRangeFrom={occurrenceRangeFrom}&occurrenceRangeUntil={occurrenceRangeUntil}

Obtains the arrangement product act appointment

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

GET PlanCare2Api/ClientAppointments/InterventionAppointments/{appointmentId}?occurrenceRangeFrom={occurrenceRangeFrom}&occurrenceRangeUntil={occurrenceRangeUntil}

Obtains the intervention appointment

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

GET PlanCare2Api/ClientAppointments/LegacyActionAppointments/{appointmentId}?occurrenceRangeFrom={occurrenceRangeFrom}&occurrenceRangeUntil={occurrenceRangeUntil}

Obtains the legacy action appointment

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

GET PlanCare2Api/ClientAppointments/OccurrenceAppointments/{appointmentId}

Obtains the occurrence appointment

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

GET PlanCare2Api/ClientAppointments/subscriptionappointments?clientIds[0]={clientIds[0]}&clientIds[1]={clientIds[1]}&dateFrom={dateFrom}&dateUntil={dateUntil}

Obtains all subscription appointments

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

GET PlanCare2Api/ClientAppointments/subscriptionappointments?clientId={clientId}&dateFrom={dateFrom}&dateUntil={dateUntil}

Obtains all subscription appointments

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

GET PlanCare2Api/ClientAppointments/subscriptionappointments?socialSecurityNumber={socialSecurityNumber}&dateFrom={dateFrom}&dateUntil={dateUntil}

Obtains all subscription appointments

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

GET PlanCare2Api/ClientAppointments/subscriptionappointments/{appointmentId}?occurrenceRangeFrom={occurrenceRangeFrom}&occurrenceRangeUntil={occurrenceRangeUntil}

Obtains the subscription appointment

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

POST PlanCare2Api/ClientAppointments/ActionAppointments

Saves a new ActionAppointment instance

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

POST PlanCare2Api/ClientAppointments/AgreementAppointments

Saves a new AgreementAppointment instance

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

POST PlanCare2Api/ClientAppointments/ArrangementProductActAppointments

Saves a new ArrangementProductActAppointment instance

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

POST PlanCare2Api/ClientAppointments/ChangeEmployeeForOccurrence

Creates a new appointment based on the occurrence for the changed employee. The existing occurrence will be changed to occurrence type 'DeletedOccurrence'

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

POST PlanCare2Api/ClientAppointments/ChangeOfActionAppointments

Updates an existing ActionAppointment instance

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

POST PlanCare2Api/ClientAppointments/ChangeOfAgreementAppointments

Updates an existing AgreementAppointment instance

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

POST PlanCare2Api/ClientAppointments/ChangeOfArrangementProductActAppointments

Updates an existing ArrangementProductActAppointment instance

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

POST PlanCare2Api/ClientAppointments/ChangeOfContractAppointments

Updates an existing contract appointment instance

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

POST PlanCare2Api/ClientAppointments/ChangeOfGeneralAppointments

Updates an existing GeneralAppointment instance

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

POST PlanCare2Api/ClientAppointments/ChangeOfGRZContractAppointments

Updates an existing ContractAppointment instance

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

POST PlanCare2Api/ClientAppointments/ChangeOfInterventionAppointments

Updates an existing InterventionAppointment instance

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

POST PlanCare2Api/ClientAppointments/ChangeOfLegacyActionAppointments

Updates an existing LegacyActionAppointment instance

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

POST PlanCare2Api/ClientAppointments/ChangeOfOccurrenceAppointments

Saves a new OccurrenceAppointment instance. This appointment is part of a recurring Appointment

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

POST PlanCare2Api/ClientAppointments/ChangeOfPCDContractAppointments

Updates an existing ContractAppointment instance

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

POST PlanCare2Api/ClientAppointments/ChangeOfPCDDBCContractAppointments

Updates an existing ContractAppointment instance

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

POST PlanCare2Api/ClientAppointments/ContractAppointments

Saves a new contract appointment instance

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

POST PlanCare2Api/ClientAppointments/GeneralAppointments

Saves a new GeneralAppointment instance

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

POST PlanCare2Api/ClientAppointments/GRZContractAppointments

Saves a new ContractAppointment instance

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

POST PlanCare2Api/ClientAppointments/InterventionAppointments

Saves a new InterventionAppointment instance

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

POST PlanCare2Api/ClientAppointments/LegacyActionAppointments

Saves a new LegacyActionAppointment instance

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

POST PlanCare2Api/ClientAppointments/OccurrenceAppointments

Saves a new OccurrenceAppointment instance. This appointment is part of a recurring Appointment

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

POST PlanCare2Api/ClientAppointments/PCDContractAppointments

Saves a new ContractAppointment instance

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

POST PlanCare2Api/ClientAppointments/PCDDBCContractAppointments

Saves a new ContractAppointment instance

Requires 'Start' permission for function ClientGroupCalendar {6D8B7697-D439-4E6E-9773-52E40081B837}

ClientAttentions

Obtains client attentions

At least one of these modules is required: Base

APIDescription
GET PlanCare2Api/ClientAttentions?clientId={clientId}

Retrieve all attentions for the selected client.

POST PlanCare2Api/ClientAttentions/ClientAttention

Create a new client attention.

ClientPermissions

Obtain client permissions for employees

APIDescription
GET PlanCare2Api/ClientPermissions?employeeId={employeeId}&referenceDate={referenceDate}

Gets the allowed clients of the specified employee

GET PlanCare2Api/ClientPermissions?referenceDate={referenceDate}

Gets all employees with allowed clients

Requires 'Start' permission for function BackOfficeOverview {FA1038EC-0FED-49E9-9376-D5DCE92D694E}

GET PlanCare2Api/ClientPermissions?employeeId={employeeId}&clientId={clientId}&referenceDate={referenceDate}

Get the ClientPermissions the specified client of the specified employee

Clientplans

Provides the ability to load Clientplans

At least one of these modules is required: ICP

APIDescription
GET PlanCare2Api/Clientplans?clientId={clientId}

Retrieve all clientplans for the selected client.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

ClientplansV2

Obtain Clientplans Version 2

At least one of these modules is required: ICP

APIDescription
DELETE PlanCare2Api/ClientplansV2/{clientplanId}/Careplans/{careplanId}/Domains/{domainId}/CareDemands/{careDemandId}/Goals/{goalId}

Deletes a goal instance.

Requires 'Edit' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

DELETE PlanCare2Api/ClientplansV2/{clientplanId}/ClientplanAgreements/{clientplanAgreementId}

Deletes a Clientplan V2 Agreement.

Requires 'Edit' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

GET PlanCare2Api/ClientplansV2

Retrieve all clientplans V2 for the logged on user.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

GET PlanCare2Api/ClientplansV2?clientId={clientId}

Retrieve all clientplans V2 for the selected client.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

GET PlanCare2Api/ClientplansV2/{clientplanId}/basicInformation

Retrieve the basic information of a clientplan V2.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

GET PlanCare2Api/ClientplansV2/{clientplanId}/Careplans

Retrieve the structures of a clientplan V2.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

GET PlanCare2Api/ClientplansV2/{clientplanId}/Careplans/{clientplanPartId}/CareDemands

Retrieve all care demands V2 for the selected clientplan.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

GET PlanCare2Api/ClientplansV2/{clientplanId}/ClientplanAgreements

Retrieve the Agreements of a clientplan V2.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

GET PlanCare2Api/ClientplansV2/{clientplanId}/omaha

Retrieve the Omaha System structure of a clientplan V2.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

GET PlanCare2Api/ClientplansV2/{clientplanId}/omaha/{clientplanOmahaAreaId}/measurements

Retrieves the ClientplanOmahaAreaMeasurements for the provided measurement.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

GET PlanCare2Api/ClientplansV2/{clientplanId}/PrimaryCare

Retrieve the selected acts of a clientplan V2.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

GET PlanCare2Api/ClientplansV2/{clientplanId}/questionnaires

Retrieve the questionnaires of a clientplan V2.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

GET PlanCare2Api/ClientplansV2/{clientplanId}/structures

Retrieve the structures of a clientplan V2. Note: This endpoint is obsolete and will be deleted in a future version of the API.

Deprecated: Use the endpoint PlanCare2Api/ClientplansV2/{clientplanId}/Careplans instead.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

GET PlanCare2Api/ClientplansV2/{clientplanId}/Workplans

Retrieve the Workplans of a clientplan V2.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

GET PlanCare2Api/ClientplansV2/{id}

Retrieve a clientplan V2.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

GET PlanCare2Api/ClientplansV2/availableResponsibleEmployees?referenceDate={referenceDate}

Retrieve the employees available as responsible person for a clientplan V2.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

GET PlanCare2Api/ClientplansV2/Disciplines

Retrieve the disciplines available for clientplans.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

GET PlanCare2Api/ClientplansV2/GoalLibrary?sectorId={sectorId}

Retrieve the library of clientplan goals.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

GET PlanCare2Api/ClientplansV2/Permissions/Goal

Retrieve a list of the user's clientplanV2 goal status permissions.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

GET PlanCare2Api/ClientplansV2/Sectors

Retrieve all clientplan Sectors.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

GET PlanCare2Api/ClientplansV2/Sectors?clientId={clientId}

Retrieve all clientplan Sectors by clientId.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

GET PlanCare2Api/ClientplansV2/Stripped?clientIds[0]={clientIds[0]}&clientIds[1]={clientIds[1]}

Retrieve all clientplans V2 for the selected client without its ClientplanPartInfos.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

GET PlanCare2Api/ClientplansV2/Types?sectorId={sectorId}

Retrieve the types of a clientplan V2 based on the sector.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

GET PlanCare2Api/ClientplansV2/VisionModels?sectorId={sectorId}

Retrieve the vision models available for a clientplan V2 sector based on the sector.

Requires 'Start' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

POST PlanCare2Api/ClientplansV2

Saves a new clientplan

Requires 'Edit' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

POST PlanCare2Api/ClientplansV2/{clientplanId}/Careplans/{careplanId}/Domains/{domainId}/CareDemands/{careDemandId}/Goals

Saves a new goal.

Requires 'Edit' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

POST PlanCare2Api/ClientplansV2/{clientplanId}/Careplans/{careplanId}/Domains/{domainId}/CareDemands/{careDemandId}/Goals/ChangeOfGoalV2

Updates an existing goal.

Requires 'Edit' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

POST PlanCare2Api/ClientplansV2/{clientplanId}/Careplans/{careplanId}/Domains/{domainId}/Goals

Saves a new goal.

Requires 'Edit' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

POST PlanCare2Api/ClientplansV2/{clientplanId}/ClientplanAgreements

Adds an Agreement to a Clientplan V2.

Requires 'Edit' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

POST PlanCare2Api/ClientplansV2/{clientplanId}/ClientplanAgreements/ChangeOfClientplanAgreement

Updates a Clientplan V2 Agreement.

Requires 'Edit' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

POST PlanCare2Api/ClientplansV2/{clientplanId}/ClientplanPartInfo

Set Visible flag of ClientplanPartInfo

Requires 'Edit' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

POST PlanCare2Api/ClientplansV2/AdvanceAgreementStatus/{agreementId}

Changes the status of an agreement to the next status. (concept-approved-inProgress-historical)

Requires 'Edit' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

POST PlanCare2Api/ClientplansV2/AdvanceGoalStatus/{goalAggregateId}

Changes the status of a goal to the next status. (concept-approved-inProgress-historical)

Requires 'Edit' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

POST PlanCare2Api/ClientplansV2/ChangeOfClientplanV2

Updates an existing clientplanV2

Requires 'Edit' permission for function ClientPlanOverview {7757BB23-A132-438A-9601-28E6BF9E4CA7}

ClientProtocols

Obtains client protocols

At least one of these modules is required: ICP

APIDescription
GET PlanCare2Api/ClientProtocols?clientId={clientId}&referenceDate={referenceDate}

Retrieve all protocols for the selected client.

Requires 'Start' permission for function ClientProtocols {B5597D92-76C6-41AC-A2AA-C46E0E6E6D57}

GET PlanCare2Api/ClientProtocols/Count?clientIds[0]={clientIds[0]}&clientIds[1]={clientIds[1]}&referenceDate={referenceDate}

Retrieve protocol counts per client.

Requires 'Start' permission for function ClientProtocols {B5597D92-76C6-41AC-A2AA-C46E0E6E6D57}

ClientReports

Obtain client reports

At least one of these modules is required: ICP

APIDescription
DELETE PlanCare2Api/ClientReports/{clientReportId}

Deletes the clientreport

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports?clientId={clientId}&dateFrom={dateFrom}&dateUntil={dateUntil}&maxResultCount={maxResultCount}&reportFormat={reportFormat}&withContent={withContent}

Gets all client reports by client Id

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports?clientIds[0]={clientIds[0]}&clientIds[1]={clientIds[1]}&dateFrom={dateFrom}&dateUntil={dateUntil}&maxResultCount={maxResultCount}&reportFormat={reportFormat}&withContent={withContent}

Gets all client reports by list of client Ids

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports?bsn={bsn}&dateFrom={dateFrom}&dateUntil={dateUntil}&maxResultCount={maxResultCount}&reportFormat={reportFormat}&withContent={withContent}

Gets all client reports by client social securitynumber

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports?clientReportIds[0]={clientReportIds[0]}&clientReportIds[1]={clientReportIds[1]}&reportFormat={reportFormat}

Gets all client reports by list of clientreport id.

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports/{clientId}/AppointmentRemarks

Retrieves the completed appointments for the given client

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports/ActionClientReports/{reportId}?format={format}

Get action client report by identifier

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports/AgreementClientReports/{reportId}?format={format}

Get agreement client report by identifier

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports/ClientAgreement?clientId={clientId}&referenceDate={referenceDate}

Retrieve all clientplanagreements for the selected client that overlap with the given date.

At least one of these modules is required: Base

GET PlanCare2Api/ClientReports/Disciplinesettings?disciplineId={disciplineId}

Retrieves all reportsettings for to given discipline.

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports/EpisodeClientReports/{reportId}?format={format}

Get episode client report by identifier

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports/Episodes?clientId={clientId}&referenceDate={referenceDate}

Retrieve all episodes for the selected client that overlap with the given date.

At least one of these modules is required: EBD

Requires 'ReportEpisode' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports/GeneralClientReports/{reportId}?format={format}

Get general client report by identifier

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports/Goal?goalId={goalId}

Retrieve details for a single goal.

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports/GoalClientReports/{reportId}?format={format}

Get goal client report by identifier

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports/Goals?clientId={clientId}&referenceDate={referenceDate}

Retrieve all goals for the selected client that overlap with the given date.

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports/IncidentalMeasureClientReports/{reportId}

Get incidental measure client report by identifier

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports/InterventionClientReport/{reportId}?format={format}

Get intervention client report by identifier

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports/Involuntarycares?clientId={clientId}&referenceDate={referenceDate}

Retrieve all involuntarycare measures for the selected client that overlap with the given date.

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports/LegacyActionClientReports/{reportId}?format={format}

Get legacy action client report by identifier

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports/LegacyAgreementClientReports/{reportId}?format={format}

Get legacy agreement client report by identifier

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports/LegacyGoalClientReports/{reportId}?format={format}

Get legacy goal client report by identifier

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports/LegacySubGoalClientReports/{reportId}?format={format}

Get legacy subgoal client report by identifier

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports/Permissions

Retrieves the ClientReport permissions for the current user

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports/StructuralMeasureClientReports/{reportId}?format={format}

Get structural measure client report by identifier

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports/SubGoalClientReports/{reportId}?format={format}

Get subgoal client report by identifier

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports/UnplannedMeasureClientReports/{reportId}

Get unplanned measure client report by identifier

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

GET PlanCare2Api/ClientReports/VisionModelItemClientReports/{reportId}?format={format}

Get VisionModelItem client report by identifier

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/ActionClientReports

Saves a new ActionClientReport instance

Requires 'ReportAction' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/AgreementClientReports

Saves a new AgreementClientReport instance

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/ChangeOfActionClientReports

Updates an existing ActionClientReport instance

Requires 'ReportAction' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/ChangeOfAgreementClientReports

Updates an existing AgreementClientReport instance

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/ChangeOfEpisodeClientReports

Updates an existing EpisodeClientReport instance

Requires 'ReportEpisode' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/ChangeOfGeneralClientReports

Updates an existing GeneralClientReport instance

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/ChangeOfGoalClientReports

Updates an existing GoalClientReport instance

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/ChangeOfIncidentalMeasureClientReports

Updates an existing incidental measure clientreport instance

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/ChangeOfIncidentalMeasures

Updates an existing incidental measure clientreport instance

Deprecated: Use the endpoint PlanCare2Api/ClientReports/ChangeOfIncidentalMeasureClientReports instead

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/ChangeOfInterventionClientReport

Updates an existing InterventionClientReport instance

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/ChangeOfLegacyActionClientReports

Updates an existing LegacyActionClientReport instance

Requires 'ReportAction' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/ChangeOfLegacyAgreementClientReports

Updates an existing LegacyAgreementClientReport instance

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/ChangeOfLegacyGoalClientReports

Updates an existing LegacyGoalClientReport instance

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/ChangeOfLegacySubGoalClientReports

Updates an existing LegacySubGoalClientReport instance

Requires 'ReportWorkPlan' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/ChangeOfStructuralMeasureClientReports

Updates an existing structural measure clientreport instance

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/ChangeOfStructuralMeasures

Updates an existing structural measure clientreport instance

Deprecated: Use the endpoint PlanCare2Api/ClientReports/ChangeOfStructuralMeasureClientReports instead

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/ChangeOfSubGoalClientReports

Updates an existing WorkplanClientReport instance

Requires 'ReportWorkPlan' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/ChangeOfUnplannedMeasureClientReports

Updates an existing unplanned involuntarycare measure report instance

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/ChangeOfUnplannedMeasures

Updates an existing unplanned involuntarycare measure report instance

Deprecated: Use the endpoint PlanCare2Api/ClientReports/ChangeOfUnplannedMeasureClientReports instead

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/ChangeOfVisionModelItemClientReports

Updates an existing VisionModelItemClientReport instance

Requires 'ReportVisionModel' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/ChangeOfWorkplanClientReports

Updates an existing WorkplanClientReport instance This route will change to ChangeofSubGoalClientReports in a next release

Deprecated: Use the endpoint PlanCare2Api/ClientReports/ChangeOfSubGoalClientReports instead

Requires 'ReportWorkPlan' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/EpisodeClientReports

Saves a new EpisodeClientReport instance

Requires 'ReportEpisode' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/GeneralClientReports

Saves a new GeneralClientReport instance

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/GoalClientReports

Saves a new GoalClientReport instance

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/IncidentalMeasureClientReports

Saves a new incidental measure clientreport instance

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/IncidentalMeasures

Saves a new incidental measure clientreport instance

Deprecated: Use the endpoint PlanCare2Api/ClientReports/IncidentalMeasureClientReports instead

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/InterventionClientReport

Saves a new InterventionClientReport instance

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/LegacyActionClientReports

Saves a new LegacyActionClientReport instance

Requires 'ReportAction' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/LegacyAgreementClientReports

Saves a new LegacyAgreementClientReport instance

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/LegacyGoalClientReports

Saves a new LegacyGoalClientReport instance

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/LegacySubGoalClientReports

Saves a new LegacySubGoalClientReport instance

Requires 'ReportWorkPlan' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/StructuralMeasureClientReports

Saves a new structural measure clientreport instance

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/StructuralMeasures

Saves a new structural measure clientreport instance

Deprecated: Use the endpoint PlanCare2Api/ClientReports/StructuralMeasureClientReports instead

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/SubGoalClientReports

Saves a new WorkplanClientReport instance

Requires 'ReportWorkPlan' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/UnplannedMeasures

Saves a new unplanned involuntarycare measure report instance

Deprecated: Use the endpoint PlanCare2Api/ClientReports/UnplannedMeasuresClientReports instead

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/UnplannedMeasuresClientReports

Saves a new unplanned involuntarycare measure report instance

Requires 'Start' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

POST PlanCare2Api/ClientReports/VisionModelItemClientReports

Saves a new VisionModelItemClientReport instance

Requires 'ReportVisionModel' permission for function ClientReportOverview {4250ABB5-A4FD-4362-8B29-79E0D78571E5}

Clients

Obtains relation information

APIDescription
GET PlanCare2Api/Clients?relationId={relationId}

Gets a client by using the relation identifier

GET PlanCare2Api/Clients?clientIds[0]={clientIds[0]}&clientIds[1]={clientIds[1]}

Gets a list of clients by their unique identifiers

GET PlanCare2Api/Clients/{clientId}

Gets a client by the unique identifier

GET PlanCare2Api/Clients/{clientId}/AllergyInformation

Get allergy information of the client

Deprecated, please use the PlanCare2Api/MedicalAllergyIntolerance?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil} endpoint

GET PlanCare2Api/Clients/{clientId}/BsnVerifications

Get the Bsn verification of the client

At least one of these modules is required: RelationManagement

Requires 'Read' permission for function ClientBsnVerification {2FE2E2CA-2643-45C6-B70C-DB85E6EC65B8}

GET PlanCare2Api/Clients/{clientId}/CovVerifications

Get the COV verification by client ID

At least one of these modules is required: RelationManagement

Requires 'Read' permission for function ClientCovVerification {257DE205-6F91-4688-AB5F-4267E563CF55}

GET PlanCare2Api/Clients/{clientId}/CprPolicies

Get the client's CPR policy

Deprecated, please use the PlanCare2Api/MedicalResuscitationPolicy?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil} endpoint

GET PlanCare2Api/Clients/{clientId}/DaytimeActivityMeetingEnrollments?startDate={startDate}&endDate={endDate}

Fetch daytime activity enrollments for client for all meetings in given period.

At least one of these modules is required: DaytimeActivity

Requires 'Start' permission for function DaytimeActivityOverview {16EDE7B1-4F4B-4C01-A7E4-79E73CF6B2E3}

GET PlanCare2Api/Clients/{clientId}/LawStatus

Get the client's law status

Requires 'Read' permission for function ClientLawStatus {4F25CFAD-284C-4D4B-89A7-27989D2371CB}

GET PlanCare2Api/Clients/{clientId}/ReportSubjects

Returns a list of subjects that can be used on reports.

GET PlanCare2Api/Clients/{clientId}/StartPage

Gets a start page by clientId. The start page contains: The calendar appointments of today, The reports of previous week, The client plans of this week and the medical information.

GET PlanCare2Api/Clients/{clientId}/WidVerifications

Get the most recent WID verification of a client

At least one of these modules is required: RelationManagement

Requires 'Read' permission for function ClientWidVerification {73E78B2B-7F1A-4368-A7D2-9EE1A8CEC145}

GET PlanCare2Api/Clients/{relationId}/PersonalData

Gets the personal data for a client

GET PlanCare2Api/Clients/ClientSubscriptions?contractStartDate={contractStartDate}&contractEndDate={contractEndDate}&contractExternalIds[0]={contractExternalIds[0]}&contractExternalIds[1]={contractExternalIds[1]}&contractTypeCodes[0]={contractTypeCodes[0]}&contractTypeCodes[1]={contractTypeCodes[1]}&contractAttributeNames[0]={contractAttributeNames[0]}&contractAttributeNames[1]={contractAttributeNames[1]}&contractAttributeStartDate={contractAttributeStartDate}&contractAttributeEndDate={contractAttributeEndDate}&organizationEntityCorrelationStartDate={organizationEntityCorrelationStartDate}&organizationEntityCorrelationEndDate={organizationEntityCorrelationEndDate}&organizationEntityExternalIds[0]={organizationEntityExternalIds[0]}&organizationEntityExternalIds[1]={organizationEntityExternalIds[1]}&organizationEntityNames[0]={organizationEntityNames[0]}&organizationEntityNames[1]={organizationEntityNames[1]}&organizationEntityAttributeNames[0]={organizationEntityAttributeNames[0]}&organizationEntityAttributeNames[1]={organizationEntityAttributeNames[1]}&organizationEntityAttributeStartDate={organizationEntityAttributeStartDate}&organizationEntityAttributeEndDate={organizationEntityAttributeEndDate}&clientExternalIds[0]={clientExternalIds[0]}&clientExternalIds[1]={clientExternalIds[1]}&clientAttributeNames[0]={clientAttributeNames[0]}&clientAttributeNames[1]={clientAttributeNames[1]}&clientAttributeStartDate={clientAttributeStartDate}&clientAttributeEndDate={clientAttributeEndDate}

Gets ClientSubscriptions accessible for the logged in employee.

At least one of these modules is required: PC2Connect

Requires 'Read' permission for function PC2ConnectClientSubscriptions {AFFCBAB5-3125-406B-80AB-2762A875709D}

GET PlanCare2Api/Clients/ClientSummaries?RelationId={RelationId}&SocialSecurityNumber={SocialSecurityNumber}&LookupName={LookupName}&FirstName={FirstName}&NickName={NickName}&LastName={LastName}&Gender={Gender}&DateOfBirth={DateOfBirth}&YearOfBirth={YearOfBirth}&ClientId={ClientId}&MigrationIdentifier={MigrationIdentifier}&RegistrationNumber={RegistrationNumber}&SecretPlacement={SecretPlacement}&AllowAccessClientPortal={AllowAccessClientPortal}

Gets summaries of all clients accessible for the logged in employee.

POST PlanCare2Api/Clients/PersonalData

Update the personal data for a client

Requires 'Edit' permission for function ClientPersonalData {EF326A77-1072-4E56-A7CA-80542B697A05}

ContactPersons

Obtains contactperson information

At least one of these modules is required: RelationManagement

APIDescription
GET PlanCare2Api/ContactPersons?allowAccessClientPortal={allowAccessClientPortal}

Gets contactpersons

Requires 'Read' permission for function ContactPersonPersonalData {1D8FABC7-C901-48B5-A6B3-3D47FE33810D}

GET PlanCare2Api/ContactPersons/{relationId}

Gets a contactperson by relationId

Requires 'Read' permission for function ContactPersonPersonalData {1D8FABC7-C901-48B5-A6B3-3D47FE33810D}

GET PlanCare2Api/ContactPersons/{relationId}/PersonalData

Gets the personal data for a contactperson

Requires 'Read' permission for function ContactPersonPersonalData {1D8FABC7-C901-48B5-A6B3-3D47FE33810D}

POST PlanCare2Api/ContactPersons/PersonalData

Update the personal data for a contactperson

Requires 'Edit' permission for function ContactPersonPersonalData {1D8FABC7-C901-48B5-A6B3-3D47FE33810D}

Contracts

Obtains contract information

APIDescription
GET PlanCare2Api/Contracts?clientId={clientId}&referenceDate={referenceDate}

Fetches active contracts based on client identifier.

GET PlanCare2Api/Contracts?bsn={bsn}&referenceDate={referenceDate}

Fetches active contracts based on client identifier.

GET PlanCare2Api/Contracts/{contractId}/ContractLines?contractOfServiceId={contractOfServiceId}&referenceDate={referenceDate}

Fetches the contract lines valid for the contract and contract of service on the give date.

Deprecated, please use the PlanCare2Api/Contracts/{contractId}/Products?employmentId={employmentId}&referenceDate={referenceDate} endpoint

GET PlanCare2Api/Contracts/{contractId}/Products?employmentId={employmentId}&referenceDate={referenceDate}

Fetches the products for the contract valid at a certain point in time filtered by employment.

GET PlanCare2Api/Contracts/{contractId}/Products

Fetches all products of a contract.

GET PlanCare2Api/Contracts/ContractTypes

Fetches the available contract types. A contract type is only supported when licenses for the corresponding module are available.

CustomBuildingBlocks

BuildingBlocksController.

APIDescription
DELETE PlanCare2Api/CustomBuildingBlocks/Values/{customBuildingBlockValueId}

Delete CustomBuildingBlockValue.

GET PlanCare2Api/CustomBuildingBlocks

Gets list of CustomBuildingBlockSummary.

GET PlanCare2Api/CustomBuildingBlocks/{customBuildingBlockGuid}

Gets CustomBuildingBlock by guid.

GET PlanCare2Api/CustomBuildingBlocks/ActualValue?customBuildingBlockGuid={customBuildingBlockGuid}&relationId={relationId}

Gets actual value of a CustomBuildingBlock.

Relation(s) can be of the following types: Client, Employee

GET PlanCare2Api/CustomBuildingBlocks/Values?customBuildingBlockGuid={customBuildingBlockGuid}&relationId={relationId}

Gets list of values of a CustomBuildingBlock for a relation.

Relation(s) can be of the following types: Client, Employee

GET PlanCare2Api/CustomBuildingBlocks/Values/{customBuildingBlockValueId}

Gets value of a CustomBuildingBlock.

POST PlanCare2Api/CustomBuildingBlocks/Values

Insert CustomBuildingBlockValue.

POST PlanCare2Api/CustomBuildingBlocks/Values/Update

Update CustomBuildingBlockValue.

DaytimeActivities

Provides the ability to load daytime activity items.

At least one of these modules is required: DaytimeActivity

APIDescription
GET PlanCare2Api/DaytimeActivities/{id}/presences

Fetch the possible presences for a daytime activity meeting

Requires 'Start' permission for function DaytimeActivityOverview {16EDE7B1-4F4B-4C01-A7E4-79E73CF6B2E3}

GET PlanCare2Api/DaytimeActivities/Activities?dateFrom={dateFrom}&dateUntil={dateUntil}

Fetch all daytime activities in a specified period

Requires 'Start' permission for function DaytimeActivityOverview {16EDE7B1-4F4B-4C01-A7E4-79E73CF6B2E3}

Decubitus

Obtain and create Decubitus registration

At least one of these modules is required: CareRegistration

APIDescription
DELETE PlanCare2Api/CareRegistration/Decubitus/{id}

Deletes a decubitus instance

Requires 'Start' permission for function DecubitusOverview {E166DD93-F82A-4F85-A598-A22ABE279FFF}

GET PlanCare2Api/CareRegistration/Decubitus?clientId={clientId}&from={from}&maxRecordCount={maxRecordCount}

Gets the decubitus registrations of the specified client

Requires 'Start' permission for function DecubitusOverview {E166DD93-F82A-4F85-A598-A22ABE279FFF}

GET PlanCare2Api/CareRegistration/Decubitus?bsn={bsn}&from={from}&maxRecordCount={maxRecordCount}

Gets the decubitus registrations of the specified client

Requires 'Start' permission for function DecubitusOverview {E166DD93-F82A-4F85-A598-A22ABE279FFF}

POST PlanCare2Api/CareRegistration/Decubitus

Saves a new decubitus registration

Requires 'Start' permission for function DecubitusOverview {E166DD93-F82A-4F85-A598-A22ABE279FFF}

POST PlanCare2Api/CareRegistration/Decubitus/ChangeOfDecubitus

Updates a decubitus registration

Requires 'Start' permission for function DecubitusOverview {E166DD93-F82A-4F85-A598-A22ABE279FFF}

Defecations

Obtain and create defecation registration

Deprecated, please use the 'MedicalDefecation' api

At least one of these modules is required: CareRegistration

APIDescription
DELETE PlanCare2Api/CareRegistration/Defecations/{id}

Deletes a defecation instance

Requires 'Delete' permission for function MedicalDefecation {A10B7F92-BB2F-4650-945C-C180C5C7B3BC}

GET PlanCare2Api/CareRegistration/Defecations?clientId={clientId}&from={from}&maxRecordCount={maxRecordCount}

Gets the defecation registrations of the specified client

Requires 'Read' permission for function MedicalDefecation {A10B7F92-BB2F-4650-945C-C180C5C7B3BC}

GET PlanCare2Api/CareRegistration/Defecations?bsn={bsn}&from={from}&maxRecordCount={maxRecordCount}

Gets the defecation registrations of the specified client

Requires 'Read' permission for function MedicalDefecation {A10B7F92-BB2F-4650-945C-C180C5C7B3BC}

POST PlanCare2Api/CareRegistration/Defecations

Saves a new defecation instance

Requires 'Insert' permission for function MedicalDefecation {A10B7F92-BB2F-4650-945C-C180C5C7B3BC}

POST PlanCare2Api/CareRegistration/Defecations/ChangeOfDefecations

Stores a defecation instance

Requires 'Edit' permission for function MedicalDefecation {A10B7F92-BB2F-4650-945C-C180C5C7B3BC}

DisciplineGroups

Provides the ability to get discipline groups and its members

At least one of these modules is required: Base

APIDescription
GET PlanCare2Api/DisciplineGroups/{disciplineGroupId}/Members

Get discipline group members by id.

Disciplines

Provides the ability to get disciplines and its members

At least one of these modules is required: Base

APIDescription
GET PlanCare2Api/Disciplines/{disciplineId}/Members

Get discipline members by id.

Documents

Provides the ability to load and store documentfiles

At least one of these modules is required: Document

APIDescription
DELETE PlanCare2Api/Documents/ClientDocuments/{documentId}?clientId={clientId}&categoryId={categoryId}

Mark ClientDocument as deleted.

Requires 'Start' permission for function Documents {1EF42D55-A0FE-49F0-91C3-CD03DD18D244}

DELETE PlanCare2Api/Documents/MyDepartments/{documentId}

Mark MyDepartments document as deleted.

Requires 'Start' permission for function Documents {1EF42D55-A0FE-49F0-91C3-CD03DD18D244}

DELETE PlanCare2Api/Documents/MyDocuments/{documentId}

Mark my document as deleted.

Requires 'Start' permission for function Documents {1EF42D55-A0FE-49F0-91C3-CD03DD18D244}

GET PlanCare2Api/Documents/ClientDocuments/Categories

Get all ClientDocument categories.

Requires 'Start' permission for function Documents {1EF42D55-A0FE-49F0-91C3-CD03DD18D244}

GET PlanCare2Api/Documents/ClientDocuments/Content?documentId={documentId}

Get the content of a ClientDocument.

Requires 'Start' permission for function Documents {1EF42D55-A0FE-49F0-91C3-CD03DD18D244}

GET PlanCare2Api/Documents/ClientDocuments/Content?clientId={clientId}&categoryId={categoryId}&documentId={documentId}

Get the content of a ClientDocument.

Requires 'Start' permission for function Documents {1EF42D55-A0FE-49F0-91C3-CD03DD18D244}

GET PlanCare2Api/Documents/ClientDocuments/Metadata?clientId={clientId}&categoryId={categoryId}

Returns a list of available ClientDocuments of the client in the given category.

Requires 'Start' permission for function Documents {1EF42D55-A0FE-49F0-91C3-CD03DD18D244}

GET PlanCare2Api/Documents/DocumentCategoryPermissions

Get all document category permissions

Requires 'Start' permission for function BackOfficeOverview {FA1038EC-0FED-49E9-9376-D5DCE92D694E}

GET PlanCare2Api/Documents/MyDepartments/Categories

Get all MyDepartments document categories.

Requires 'Start' permission for function Documents {1EF42D55-A0FE-49F0-91C3-CD03DD18D244}

GET PlanCare2Api/Documents/MyDepartments/Content?documentId={documentId}

Get the content of a MyDepartments document.

Requires 'Start' permission for function Documents {1EF42D55-A0FE-49F0-91C3-CD03DD18D244}

GET PlanCare2Api/Documents/MyDepartments/Metadata?categoryId={categoryId}&organizationEntityId={organizationEntityId}

Returns a list of MyDepartment documents of the employee in the given category.

Requires 'Start' permission for function Documents {1EF42D55-A0FE-49F0-91C3-CD03DD18D244}

GET PlanCare2Api/Documents/MyDocuments/Categories

Get all my MyDocument document categories.

Requires 'Start' permission for function Documents {1EF42D55-A0FE-49F0-91C3-CD03DD18D244}

GET PlanCare2Api/Documents/MyDocuments/Content?documentId={documentId}

Get the content of a MyDocument document.

Requires 'Start' permission for function Documents {1EF42D55-A0FE-49F0-91C3-CD03DD18D244}

GET PlanCare2Api/Documents/MyDocuments/Metadata?categoryId={categoryId}

Returns a list of MyDocument documents of the employee in the given category.

Requires 'Start' permission for function Documents {1EF42D55-A0FE-49F0-91C3-CD03DD18D244}

POST PlanCare2Api/Documents/ClientDocuments

Store a ClientDocument

Requires 'Start' permission for function Documents {1EF42D55-A0FE-49F0-91C3-CD03DD18D244}

POST PlanCare2Api/Documents/ClientDocuments/ChangeOfClientDocuments

Update a ClientDocument.

Requires 'Start' permission for function Documents {1EF42D55-A0FE-49F0-91C3-CD03DD18D244}

POST PlanCare2Api/Documents/MyDepartments

Store a MyDepartments document.

Requires 'Start' permission for function Documents {1EF42D55-A0FE-49F0-91C3-CD03DD18D244}

POST PlanCare2Api/Documents/MyDepartments/ChangeOfMyDepartmentsDocuments

Update a MyDepartments document.

Requires 'Start' permission for function Documents {1EF42D55-A0FE-49F0-91C3-CD03DD18D244}

POST PlanCare2Api/Documents/MyDocuments

Store a MyDocument.

Requires 'Start' permission for function Documents {1EF42D55-A0FE-49F0-91C3-CD03DD18D244}

POST PlanCare2Api/Documents/MyDocuments/ChangeOfMyDocuments

Update a MyDocument.

Requires 'Start' permission for function Documents {1EF42D55-A0FE-49F0-91C3-CD03DD18D244}

DynamicData

Fetch/insert/update dynamic data

APIDescription
GET PlanCare2Api/DynamicData/AgreementProductDescription?clientID={clientID}&referenceDate={referenceDate}

Fetch products based on the product information on the agreement. This function does apply to the PCD contracttype

GET PlanCare2Api/DynamicData/AgreementProducts?supplierCode={supplierCode}&referenceDate={referenceDate}

Fetch available products and debtors for the given supplier based on the product information on the agreement.

GET PlanCare2Api/DynamicData/ApplicationCustomLabel

Gets the custom label for application components

GET PlanCare2Api/DynamicData/AppointmentProtocols?appointmentlist={appointmentlist}

Gets protocols by a list of unique appointment identifiers

GET PlanCare2Api/DynamicData/Arrangement?clientlist={clientlist}

Gets arrangements by a list of unique client identifiers

GET PlanCare2Api/DynamicData/ChainMessageById?agb={agb}&id={id}&externalId={externalId}&externalInfo={externalInfo}

Gets a chainmessage based on the given parameters. Sets the given chainmessage as status = exported

GET PlanCare2Api/DynamicData/ChainMessagesReadyForExport?agb={agb}

Gets a list of chainmessages ready for export

GET PlanCare2Api/DynamicData/ClientDetailsList?clientlist={clientlist}

Gets clients by a list of unique identifiers

GET PlanCare2Api/DynamicData/ClientPermissionsDetail?employeeID={employeeID}&dateFrom={dateFrom}&dateUntil={dateUntil}

Gets allowed clients for all or a given employee within a given period

GET PlanCare2Api/DynamicData/ClientProtocols?clientlist={clientlist}

Gets relevant common and client protocols by a list of unique client identifiers

GET PlanCare2Api/DynamicData/DOTLocations?contractList={contractList}

Fetch possible locations for a list of DBC GRZ contracts

GET PlanCare2Api/DynamicData/Employees?referenceDate={referenceDate}

Gets detail info of all employees active on referenceDate with a valid Contract of Service on referenceDate. Used by the PlanCare HRM Connector/Flex autorization module

GET PlanCare2Api/DynamicData/OEStructure?parentOrganizationEntityId={parentOrganizationEntityId}

Retreives the organization structure beneath a specific organization entity id

GET PlanCare2Api/DynamicData/ProjectsPCDProductDescription?projectId={projectId}&productId={productId}&contractId={contractId}&referenceDate={referenceDate}

Fetch productdescription based on the Project/product information in PCD. This function does apply to the PCD contracttype

GET PlanCare2Api/DynamicData/Protocols

Gets protocols

GET PlanCare2Api/DynamicData/WorkTypes

The list of worktypes valid by contracttype id and product id.

GET PlanCare2Api/DynamicData/ZorgLegitimaties?clientList={clientList}&startDate={startDate}&endDate={endDate}&type={type}

Gets the care legitimations for the given clients. This endpoint is obsolete and will be deleted in a future version of the API.

GET PlanCare2Api/DynamicData/ZorgLegitimatiesV2?clientList={clientList}&startDate={startDate}&endDate={endDate}&type={type}

Gets the care legitimations like WLZ, WMO, JW for the given clients.

POST PlanCare2Api/DynamicData/InsertWorkflowAutorizations

Insert or update an autorization record used by the PlanCare HRM Connector

POST PlanCare2Api/DynamicData/UploadChainMessage

Uploads a chainmessage

EmployeeAppointments

Obtain Employee Appointments

At least one of these modules is required: EmployeeCalendar

APIDescription
DELETE PlanCare2Api/EmployeeAppointments/{appointmentId}

Deletes an EmployeeAppointment instance

Requires 'Start' permission for function EmployeeCalendar {2B7BC787-80B4-41AD-8975-FD07F3CC1746}

DELETE PlanCare2Api/EmployeeAppointments/{appointmentId}/OccurrenceIndex/{occurrenceIndex}

Deletes an EmployeeAppointment occurrence

Requires 'Start' permission for function EmployeeCalendar {2B7BC787-80B4-41AD-8975-FD07F3CC1746}

GET PlanCare2Api/EmployeeAppointments?employeeId={employeeId}&dateFrom={dateFrom}&dateUntil={dateUntil}&includeDeletedOccurrences={includeDeletedOccurrences}&excludeCalculatedOccurrences={excludeCalculatedOccurrences}

Obtains all appointments for the specified employee

Requires 'Start' permission for function EmployeeCalendar {2B7BC787-80B4-41AD-8975-FD07F3CC1746}

GET PlanCare2Api/EmployeeAppointments/{appointmentId}?occurrenceRangeFrom={occurrenceRangeFrom}&occurrenceRangeUntil={occurrenceRangeUntil}

Obtains the specified employee calendar appointment

Requires 'Start' permission for function EmployeeCalendar {2B7BC787-80B4-41AD-8975-FD07F3CC1746}

GET PlanCare2Api/EmployeeAppointments/OccurrenceAppointments/{appointmentId}

Obtains the occurrence appointment

Requires 'Start' permission for function EmployeeCalendar {2B7BC787-80B4-41AD-8975-FD07F3CC1746}

POST PlanCare2Api/EmployeeAppointments/ChangeOfEmployeeAppointments

Updates an existing EmployeeAppointment instance

Requires 'Start' permission for function EmployeeCalendar {2B7BC787-80B4-41AD-8975-FD07F3CC1746}

POST PlanCare2Api/EmployeeAppointments/ChangeOfOccurrenceAppointments

Saves a new OccurrenceAppointment instance. This appointment is part of a recurring Appointment

Requires 'Start' permission for function EmployeeCalendar {2B7BC787-80B4-41AD-8975-FD07F3CC1746}

POST PlanCare2Api/EmployeeAppointments/ChangeOfTimeRegistrationAppointments

Updates an existing ContractAppointment instance

Requires 'Start' permission for function EmployeeCalendar {2B7BC787-80B4-41AD-8975-FD07F3CC1746}

POST PlanCare2Api/EmployeeAppointments/EmployeeAppointments

Saves a new EmployeeAppointment instance

Requires 'Start' permission for function EmployeeCalendar {2B7BC787-80B4-41AD-8975-FD07F3CC1746}

POST PlanCare2Api/EmployeeAppointments/OccurrenceAppointments

Saves a new OccurrenceAppointment instance. This appointment is part of a recurring Appointment

Requires 'Start' permission for function EmployeeCalendar {2B7BC787-80B4-41AD-8975-FD07F3CC1746}

POST PlanCare2Api/EmployeeAppointments/TimeRegistrationAppointments

Saves a new TimeRegistrationAppointment instance

Requires 'Start' permission for function EmployeeCalendar {2B7BC787-80B4-41AD-8975-FD07F3CC1746}

Employees

Obtain employee information

At least one of these modules is required: Base

APIDescription
GET PlanCare2Api/Employees?relationId={relationId}

Gets detail info of an employee

Requires 'Start' permission for function BackOfficeOverview {FA1038EC-0FED-49E9-9376-D5DCE92D694E}

GET PlanCare2Api/Employees?referenceDate={referenceDate}&isLocked={isLocked}&allowAccessEmployeePortal={allowAccessEmployeePortal}

Gets detail info of all employees active on referenceDate with a valid Contract of Service on referenceDate

Requires 'Start' permission for function BackOfficeOverview {FA1038EC-0FED-49E9-9376-D5DCE92D694E}

GET PlanCare2Api/Employees/{employeeId}/Disciplines

Gets the disciplines for the specified employeeId

GET PlanCare2Api/Employees/{employeeId}/Employments?referenceDate={referenceDate}

Gets the employments for the specified employee

GET PlanCare2Api/Employees/Authorizations/Calendar

Gets the calendar authorizations of the logged on employee

GET PlanCare2Api/Employees/Cases?employeeIds[0]={employeeIds[0]}&employeeIds[1]={employeeIds[1]}

Gets the cases in the caseload of the requested employees

GET PlanCare2Api/Employees/Current

Gets detail info of the logged on employee

GET PlanCare2Api/Employees/Current/Cases

Gets the cases in the caseload of the logged on employee

GET PlanCare2Api/Employees/Current/Employments?referenceDate={referenceDate}

Gets the employments for the logged on employee

GET PlanCare2Api/Employees/Disciplines

Gets all discipline Ids of all employees

GET PlanCare2Api/Employees/Employments?referenceDate={referenceDate}

Gets the employments for all employees

Requires 'Start' permission for function BackOfficeOverview {FA1038EC-0FED-49E9-9376-D5DCE92D694E}

POST PlanCare2Api/Employees/ChangeOfCaseload

Change the caseload of the current logged on employee

EvsClientInformation

Provides client information for EVS

At least one of these modules is required: Medimo

APIDescription
GET PlanCare2Api/EvsClientInformation?clientId={clientId}

Retrieves client details for Evs Clientinformation

EvsMedication

Provides medication information for EVS

At least one of these modules is required: FarMedRx

APIDescription
GET PlanCare2Api/EvsMedication/FarMedRxClientMedication?clientId={clientId}&type={type}

Retrieves Farmed Client Medication information When parsing the FarMed XML failed a HttpStatusCode.UnprocessableEntity (422) will be returned

GET PlanCare2Api/EvsMedication/FarMedRxPrescription?clientId={clientId}&type={type}

Retrieves Farmed Client prescription information When parsing the information from FarMed fails a HttpStatusCode.UnprocessableEntity (422) will be returned

ExternalConnectionData

Obtain external context information.

At least one of these modules is required: Medimo

APIDescription
GET PlanCare2Api/ExternalConnectionData/{connectionId}

Retrieve context for an external connection. Usage of this call is exclusively restricted to certain partners. The guid of the connection for which to retrieve data.

Requires 'Start' permission for function MedimoBrowser {26694347-54AE-4D92-8108-D5CDC7F0A796}

FluidBalances

Obtain and create fluid balances

Deprecated, please use the 'MedicalFluidBalance' api

At least one of these modules is required: CareRegistration

APIDescription
DELETE PlanCare2Api/CareRegistration/FluidBalances/{id}

Deletes a fluid balance instance

Requires 'Edit' permission for function MedicalFluidBalance {7F194FEF-9ECA-4786-ABAE-690C62A0E4B8}

GET PlanCare2Api/CareRegistration/FluidBalances?clientId={clientId}&from={from}&maxRecordCount={maxRecordCount}

Gets the fluid balance of the specified client.

Requires 'Read' permission for function MedicalFluidBalance {7F194FEF-9ECA-4786-ABAE-690C62A0E4B8}

GET PlanCare2Api/CareRegistration/FluidBalances?bsn={bsn}&from={from}&maxRecordCount={maxRecordCount}

Gets the fluid balance of the specified client.

Requires 'Read' permission for function MedicalFluidBalance {7F194FEF-9ECA-4786-ABAE-690C62A0E4B8}

POST PlanCare2Api/CareRegistration/FluidBalances

Saves a new fluid balance instance

Requires 'Edit' permission for function MedicalFluidBalance {7F194FEF-9ECA-4786-ABAE-690C62A0E4B8}

POST PlanCare2Api/CareRegistration/FluidBalances/ChangeOfFluidBalances

Updates an existing fluid balance instance

Requires 'Edit' permission for function MedicalFluidBalance {7F194FEF-9ECA-4786-ABAE-690C62A0E4B8}

Glycemias

Obtain and create diabetes measurements

At least one of these modules is required: CareRegistration

APIDescription
DELETE PlanCare2Api/CareRegistration/Glycemias/{id}

Deletes an existing blood sugar level measurement

Requires 'Start' permission for function DiabetesOverview {E7B79013-1116-45D0-B5EB-B6F672FED60E}

GET PlanCare2Api/CareRegistration/Glycemias?clientId={clientId}&from={from}&maxRecordCount={maxRecordCount}

Gets the blood sugar level measurements of the specified client.

Requires 'Start' permission for function DiabetesOverview {E7B79013-1116-45D0-B5EB-B6F672FED60E}

GET PlanCare2Api/CareRegistration/Glycemias?bsn={bsn}&from={from}&maxRecordCount={maxRecordCount}

Gets the blood sugar level measurements of the specified client.

Requires 'Start' permission for function DiabetesOverview {E7B79013-1116-45D0-B5EB-B6F672FED60E}

POST PlanCare2Api/CareRegistration/Glycemias

Saves a new blood sugar level measurement

Requires 'Start' permission for function DiabetesOverview {E7B79013-1116-45D0-B5EB-B6F672FED60E}

POST PlanCare2Api/CareRegistration/Glycemias/ChangeOfGlycemias

Updates an existing blood sugar level measurement.

Requires 'Start' permission for function DiabetesOverview {E7B79013-1116-45D0-B5EB-B6F672FED60E}

Goals

Provides the ability to load clientplan goals.

At least one of these modules is required: ICP

APIDescription
GET PlanCare2Api/Goals?clientId={clientId}

Retrieve all goals for the selected client.

GET PlanCare2Api/Goals?careplanIds[0]={careplanIds[0]}&careplanIds[1]={careplanIds[1]}

Retrieve all goals for the selected careplans.

Intakes

Obtain Intakes

At least one of these modules is required: GRZ, PCD

APIDescription
GET PlanCare2Api/Intakes/IntakePeriods/Active?referenceDate={referenceDate}

Fetch active intake periods.

Deprecated: use PlanCare2Api/Intakes/IntakePeriods/ActiveV2 instead

GET PlanCare2Api/Intakes/IntakePeriods/Active?clientId={clientId}&referenceDate={referenceDate}

Fetch active intake periods by client.

Deprecated: use PlanCare2Api/Intakes/IntakePeriods/ActiveV2 instead

GET PlanCare2Api/Intakes/IntakePeriods/ActiveV2?referenceDate={referenceDate}

Returns a list of active intake periods or active contracts without an active period.

GET PlanCare2Api/Intakes/IntakePeriods/ActiveV2?clientId={clientId}&referenceDate={referenceDate}

Returns a list of active intake periods or active contracts without an active period for a single client.

Interventions

Provides the ability to load Omaha System interventions.

At least one of these modules is required: ICP

APIDescription
GET PlanCare2Api/Interventions?clientId={clientId}

Retrieves a list of interventions that belong to clientplans of the client that have the status 'In progress'.

Login

Obtain information to able to login

At least one of these modules is required: Base

APIDescription
GET PlanCare2Api/Login/Employments

Gets all employments

Measurements

Obtain and create measurements

At least one of these modules is required: CareRegistration

APIDescription
DELETE PlanCare2Api/CareRegistration/Measurements/{id}

Deletes a measurement instance

Requires 'Start' permission for function MeasurementListOverview {8E343A66-EC60-422E-8840-CA101A45FB2B}

GET PlanCare2Api/CareRegistration/Measurements?clientId={clientId}&from={from}&maxRecordCount={maxRecordCount}

Gets the measurements of the specified client

Requires 'Start' permission for function MeasurementListOverview {8E343A66-EC60-422E-8840-CA101A45FB2B}

GET PlanCare2Api/CareRegistration/Measurements?bsn={bsn}&from={from}&maxRecordCount={maxRecordCount}

Gets the measurements of the specified client

Requires 'Start' permission for function MeasurementListOverview {8E343A66-EC60-422E-8840-CA101A45FB2B}

POST PlanCare2Api/CareRegistration/Measurements

Saves a new measurement instance

Requires 'Start' permission for function MeasurementListOverview {8E343A66-EC60-422E-8840-CA101A45FB2B}

POST PlanCare2Api/CareRegistration/Measurements/ChangeOfMeasurements

Saves a new change of measurement instance

Requires 'Start' permission for function MeasurementListOverview {8E343A66-EC60-422E-8840-CA101A45FB2B}

Measures

Obtain involuntarycare measures

At least one of these modules is required: ICP

APIDescription
GET PlanCare2Api/Measures?clientId={clientId}&referenceDate={referenceDate}

Retrieve all involuntarycare measures for the selected client that overlap with the given date.

MedicalAllergyIntolerance

MedicalAllergyIntoleranceController.

APIDescription
DELETE PlanCare2Api/MedicalAllergyIntolerance/{id}

Delete MedicalAllergyIntolerance.

Requires 'Delete' permission for function MedicalAllergyIntolerance {69731383-9F0D-48C6-81D1-F8456D0A2E91}

GET PlanCare2Api/MedicalAllergyIntolerance?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalAllergyIntoleranceSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalAllergyIntolerance {69731383-9F0D-48C6-81D1-F8456D0A2E91}

GET PlanCare2Api/MedicalAllergyIntolerance/{id}

Gets MedicalAllergyIntolerance by id.

Requires 'Read' permission for function MedicalAllergyIntolerance {69731383-9F0D-48C6-81D1-F8456D0A2E91}

GET PlanCare2Api/MedicalAllergyIntolerance/ActualValue?relationId={relationId}

Gets the actual MedicalAllergyIntoleranceSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalAllergyIntolerance {69731383-9F0D-48C6-81D1-F8456D0A2E91}

GET PlanCare2Api/MedicalAllergyIntolerance/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalAllergyIntoleranceSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalAllergyIntolerance {69731383-9F0D-48C6-81D1-F8456D0A2E91}

POST PlanCare2Api/MedicalAllergyIntolerance

Insert MedicalAllergyIntolerance.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalAllergyIntolerance {69731383-9F0D-48C6-81D1-F8456D0A2E91}

POST PlanCare2Api/MedicalAllergyIntolerance/Update

Update MedicalAllergyIntolerance.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalAllergyIntolerance {69731383-9F0D-48C6-81D1-F8456D0A2E91}

MedicalBarthelIndex

MedicalBarthelIndexController.

APIDescription
DELETE PlanCare2Api/MedicalBarthelIndex/{id}

Delete MedicalBarthelIndex.

Requires 'Delete' permission for function MedicalBarthelIndex {77800AE9-2567-4931-AC77-ED41328172F9}

GET PlanCare2Api/MedicalBarthelIndex?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalBarthelIndexSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalBarthelIndex {77800AE9-2567-4931-AC77-ED41328172F9}

GET PlanCare2Api/MedicalBarthelIndex/{id}

Gets MedicalBarthelIndex by id.

Requires 'Read' permission for function MedicalBarthelIndex {77800AE9-2567-4931-AC77-ED41328172F9}

GET PlanCare2Api/MedicalBarthelIndex/ActualValue?relationId={relationId}

Gets the actual MedicalBarthelIndexSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalBarthelIndex {77800AE9-2567-4931-AC77-ED41328172F9}

GET PlanCare2Api/MedicalBarthelIndex/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalBarthelIndexSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalBarthelIndex {77800AE9-2567-4931-AC77-ED41328172F9}

POST PlanCare2Api/MedicalBarthelIndex

Insert MedicalBarthelIndex.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalBarthelIndex {77800AE9-2567-4931-AC77-ED41328172F9}

POST PlanCare2Api/MedicalBarthelIndex/Update

Update MedicalBarthelIndex.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalBarthelIndex {77800AE9-2567-4931-AC77-ED41328172F9}

MedicalBloodPressure

MedicalBloodPressureController.

APIDescription
DELETE PlanCare2Api/MedicalBloodPressure/{id}

Delete MedicalBloodPressure.

Requires 'Delete' permission for function MedicalBloodPressure {4D31A282-1816-486C-8525-3F9D14BB6445}

GET PlanCare2Api/MedicalBloodPressure?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalBloodPressureSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalBloodPressure {4D31A282-1816-486C-8525-3F9D14BB6445}

GET PlanCare2Api/MedicalBloodPressure/{id}

Gets MedicalBloodPressure by id.

Requires 'Read' permission for function MedicalBloodPressure {4D31A282-1816-486C-8525-3F9D14BB6445}

GET PlanCare2Api/MedicalBloodPressure/ActualValue?relationId={relationId}

Gets the actual MedicalBloodPressureSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalBloodPressure {4D31A282-1816-486C-8525-3F9D14BB6445}

GET PlanCare2Api/MedicalBloodPressure/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalBloodPressureSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalBloodPressure {4D31A282-1816-486C-8525-3F9D14BB6445}

POST PlanCare2Api/MedicalBloodPressure

Insert MedicalBloodPressure.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalBloodPressure {4D31A282-1816-486C-8525-3F9D14BB6445}

POST PlanCare2Api/MedicalBloodPressure/Update

Update MedicalBloodPressure.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalBloodPressure {4D31A282-1816-486C-8525-3F9D14BB6445}

MedicalBreathingFrequency

MedicalBreathingFrequencyController.

APIDescription
DELETE PlanCare2Api/MedicalBreathingFrequency/{id}

Delete MedicalBreathingFrequency.

Requires 'Delete' permission for function MedicalBreathingFrequency {C9F2AC01-1083-4808-AE13-1545534A4A27}

GET PlanCare2Api/MedicalBreathingFrequency?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalBreathingFrequencySummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalBreathingFrequency {C9F2AC01-1083-4808-AE13-1545534A4A27}

GET PlanCare2Api/MedicalBreathingFrequency/{id}

Gets MedicalBreathingFrequency by id.

Requires 'Read' permission for function MedicalBreathingFrequency {C9F2AC01-1083-4808-AE13-1545534A4A27}

GET PlanCare2Api/MedicalBreathingFrequency/ActualValue?relationId={relationId}

Gets the actual MedicalBreathingFrequencySummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalBreathingFrequency {C9F2AC01-1083-4808-AE13-1545534A4A27}

GET PlanCare2Api/MedicalBreathingFrequency/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalBreathingFrequencySummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalBreathingFrequency {C9F2AC01-1083-4808-AE13-1545534A4A27}

POST PlanCare2Api/MedicalBreathingFrequency

Insert MedicalBreathingFrequency.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalBreathingFrequency {C9F2AC01-1083-4808-AE13-1545534A4A27}

POST PlanCare2Api/MedicalBreathingFrequency/Update

Update MedicalBreathingFrequency.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalBreathingFrequency {C9F2AC01-1083-4808-AE13-1545534A4A27}

MedicalCodeList

MedicalCodeListController.

APIDescription
GET PlanCare2Api/MedicalCodeList?medicalCodeListType={medicalCodeListType}

Gets list of MedicalCodeListItems of the specified MedicalCodeList.

MedicalDefecation

MedicalDefecationController.

APIDescription
DELETE PlanCare2Api/MedicalDefecation/{id}

Delete MedicalDefecation.

Requires 'Delete' permission for function MedicalDefecation {A10B7F92-BB2F-4650-945C-C180C5C7B3BC}

GET PlanCare2Api/MedicalDefecation?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalDefecationSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalDefecation {A10B7F92-BB2F-4650-945C-C180C5C7B3BC}

GET PlanCare2Api/MedicalDefecation/{id}

Gets MedicalDefecation by id.

Requires 'Read' permission for function MedicalDefecation {A10B7F92-BB2F-4650-945C-C180C5C7B3BC}

GET PlanCare2Api/MedicalDefecation/ActualValue?relationId={relationId}

Gets the actual MedicalDefecationSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalDefecation {A10B7F92-BB2F-4650-945C-C180C5C7B3BC}

GET PlanCare2Api/MedicalDefecation/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalDefecationSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalDefecation {A10B7F92-BB2F-4650-945C-C180C5C7B3BC}

POST PlanCare2Api/MedicalDefecation

Insert MedicalDefecation.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalDefecation {A10B7F92-BB2F-4650-945C-C180C5C7B3BC}

POST PlanCare2Api/MedicalDefecation/Update

Update MedicalDefecation.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalDefecation {A10B7F92-BB2F-4650-945C-C180C5C7B3BC}

MedicalDonorPolicy

MedicalDonorPolicyController.

APIDescription
DELETE PlanCare2Api/MedicalDonorPolicy/{id}

Delete MedicalDonorPolicy.

Requires 'Delete' permission for function MedicalDonorPolicy {64C8B2BC-1858-4821-BCEE-2707E7FE44EE}

GET PlanCare2Api/MedicalDonorPolicy?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalDonorPolicySummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalDonorPolicy {64C8B2BC-1858-4821-BCEE-2707E7FE44EE}

GET PlanCare2Api/MedicalDonorPolicy/{id}

Gets MedicalDonorPolicy by id.

Requires 'Read' permission for function MedicalDonorPolicy {64C8B2BC-1858-4821-BCEE-2707E7FE44EE}

GET PlanCare2Api/MedicalDonorPolicy/ActualValue?relationId={relationId}

Gets the actual MedicalDonorPolicySummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalDonorPolicy {64C8B2BC-1858-4821-BCEE-2707E7FE44EE}

GET PlanCare2Api/MedicalDonorPolicy/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalDonorPolicySummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalDonorPolicy {64C8B2BC-1858-4821-BCEE-2707E7FE44EE}

POST PlanCare2Api/MedicalDonorPolicy

Insert MedicalDonorPolicy.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalDonorPolicy {64C8B2BC-1858-4821-BCEE-2707E7FE44EE}

POST PlanCare2Api/MedicalDonorPolicy/Update

Update MedicalDonorPolicy.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalDonorPolicy {64C8B2BC-1858-4821-BCEE-2707E7FE44EE}

MedicalDsm5Registration

MedicalDsm5RegistrationController.

APIDescription
DELETE PlanCare2Api/MedicalDsm5Registration/{id}

Delete MedicalDsm5Registration.

Requires 'Delete' permission for function MedicalDsm5Registration {04ED5C7B-B19B-4D29-8CCE-470078E4F30C}

GET PlanCare2Api/MedicalDsm5Registration?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalDsm5RegistrationSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalDsm5Registration {04ED5C7B-B19B-4D29-8CCE-470078E4F30C}

GET PlanCare2Api/MedicalDsm5Registration/{id}

Gets MedicalDsm5Registration by id.

Requires 'Read' permission for function MedicalDsm5Registration {04ED5C7B-B19B-4D29-8CCE-470078E4F30C}

GET PlanCare2Api/MedicalDsm5Registration/ActualValue?relationId={relationId}

Gets the actual MedicalDsm5RegistrationSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalDsm5Registration {04ED5C7B-B19B-4D29-8CCE-470078E4F30C}

GET PlanCare2Api/MedicalDsm5Registration/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalDsm5RegistrationSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalDsm5Registration {04ED5C7B-B19B-4D29-8CCE-470078E4F30C}

GET PlanCare2Api/MedicalDsm5Registration/DiagnosisCodes?referenceDate={referenceDate}

Gets list of MedicalDsm5DiagnosisCode.

Requires 'Read' permission for function MedicalDsm5Registration {04ED5C7B-B19B-4D29-8CCE-470078E4F30C}

POST PlanCare2Api/MedicalDsm5Registration

Insert MedicalDsm5Registration.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalDsm5Registration {04ED5C7B-B19B-4D29-8CCE-470078E4F30C}

POST PlanCare2Api/MedicalDsm5Registration/Update

Update MedicalDsm5Registration.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalDsm5Registration {04ED5C7B-B19B-4D29-8CCE-470078E4F30C}

MedicalEpilepsy

MedicalEpilepsyController.

APIDescription
DELETE PlanCare2Api/MedicalEpilepsy/{id}

Delete MedicalEpilepsy.

Requires 'Delete' permission for function MedicalEpilepsy {E4BB8F45-B210-424C-8CF2-98B7F0ADCA42}

GET PlanCare2Api/MedicalEpilepsy?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalEpilepsySummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalEpilepsy {E4BB8F45-B210-424C-8CF2-98B7F0ADCA42}

GET PlanCare2Api/MedicalEpilepsy/{id}

Gets MedicalEpilepsy by id.

Requires 'Read' permission for function MedicalEpilepsy {E4BB8F45-B210-424C-8CF2-98B7F0ADCA42}

GET PlanCare2Api/MedicalEpilepsy/ActualValue?relationId={relationId}

Gets the actual MedicalEpilepsySummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalEpilepsy {E4BB8F45-B210-424C-8CF2-98B7F0ADCA42}

GET PlanCare2Api/MedicalEpilepsy/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalEpilepsySummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalEpilepsy {E4BB8F45-B210-424C-8CF2-98B7F0ADCA42}

POST PlanCare2Api/MedicalEpilepsy

Insert MedicalEpilepsy.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalEpilepsy {E4BB8F45-B210-424C-8CF2-98B7F0ADCA42}

POST PlanCare2Api/MedicalEpilepsy/Update

Update MedicalEpilepsy.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalEpilepsy {E4BB8F45-B210-424C-8CF2-98B7F0ADCA42}

MedicalEuthanasiaPolicy

MedicalEuthanasiaPolicyController.

APIDescription
DELETE PlanCare2Api/MedicalEuthanasiaPolicy/{id}

Delete MedicalEuthanasiaPolicy.

Requires 'Delete' permission for function MedicalEuthanasiaPolicy {73FF2474-38B8-441D-B20A-27C77F351338}

GET PlanCare2Api/MedicalEuthanasiaPolicy?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalEuthanasiaPolicySummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalEuthanasiaPolicy {73FF2474-38B8-441D-B20A-27C77F351338}

GET PlanCare2Api/MedicalEuthanasiaPolicy/{id}

Gets MedicalEuthanasiaPolicy by id.

Requires 'Read' permission for function MedicalEuthanasiaPolicy {73FF2474-38B8-441D-B20A-27C77F351338}

GET PlanCare2Api/MedicalEuthanasiaPolicy/ActualValue?relationId={relationId}

Gets the actual MedicalEuthanasiaPolicySummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalEuthanasiaPolicy {73FF2474-38B8-441D-B20A-27C77F351338}

GET PlanCare2Api/MedicalEuthanasiaPolicy/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalEuthanasiaPolicySummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalEuthanasiaPolicy {73FF2474-38B8-441D-B20A-27C77F351338}

POST PlanCare2Api/MedicalEuthanasiaPolicy

Insert MedicalEuthanasiaPolicy.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalEuthanasiaPolicy {73FF2474-38B8-441D-B20A-27C77F351338}

POST PlanCare2Api/MedicalEuthanasiaPolicy/Update

Update MedicalEuthanasiaPolicy.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalEuthanasiaPolicy {73FF2474-38B8-441D-B20A-27C77F351338}

MedicalFluidBalance

MedicalFluidBalanceController.

APIDescription
DELETE PlanCare2Api/MedicalFluidBalance/{id}

Delete MedicalFluidBalance.

Requires 'Delete' permission for function MedicalFluidBalance {7F194FEF-9ECA-4786-ABAE-690C62A0E4B8}

GET PlanCare2Api/MedicalFluidBalance?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalFluidBalanceSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalFluidBalance {7F194FEF-9ECA-4786-ABAE-690C62A0E4B8}

GET PlanCare2Api/MedicalFluidBalance/{id}

Gets MedicalFluidBalance by id.

Requires 'Read' permission for function MedicalFluidBalance {7F194FEF-9ECA-4786-ABAE-690C62A0E4B8}

GET PlanCare2Api/MedicalFluidBalance/ActualValue?relationId={relationId}

Gets the actual MedicalFluidBalanceSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalFluidBalance {7F194FEF-9ECA-4786-ABAE-690C62A0E4B8}

GET PlanCare2Api/MedicalFluidBalance/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalFluidBalanceSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalFluidBalance {7F194FEF-9ECA-4786-ABAE-690C62A0E4B8}

POST PlanCare2Api/MedicalFluidBalance

Insert MedicalFluidBalance.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalFluidBalance {7F194FEF-9ECA-4786-ABAE-690C62A0E4B8}

POST PlanCare2Api/MedicalFluidBalance/Update

Update MedicalFluidBalance.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalFluidBalance {7F194FEF-9ECA-4786-ABAE-690C62A0E4B8}

MedicalHeartrate

MedicalHeartrateController.

APIDescription
DELETE PlanCare2Api/MedicalHeartrate/{id}

Delete MedicalHeartrate.

Requires 'Delete' permission for function MedicalHeartrate {286E9B8E-458A-43C9-9F10-BE93EC5E923A}

GET PlanCare2Api/MedicalHeartrate?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalHeartrateSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalHeartrate {286E9B8E-458A-43C9-9F10-BE93EC5E923A}

GET PlanCare2Api/MedicalHeartrate/{id}

Gets MedicalHeartrate by id.

Requires 'Read' permission for function MedicalHeartrate {286E9B8E-458A-43C9-9F10-BE93EC5E923A}

GET PlanCare2Api/MedicalHeartrate/ActualValue?relationId={relationId}

Gets the actual MedicalHeartrateSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalHeartrate {286E9B8E-458A-43C9-9F10-BE93EC5E923A}

GET PlanCare2Api/MedicalHeartrate/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalHeartrateSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalHeartrate {286E9B8E-458A-43C9-9F10-BE93EC5E923A}

POST PlanCare2Api/MedicalHeartrate

Insert MedicalHeartrate.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalHeartrate {286E9B8E-458A-43C9-9F10-BE93EC5E923A}

POST PlanCare2Api/MedicalHeartrate/Update

Update MedicalHeartrate.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalHeartrate {286E9B8E-458A-43C9-9F10-BE93EC5E923A}

MedicalIntoxicationAlcohol

MedicalIntoxicationAlcoholController.

APIDescription
DELETE PlanCare2Api/MedicalIntoxicationAlcohol/{id}

Delete MedicalIntoxicationAlcohol.

Requires 'Delete' permission for function MedicalIntoxicationAlcohol {FD20A14E-E3BC-4B51-B067-4B9165923D3B}

GET PlanCare2Api/MedicalIntoxicationAlcohol?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalIntoxicationAlcoholSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalIntoxicationAlcohol {FD20A14E-E3BC-4B51-B067-4B9165923D3B}

GET PlanCare2Api/MedicalIntoxicationAlcohol/{id}

Gets MedicalIntoxicationAlcohol by id.

Requires 'Read' permission for function MedicalIntoxicationAlcohol {FD20A14E-E3BC-4B51-B067-4B9165923D3B}

GET PlanCare2Api/MedicalIntoxicationAlcohol/ActualValue?relationId={relationId}

Gets the actual MedicalIntoxicationAlcoholSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalIntoxicationAlcohol {FD20A14E-E3BC-4B51-B067-4B9165923D3B}

GET PlanCare2Api/MedicalIntoxicationAlcohol/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalIntoxicationAlcoholSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalIntoxicationAlcohol {FD20A14E-E3BC-4B51-B067-4B9165923D3B}

POST PlanCare2Api/MedicalIntoxicationAlcohol

Insert MedicalIntoxicationAlcohol.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalIntoxicationAlcohol {FD20A14E-E3BC-4B51-B067-4B9165923D3B}

POST PlanCare2Api/MedicalIntoxicationAlcohol/Update

Update MedicalIntoxicationAlcohol.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalIntoxicationAlcohol {FD20A14E-E3BC-4B51-B067-4B9165923D3B}

MedicalIntoxicationTobacco

MedicalIntoxicationTobaccoController.

APIDescription
DELETE PlanCare2Api/MedicalIntoxicationTobacco/{id}

Delete MedicalIntoxicationTobacco.

Requires 'Delete' permission for function MedicalIntoxicationTobacco {579E3587-91BB-44F9-AD7D-BABC85B1E17D}

GET PlanCare2Api/MedicalIntoxicationTobacco?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalIntoxicationTobaccoSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalIntoxicationTobacco {579E3587-91BB-44F9-AD7D-BABC85B1E17D}

GET PlanCare2Api/MedicalIntoxicationTobacco/{id}

Gets MedicalIntoxicationTobacco by id.

Requires 'Read' permission for function MedicalIntoxicationTobacco {579E3587-91BB-44F9-AD7D-BABC85B1E17D}

GET PlanCare2Api/MedicalIntoxicationTobacco/ActualValue?relationId={relationId}

Gets the actual MedicalIntoxicationTobaccoSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalIntoxicationTobacco {579E3587-91BB-44F9-AD7D-BABC85B1E17D}

GET PlanCare2Api/MedicalIntoxicationTobacco/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalIntoxicationTobaccoSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalIntoxicationTobacco {579E3587-91BB-44F9-AD7D-BABC85B1E17D}

POST PlanCare2Api/MedicalIntoxicationTobacco

Insert MedicalIntoxicationTobacco.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalIntoxicationTobacco {579E3587-91BB-44F9-AD7D-BABC85B1E17D}

POST PlanCare2Api/MedicalIntoxicationTobacco/Update

Update MedicalIntoxicationTobacco.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalIntoxicationTobacco {579E3587-91BB-44F9-AD7D-BABC85B1E17D}

MedicalLength

MedicalLengthController.

APIDescription
DELETE PlanCare2Api/MedicalLength/{id}

Delete MedicalLength.

Requires 'Delete' permission for function MedicalLength {46A09813-4D42-414C-9637-79EB1F00A87B}

GET PlanCare2Api/MedicalLength?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalLengthSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalLength {46A09813-4D42-414C-9637-79EB1F00A87B}

GET PlanCare2Api/MedicalLength/{id}

Gets MedicalLength by id.

Requires 'Read' permission for function MedicalLength {46A09813-4D42-414C-9637-79EB1F00A87B}

GET PlanCare2Api/MedicalLength/ActualValue?relationId={relationId}

Gets the actual MedicalLengthSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalLength {46A09813-4D42-414C-9637-79EB1F00A87B}

GET PlanCare2Api/MedicalLength/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalLengthSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalLength {46A09813-4D42-414C-9637-79EB1F00A87B}

POST PlanCare2Api/MedicalLength

Insert MedicalLength.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalLength {46A09813-4D42-414C-9637-79EB1F00A87B}

POST PlanCare2Api/MedicalLength/Update

Update MedicalLength.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalLength {46A09813-4D42-414C-9637-79EB1F00A87B}

MedicalLivingWillPolicy

MedicalLivingWillPolicyController.

APIDescription
DELETE PlanCare2Api/MedicalLivingWillPolicy/{id}

Delete MedicalLivingWillPolicy.

Requires 'Delete' permission for function MedicalLivingWillPolicy {2CC5682E-9A1F-4324-B6B6-62E537A55C93}

GET PlanCare2Api/MedicalLivingWillPolicy?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalLivingWillPolicySummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalLivingWillPolicy {2CC5682E-9A1F-4324-B6B6-62E537A55C93}

GET PlanCare2Api/MedicalLivingWillPolicy/{id}

Gets MedicalLivingWillPolicy by id.

Requires 'Read' permission for function MedicalLivingWillPolicy {2CC5682E-9A1F-4324-B6B6-62E537A55C93}

GET PlanCare2Api/MedicalLivingWillPolicy/ActualValue?relationId={relationId}

Gets the actual MedicalLivingWillPolicySummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalLivingWillPolicy {2CC5682E-9A1F-4324-B6B6-62E537A55C93}

GET PlanCare2Api/MedicalLivingWillPolicy/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalLivingWillPolicySummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalLivingWillPolicy {2CC5682E-9A1F-4324-B6B6-62E537A55C93}

POST PlanCare2Api/MedicalLivingWillPolicy

Insert MedicalLivingWillPolicy.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalLivingWillPolicy {2CC5682E-9A1F-4324-B6B6-62E537A55C93}

POST PlanCare2Api/MedicalLivingWillPolicy/Update

Update MedicalLivingWillPolicy.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalLivingWillPolicy {2CC5682E-9A1F-4324-B6B6-62E537A55C93}

MedicalMenstruation

MedicalMenstruationController.

APIDescription
DELETE PlanCare2Api/MedicalMenstruation/{id}

Delete MedicalMenstruation.

Requires 'Delete' permission for function MedicalMenstruation {CBFB685F-5829-4F51-AE15-1CDEA5780052}

GET PlanCare2Api/MedicalMenstruation?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalMenstruationSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalMenstruation {CBFB685F-5829-4F51-AE15-1CDEA5780052}

GET PlanCare2Api/MedicalMenstruation/{id}

Gets MedicalMenstruation by id.

Requires 'Read' permission for function MedicalMenstruation {CBFB685F-5829-4F51-AE15-1CDEA5780052}

GET PlanCare2Api/MedicalMenstruation/ActualValue?relationId={relationId}

Gets the actual MedicalMenstruationSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalMenstruation {CBFB685F-5829-4F51-AE15-1CDEA5780052}

GET PlanCare2Api/MedicalMenstruation/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalMenstruationSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalMenstruation {CBFB685F-5829-4F51-AE15-1CDEA5780052}

POST PlanCare2Api/MedicalMenstruation

Insert MedicalMenstruation.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalMenstruation {CBFB685F-5829-4F51-AE15-1CDEA5780052}

POST PlanCare2Api/MedicalMenstruation/Update

Update MedicalMenstruation.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalMenstruation {CBFB685F-5829-4F51-AE15-1CDEA5780052}

MedicalMentalCompetence

MedicalMentalCompetenceController.

APIDescription
DELETE PlanCare2Api/MedicalMentalCompetence/{id}

Delete MedicalMentalCompetence.

Requires 'Delete' permission for function MedicalMentalCompetence {75049A4D-E21B-41EF-AA91-673274F40EC0}

GET PlanCare2Api/MedicalMentalCompetence?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalMentalCompetenceSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalMentalCompetence {75049A4D-E21B-41EF-AA91-673274F40EC0}

GET PlanCare2Api/MedicalMentalCompetence/{id}

Gets MedicalMentalCompetence by id.

Requires 'Read' permission for function MedicalMentalCompetence {75049A4D-E21B-41EF-AA91-673274F40EC0}

GET PlanCare2Api/MedicalMentalCompetence/ActualValue?relationId={relationId}

Gets the actual MedicalMentalCompetenceSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalMentalCompetence {75049A4D-E21B-41EF-AA91-673274F40EC0}

GET PlanCare2Api/MedicalMentalCompetence/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalMentalCompetenceSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalMentalCompetence {75049A4D-E21B-41EF-AA91-673274F40EC0}

POST PlanCare2Api/MedicalMentalCompetence

Insert MedicalMentalCompetence.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalMentalCompetence {75049A4D-E21B-41EF-AA91-673274F40EC0}

POST PlanCare2Api/MedicalMentalCompetence/Update

Update MedicalMentalCompetence.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalMentalCompetence {75049A4D-E21B-41EF-AA91-673274F40EC0}

MedicalOxygenSaturation

MedicalOxygenSaturationController.

APIDescription
DELETE PlanCare2Api/MedicalOxygenSaturation/{id}

Delete MedicalOxygenSaturation.

Requires 'Delete' permission for function MedicalOxygenSaturation {97051EB2-B01F-4DFC-99B7-64D636E1A36A}

GET PlanCare2Api/MedicalOxygenSaturation?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalOxygenSaturationSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalOxygenSaturation {97051EB2-B01F-4DFC-99B7-64D636E1A36A}

GET PlanCare2Api/MedicalOxygenSaturation/{id}

Gets MedicalOxygenSaturation by id.

Requires 'Read' permission for function MedicalOxygenSaturation {97051EB2-B01F-4DFC-99B7-64D636E1A36A}

GET PlanCare2Api/MedicalOxygenSaturation/ActualValue?relationId={relationId}

Gets the actual MedicalOxygenSaturationSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalOxygenSaturation {97051EB2-B01F-4DFC-99B7-64D636E1A36A}

GET PlanCare2Api/MedicalOxygenSaturation/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalOxygenSaturationSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalOxygenSaturation {97051EB2-B01F-4DFC-99B7-64D636E1A36A}

POST PlanCare2Api/MedicalOxygenSaturation

Insert MedicalOxygenSaturation.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalOxygenSaturation {97051EB2-B01F-4DFC-99B7-64D636E1A36A}

POST PlanCare2Api/MedicalOxygenSaturation/Update

Update MedicalOxygenSaturation.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalOxygenSaturation {97051EB2-B01F-4DFC-99B7-64D636E1A36A}

MedicalPainScore

MedicalPainScoreController.

APIDescription
DELETE PlanCare2Api/MedicalPainScore/{id}

Delete MedicalPainScore.

Requires 'Delete' permission for function MedicalPainScore {4B0A8612-F7C4-4F81-BFB5-B195DC3402B7}

GET PlanCare2Api/MedicalPainScore?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalPainScoreSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalPainScore {4B0A8612-F7C4-4F81-BFB5-B195DC3402B7}

GET PlanCare2Api/MedicalPainScore/{id}

Gets MedicalPainScore by id.

Requires 'Read' permission for function MedicalPainScore {4B0A8612-F7C4-4F81-BFB5-B195DC3402B7}

GET PlanCare2Api/MedicalPainScore/ActualValue?relationId={relationId}

Gets the actual MedicalPainScoreSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalPainScore {4B0A8612-F7C4-4F81-BFB5-B195DC3402B7}

GET PlanCare2Api/MedicalPainScore/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalPainScoreSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalPainScore {4B0A8612-F7C4-4F81-BFB5-B195DC3402B7}

POST PlanCare2Api/MedicalPainScore

Insert MedicalPainScore.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalPainScore {4B0A8612-F7C4-4F81-BFB5-B195DC3402B7}

POST PlanCare2Api/MedicalPainScore/Update

Update MedicalPainScore.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalPainScore {4B0A8612-F7C4-4F81-BFB5-B195DC3402B7}

MedicalPulse

MedicalPulseController.

APIDescription
DELETE PlanCare2Api/MedicalPulse/{id}

Delete MedicalPulse.

Requires 'Delete' permission for function MedicalPulse {42A20032-4DCE-4A04-B440-0D489F36E58B}

GET PlanCare2Api/MedicalPulse?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalPulseSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalPulse {42A20032-4DCE-4A04-B440-0D489F36E58B}

GET PlanCare2Api/MedicalPulse/{id}

Gets MedicalPulse by id.

Requires 'Read' permission for function MedicalPulse {42A20032-4DCE-4A04-B440-0D489F36E58B}

GET PlanCare2Api/MedicalPulse/ActualValue?relationId={relationId}

Gets the actual MedicalPulseSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalPulse {42A20032-4DCE-4A04-B440-0D489F36E58B}

GET PlanCare2Api/MedicalPulse/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalPulseSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalPulse {42A20032-4DCE-4A04-B440-0D489F36E58B}

POST PlanCare2Api/MedicalPulse

Insert MedicalPulse.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalPulse {42A20032-4DCE-4A04-B440-0D489F36E58B}

POST PlanCare2Api/MedicalPulse/Update

Update MedicalPulse.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalPulse {42A20032-4DCE-4A04-B440-0D489F36E58B}

MedicalResuscitationPolicy

MedicalResuscitationPolicyController.

APIDescription
DELETE PlanCare2Api/MedicalResuscitationPolicy/{id}

Delete MedicalResuscitationPolicy.

Requires 'Delete' permission for function MedicalResuscitationPolicy {CB6B5322-6FB1-4C03-BD1C-5C2D852ECE60}

GET PlanCare2Api/MedicalResuscitationPolicy?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalResuscitationPolicySummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalResuscitationPolicy {CB6B5322-6FB1-4C03-BD1C-5C2D852ECE60}

GET PlanCare2Api/MedicalResuscitationPolicy/{id}

Gets MedicalResuscitationPolicy by id.

Requires 'Read' permission for function MedicalResuscitationPolicy {CB6B5322-6FB1-4C03-BD1C-5C2D852ECE60}

GET PlanCare2Api/MedicalResuscitationPolicy/ActualValue?relationId={relationId}

Gets the actual MedicalResuscitationPolicySummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalResuscitationPolicy {CB6B5322-6FB1-4C03-BD1C-5C2D852ECE60}

GET PlanCare2Api/MedicalResuscitationPolicy/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalResuscitationPolicySummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalResuscitationPolicy {CB6B5322-6FB1-4C03-BD1C-5C2D852ECE60}

POST PlanCare2Api/MedicalResuscitationPolicy

Insert MedicalResuscitationPolicy.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalResuscitationPolicy {CB6B5322-6FB1-4C03-BD1C-5C2D852ECE60}

POST PlanCare2Api/MedicalResuscitationPolicy/Update

Update MedicalResuscitationPolicy.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalResuscitationPolicy {CB6B5322-6FB1-4C03-BD1C-5C2D852ECE60}

MedicalSnaqRcScore

MedicalSnaqRcScoreController.

APIDescription
DELETE PlanCare2Api/MedicalSnaqRcScore/{id}

Delete MedicalSnaqRcScore.

Requires 'Delete' permission for function MedicalSnaqRcScore {AB5B3884-A008-4B0F-B4FD-616B5C652405}

GET PlanCare2Api/MedicalSnaqRcScore?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalSnaqRcScoreSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalSnaqRcScore {AB5B3884-A008-4B0F-B4FD-616B5C652405}

GET PlanCare2Api/MedicalSnaqRcScore/{id}

Gets MedicalSnaqRcScore by id.

Requires 'Read' permission for function MedicalSnaqRcScore {AB5B3884-A008-4B0F-B4FD-616B5C652405}

GET PlanCare2Api/MedicalSnaqRcScore/ActualValue?relationId={relationId}

Gets the actual MedicalSnaqRcScoreSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalSnaqRcScore {AB5B3884-A008-4B0F-B4FD-616B5C652405}

GET PlanCare2Api/MedicalSnaqRcScore/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalSnaqRcScoreSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalSnaqRcScore {AB5B3884-A008-4B0F-B4FD-616B5C652405}

POST PlanCare2Api/MedicalSnaqRcScore

Insert MedicalSnaqRcScore.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalSnaqRcScore {AB5B3884-A008-4B0F-B4FD-616B5C652405}

POST PlanCare2Api/MedicalSnaqRcScore/Update

Update MedicalSnaqRcScore.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalSnaqRcScore {AB5B3884-A008-4B0F-B4FD-616B5C652405}

MedicalSnaqScore

MedicalSnaqScoreController.

APIDescription
DELETE PlanCare2Api/MedicalSnaqScore/{id}

Delete MedicalSnaqScore.

Requires 'Delete' permission for function MedicalSnaqScore {92277256-317D-4E7E-8C7C-AB3CE345CDC1}

GET PlanCare2Api/MedicalSnaqScore?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalSnaqScoreSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalSnaqScore {92277256-317D-4E7E-8C7C-AB3CE345CDC1}

GET PlanCare2Api/MedicalSnaqScore/{id}

Gets MedicalSnaqScore by id.

Requires 'Read' permission for function MedicalSnaqScore {92277256-317D-4E7E-8C7C-AB3CE345CDC1}

GET PlanCare2Api/MedicalSnaqScore/ActualValue?relationId={relationId}

Gets the actual MedicalSnaqScoreSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalSnaqScore {92277256-317D-4E7E-8C7C-AB3CE345CDC1}

GET PlanCare2Api/MedicalSnaqScore/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalSnaqScoreSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalSnaqScore {92277256-317D-4E7E-8C7C-AB3CE345CDC1}

POST PlanCare2Api/MedicalSnaqScore

Insert MedicalSnaqScore.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalSnaqScore {92277256-317D-4E7E-8C7C-AB3CE345CDC1}

POST PlanCare2Api/MedicalSnaqScore/Update

Update MedicalSnaqScore.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalSnaqScore {92277256-317D-4E7E-8C7C-AB3CE345CDC1}

MedicalTemperature

MedicalTemperatureController.

APIDescription
DELETE PlanCare2Api/MedicalTemperature/{id}

Delete MedicalTemperature.

Requires 'Delete' permission for function MedicalTemperature {A6B5B8F7-6408-488A-B92F-D3C1272D8C9E}

GET PlanCare2Api/MedicalTemperature?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalTemperatureSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalTemperature {A6B5B8F7-6408-488A-B92F-D3C1272D8C9E}

GET PlanCare2Api/MedicalTemperature/{id}

Gets MedicalTemperature by id.

Requires 'Read' permission for function MedicalTemperature {A6B5B8F7-6408-488A-B92F-D3C1272D8C9E}

GET PlanCare2Api/MedicalTemperature/ActualValue?relationId={relationId}

Gets the actual MedicalTemperatureSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalTemperature {A6B5B8F7-6408-488A-B92F-D3C1272D8C9E}

GET PlanCare2Api/MedicalTemperature/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalTemperatureSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalTemperature {A6B5B8F7-6408-488A-B92F-D3C1272D8C9E}

POST PlanCare2Api/MedicalTemperature

Insert MedicalTemperature.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalTemperature {A6B5B8F7-6408-488A-B92F-D3C1272D8C9E}

POST PlanCare2Api/MedicalTemperature/Update

Update MedicalTemperature.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalTemperature {A6B5B8F7-6408-488A-B92F-D3C1272D8C9E}

MedicalTreatmentPolicy

MedicalTreatmentPolicyController.

APIDescription
DELETE PlanCare2Api/MedicalTreatmentPolicy/{id}

Delete MedicalTreatmentPolicy.

Requires 'Delete' permission for function MedicalTreatmentPolicy {94A423A0-C1F4-486A-9851-E4F74A18E6A3}

GET PlanCare2Api/MedicalTreatmentPolicy?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalTreatmentPolicySummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalTreatmentPolicy {94A423A0-C1F4-486A-9851-E4F74A18E6A3}

GET PlanCare2Api/MedicalTreatmentPolicy/{id}

Gets MedicalTreatmentPolicy by id.

Requires 'Read' permission for function MedicalTreatmentPolicy {94A423A0-C1F4-486A-9851-E4F74A18E6A3}

GET PlanCare2Api/MedicalTreatmentPolicy/ActualValue?relationId={relationId}

Gets the actual MedicalTreatmentPolicySummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalTreatmentPolicy {94A423A0-C1F4-486A-9851-E4F74A18E6A3}

GET PlanCare2Api/MedicalTreatmentPolicy/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalTreatmentPolicySummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalTreatmentPolicy {94A423A0-C1F4-486A-9851-E4F74A18E6A3}

POST PlanCare2Api/MedicalTreatmentPolicy

Insert MedicalTreatmentPolicy.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalTreatmentPolicy {94A423A0-C1F4-486A-9851-E4F74A18E6A3}

POST PlanCare2Api/MedicalTreatmentPolicy/Update

Update MedicalTreatmentPolicy.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalTreatmentPolicy {94A423A0-C1F4-486A-9851-E4F74A18E6A3}

MedicalUrinaryRetention

MedicalUrinaryRetentionController.

APIDescription
DELETE PlanCare2Api/MedicalUrinaryRetention/{id}

Delete MedicalUrinaryRetention.

Requires 'Delete' permission for function MedicalUrinaryRetention {7B786F52-3AAB-41F8-8879-FC5375ADD096}

GET PlanCare2Api/MedicalUrinaryRetention?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalUrinaryRetentionSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalUrinaryRetention {7B786F52-3AAB-41F8-8879-FC5375ADD096}

GET PlanCare2Api/MedicalUrinaryRetention/{id}

Gets MedicalUrinaryRetention by id.

Requires 'Read' permission for function MedicalUrinaryRetention {7B786F52-3AAB-41F8-8879-FC5375ADD096}

GET PlanCare2Api/MedicalUrinaryRetention/ActualValue?relationId={relationId}

Gets the actual MedicalUrinaryRetentionSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalUrinaryRetention {7B786F52-3AAB-41F8-8879-FC5375ADD096}

GET PlanCare2Api/MedicalUrinaryRetention/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalUrinaryRetentionSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalUrinaryRetention {7B786F52-3AAB-41F8-8879-FC5375ADD096}

POST PlanCare2Api/MedicalUrinaryRetention

Insert MedicalUrinaryRetention.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalUrinaryRetention {7B786F52-3AAB-41F8-8879-FC5375ADD096}

POST PlanCare2Api/MedicalUrinaryRetention/Update

Update MedicalUrinaryRetention.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalUrinaryRetention {7B786F52-3AAB-41F8-8879-FC5375ADD096}

MedicalVaccination

MedicalVaccinationController.

APIDescription
DELETE PlanCare2Api/MedicalVaccination/{id}

Delete MedicalVaccination.

Requires 'Delete' permission for function MedicalVaccination {D0D9C9C6-5EA5-45CB-8AC2-24D6EEF784CF}

GET PlanCare2Api/MedicalVaccination?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalVaccinationSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalVaccination {D0D9C9C6-5EA5-45CB-8AC2-24D6EEF784CF}

GET PlanCare2Api/MedicalVaccination/{id}

Gets MedicalVaccination by id.

Requires 'Read' permission for function MedicalVaccination {D0D9C9C6-5EA5-45CB-8AC2-24D6EEF784CF}

GET PlanCare2Api/MedicalVaccination/ActualValue?relationId={relationId}

Gets the actual MedicalVaccinationSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalVaccination {D0D9C9C6-5EA5-45CB-8AC2-24D6EEF784CF}

GET PlanCare2Api/MedicalVaccination/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalVaccinationSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalVaccination {D0D9C9C6-5EA5-45CB-8AC2-24D6EEF784CF}

POST PlanCare2Api/MedicalVaccination

Insert MedicalVaccination.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalVaccination {D0D9C9C6-5EA5-45CB-8AC2-24D6EEF784CF}

POST PlanCare2Api/MedicalVaccination/Update

Update MedicalVaccination.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalVaccination {D0D9C9C6-5EA5-45CB-8AC2-24D6EEF784CF}

MedicalWeight

MedicalWeightController.

APIDescription
DELETE PlanCare2Api/MedicalWeight/{id}

Delete MedicalWeight.

Requires 'Delete' permission for function MedicalWeight {0D7F4475-C2D4-4573-9A6B-9E03FFACDF4F}

GET PlanCare2Api/MedicalWeight?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets list of MedicalWeightSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalWeight {0D7F4475-C2D4-4573-9A6B-9E03FFACDF4F}

GET PlanCare2Api/MedicalWeight/{id}

Gets MedicalWeight by id.

Requires 'Read' permission for function MedicalWeight {0D7F4475-C2D4-4573-9A6B-9E03FFACDF4F}

GET PlanCare2Api/MedicalWeight/ActualValue?relationId={relationId}

Gets the actual MedicalWeightSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalWeight {0D7F4475-C2D4-4573-9A6B-9E03FFACDF4F}

GET PlanCare2Api/MedicalWeight/Count?relationId={relationId}&registrationDateTimeFrom={registrationDateTimeFrom}&registrationDateTimeUntil={registrationDateTimeUntil}

Gets count of MedicalWeightSummary of the specified relation.

Relation(s) must be of the following type: Client

Requires 'Read' permission for function MedicalWeight {0D7F4475-C2D4-4573-9A6B-9E03FFACDF4F}

POST PlanCare2Api/MedicalWeight

Insert MedicalWeight.

Relation(s) must be of the following type: Client

Requires 'Insert' permission for function MedicalWeight {0D7F4475-C2D4-4573-9A6B-9E03FFACDF4F}

POST PlanCare2Api/MedicalWeight/Update

Update MedicalWeight.

Relation(s) must be of the following type: Client

Requires 'Edit' permission for function MedicalWeight {0D7F4475-C2D4-4573-9A6B-9E03FFACDF4F}

MeetingSeries

Obtain meetings

At least one of these modules is required: DaytimeActivity

APIDescription
DELETE PlanCare2Api/DaytimeActivity/MeetingSeries/Subscriptions/{id}

Delete an existing subscription of a daytime activity meeting.

Requires 'Start' permission for function DaytimeActivityOverview {16EDE7B1-4F4B-4C01-A7E4-79E73CF6B2E3}

GET PlanCare2Api/DaytimeActivity/MeetingSeries?dateFrom={dateFrom}&dateUntil={dateUntil}

Gets the meeting series in a specified range.

Requires 'Start' permission for function DaytimeActivityProgramClient {E7F4025B-80C9-4E2A-8537-129E3D0CC2C9}

GET PlanCare2Api/DaytimeActivity/MeetingSeries/{id}/employees?date={date}

Fetches the employees of a daytime activity meeting on a given day

Requires 'Start' permission for function DaytimeActivityProgramClient {E7F4025B-80C9-4E2A-8537-129E3D0CC2C9}

GET PlanCare2Api/DaytimeActivity/MeetingSeries/{id}/enrollments?date={date}

Fetch the enrollments of a daytime activity meeting on a given day

Requires 'Start' permission for function DaytimeActivityProgramClient {E7F4025B-80C9-4E2A-8537-129E3D0CC2C9}

GET PlanCare2Api/DaytimeActivity/MeetingSeries/{id}/meetings/{date}/programparts

Fetch the program parts of a daytime activity meeting on a specific date

Requires 'Start' permission for function DaytimeActivityProgramClient {E7F4025B-80C9-4E2A-8537-129E3D0CC2C9}

GET PlanCare2Api/DaytimeActivity/MeetingSeries/{id}/options

Gets the available options of the meetings.

Requires 'Start' permission for function DaytimeActivityOverview {16EDE7B1-4F4B-4C01-A7E4-79E73CF6B2E3}

GET PlanCare2Api/DaytimeActivity/MeetingSeries/meetings?dateFrom={dateFrom}&dateUntil={dateUntil}

Gets the meetings in a specified range.

Requires 'Start' permission for function DaytimeActivityProgramClient {E7F4025B-80C9-4E2A-8537-129E3D0CC2C9}

POST PlanCare2Api/DaytimeActivity/MeetingSeries/{id}

Set state of meeting on given date

Requires 'Start' permission for function DaytimeActivityProgramClient {E7F4025B-80C9-4E2A-8537-129E3D0CC2C9}

POST PlanCare2Api/DaytimeActivity/MeetingSeries/{id}/employees?date={date}

Update the list employees of a daytime activity meeting on a given day

Requires 'Start' permission for function DaytimeActivityProgramClient {E7F4025B-80C9-4E2A-8537-129E3D0CC2C9}

POST PlanCare2Api/DaytimeActivity/MeetingSeries/{id}/meetings/{date}/programparts

Replaces the list programparts of a daytime activity meeting on a given day

Requires 'Start' permission for function DaytimeActivityProgramClient {E7F4025B-80C9-4E2A-8537-129E3D0CC2C9}

POST PlanCare2Api/DaytimeActivity/MeetingSeries/ChangeOfMeetingTime

Change the start time and/or end time of a meeting. The day can not be changed.

Requires 'Start' permission for function DaytimeActivityProgramClient {E7F4025B-80C9-4E2A-8537-129E3D0CC2C9}

POST PlanCare2Api/DaytimeActivity/MeetingSeries/Enrollments

Save a new enrollment occurrence to a daytime activity meeting.

Requires 'Start' permission for function DaytimeActivityOverview {16EDE7B1-4F4B-4C01-A7E4-79E73CF6B2E3}

POST PlanCare2Api/DaytimeActivity/MeetingSeries/Enrollments/ChangeOfDaytimeActivityMeetingEnrollment

Update an existing enrollment occurrence of a daytime activity meeting.

Requires 'Start' permission for function DaytimeActivityOverview {16EDE7B1-4F4B-4C01-A7E4-79E73CF6B2E3}

POST PlanCare2Api/DaytimeActivity/MeetingSeries/Subscriptions

Save a new subscription to a daytime activity meeting.

Requires 'Start' permission for function DaytimeActivityOverview {16EDE7B1-4F4B-4C01-A7E4-79E73CF6B2E3}

POST PlanCare2Api/DaytimeActivity/MeetingSeries/Subscriptions/ChangeOfDaytimeActivityMeetingSubscription

Modify an existing subscription to a daytime activity meeting.

Requires 'Start' permission for function DaytimeActivityOverview {16EDE7B1-4F4B-4C01-A7E4-79E73CF6B2E3}

NutritionAndWeights

Obtain and create nutrition and weight values

At least one of these modules is required: CareRegistration

APIDescription
DELETE PlanCare2Api/CareRegistration/NutritionAndWeights/{id}

Deletes a Nutrition And Weight instance

Requires 'Start' permission for function NutritionAndWeightOverview {7B015D7A-3649-4237-B43E-1B7909CEB9E5}

GET PlanCare2Api/CareRegistration/NutritionAndWeights?clientId={clientId}&from={from}&maxRecordCount={maxRecordCount}

Gets the nutrition and weight values of the specified client

Requires 'Start' permission for function NutritionAndWeightOverview {7B015D7A-3649-4237-B43E-1B7909CEB9E5}

GET PlanCare2Api/CareRegistration/NutritionAndWeights?bsn={bsn}&from={from}&maxRecordCount={maxRecordCount}

Gets the nutrition and weight values of the specified client

Requires 'Start' permission for function NutritionAndWeightOverview {7B015D7A-3649-4237-B43E-1B7909CEB9E5}

POST PlanCare2Api/CareRegistration/NutritionAndWeights

Saves a new nutritionAndWeight instance

Requires 'Start' permission for function NutritionAndWeightOverview {7B015D7A-3649-4237-B43E-1B7909CEB9E5}

POST PlanCare2Api/CareRegistration/NutritionAndWeights/ChangeOfNutritionAndWeights

stores a ChangeOfNutritionAndWeight instance

Requires 'Start' permission for function NutritionAndWeightOverview {7B015D7A-3649-4237-B43E-1B7909CEB9E5}

OrganizationStructure

OrganizationStructureController.

APIDescription
GET PlanCare2Api/OrganizationStructure?applyPermissions={applyPermissions}

Gets active structure of organization.

Permissions

Obtain information about permissions.

At least one of these modules is required: Base

APIDescription
GET PlanCare2Api/Permissions/AuthorizedForAccessFunctionPermission?accessFunctionGuid={accessFunctionGuid}&permission={permission}

Returns whether the logged on user is authorized for a given accessfunction and permission.

PlanCareMessages

Obtain and send messages

At least one of these modules is required: Messaging

APIDescription
GET PlanCare2Api/PlanCareMessages?folder={folder}

Gets all messages.

GET PlanCare2Api/PlanCareMessages/Folder/{folder}/Count

Gets number of messages.

POST PlanCare2Api/PlanCareMessages/Message

Post a Message.

POST PlanCare2Api/PlanCareMessages/ReadConfirmation?messageId={messageId}

Post a read confirmation message

POST PlanCare2Api/PlanCareMessages/Reply

Post a reply message

PlanCareVersions

Provides information about the current version of PlanCare 2 this endpoint runs on.

APIDescription
GET PlanCare2Api/PlanCareVersions/AssemblyVersion

Gets the version of PlanCare 2 assembly containing this endpoint

GET PlanCare2Api/PlanCareVersions/PlanCareVersion

Gets the version of PlanCare 2

Products

Obtain product information

At least one of these modules is required: Base

APIDescription
GET PlanCare2Api/Products

Gets all products

Requires 'Start' permission for function BackOfficeOverview {FA1038EC-0FED-49E9-9376-D5DCE92D694E}

GET PlanCare2Api/Products?employmentId={employmentId}&referenceDate={referenceDate}

Gets all products that are valid for the given employmentId and referenceDate

GET PlanCare2Api/Products?contractTypeId={contractTypeId}&referenceDate={referenceDate}

Gets all products by contract type valid on the given date

GET PlanCare2Api/Products/{productId}/Acts?referenceDate={referenceDate}

Gets all product acts by product id

GET PlanCare2Api/Products/{productId}/WorkTypes?referenceDate={referenceDate}

Gets all product work types by product id

Projects

Obtain projects

At least one of these modules is required: Base

APIDescription
GET PlanCare2Api/Projects?contractId={contractId}&referenceDate={referenceDate}

Fetch projects that are available to a contract at a certain date

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

GET PlanCare2Api/Projects/{projectId}/CareTrajects?referenceDate={referenceDate}

Fetch care trajects that are available to a project at a certain date and contract Note: This endpoint is obsolete and will be deleted in a future version of the API. Use the endpoint PlanCare2Api/Projects/pcd/{projectId}/CareTrajects instead.

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

GET PlanCare2Api/Projects/{projectId}/Products?contractId={contractId}&referenceDate={referenceDate}

Fetch products that are available to a project at a certain date and contract Note: This endpoint is obsolete and will be deleted in a future version of the API. Use the endpoint PlanCare2Api/Projects/pcd/{projectId}/Products instead.

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

GET PlanCare2Api/Projects/pcd/{projectId}/CareTrajects?referenceDate={referenceDate}

Fetch care trajects that are available to a project at a certain date and contract

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

GET PlanCare2Api/Projects/pcd/{projectId}/Products?contractId={contractId}&referenceDate={referenceDate}

Fetch products that are available to a project at a certain date and contract

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

Questionnaires

Provides the ability to load questionnaires.

At least one of these modules is required: Questionnaire

APIDescription
GET PlanCare2Api/Questionnaires/ChaptersForCarePlan/{clientId}

Gets the questionnaire chapters for a careplan of the specified client.

Requires 'Start' permission for function CareplanOverview {1B739E50-944B-4804-9793-637E93DDCC91}

GET PlanCare2Api/Questionnaires/ChaptersForClientCard/{clientId}

Gets the questionnaire chapters for a clientcard of the specified client.

Requires 'Start' permission for function ClientCard {79A91D2E-1D0D-4B25-B5DF-0D420DFA4876}

GET PlanCare2Api/Questionnaires/FilledQuestionnaires?clientId={clientId}

Gets the filled questionnaires of the specified client.

Requires 'Start' permission for function QuestionnaireFilledOverview {765EA0EB-A188-4173-88A2-A2C8F75DC4EC}

GET PlanCare2Api/Questionnaires/FilledQuestionnaires?clientId={clientId}&questionnaireGuid={questionnaireGuid}

Gets the filled questionnaires of the specified client and specified questionnaire.

GET PlanCare2Api/Questionnaires/FilledQuestionnaires?clientId={clientId}&filledQuestionnairesStatus={filledQuestionnairesStatus}

Gets the filled questionnaires of the specified client.

Requires 'Start' permission for function QuestionnaireFilledOverview {765EA0EB-A188-4173-88A2-A2C8F75DC4EC}

GET PlanCare2Api/Questionnaires/FilledQuestionnaires?clientIds[0]={clientIds[0]}&clientIds[1]={clientIds[1]}

Gets the filled questionnaires of the specified client.

Requires 'Start' permission for function QuestionnaireFilledOverview {765EA0EB-A188-4173-88A2-A2C8F75DC4EC}

GET PlanCare2Api/Questionnaires/FilledQuestionnaires?clientIds[0]={clientIds[0]}&clientIds[1]={clientIds[1]}&filledQuestionnairesStatus={filledQuestionnairesStatus}

Gets the filled questionnaires of the specified client.

Requires 'Start' permission for function QuestionnaireFilledOverview {765EA0EB-A188-4173-88A2-A2C8F75DC4EC}

GET PlanCare2Api/Questionnaires/FilledQuestionnaires/{filledQuestionnaireId}

Gets a filled questionnaire.

Requires 'Start' permission for function QuestionnaireFilledOverview {765EA0EB-A188-4173-88A2-A2C8F75DC4EC}

GET PlanCare2Api/Questionnaires/FilledQuestionnaires/{filledQuestionnaireId}/Answers

Gets answers by filledQuestionnaireId.

GET PlanCare2Api/Questionnaires/FilledQuestionnaires/{filledQuestionnaireId}/Answers/{questionGuid}

Gets answer by filledQuestionnaireId and questionGuid.

GET PlanCare2Api/Questionnaires/FilledQuestionnaires/{filledQuestionnaireId}/Chapters/{questionnaireChapterGuid}/Answers

Gets the answers for a specified chapter and filled questionnaire combination.

GET PlanCare2Api/Questionnaires/FilledQuestionnaires/{filledQuestionnaireId}/Chapters/{questionnaireChapterGuid}/SubChapters

Gets the subchapters for a specified questionnaire chapter.

GET PlanCare2Api/Questionnaires/FilledQuestionnaires/{filledQuestionnaireId}/FirstQuestion

Gets the result of navigation to the first question.

GET PlanCare2Api/Questionnaires/FilledQuestionnaires/{filledQuestionnaireId}/LastQuestion

Gets the result of navigation to the last question.

GET PlanCare2Api/Questionnaires/FilledQuestionnaires/{filledQuestionnaireId}/NextQuestion?currentQuestionGuid={currentQuestionGuid}

Gets the result of navigation to the next question.

GET PlanCare2Api/Questionnaires/FilledQuestionnaires/{filledQuestionnaireId}/OverviewAnswers

Gets answers by filledQuestionnaireId.

GET PlanCare2Api/Questionnaires/FilledQuestionnaires/{filledQuestionnaireId}/PreviousQuestion?currentQuestionGuid={currentQuestionGuid}

Gets the result of navigation to the previous question.

GET PlanCare2Api/Questionnaires/FilledQuestionnaires/{questionnaireGuid}/Chapters

Gets the questionnaire chapters for the specified questionnaire.

GET PlanCare2Api/Questionnaires/Questionnaires/{questionnaireGuid}

Gets questionnaire by guid.

GET PlanCare2Api/Questionnaires/QuestionnairesAvailableForInsert?intendedFor={intendedFor}

Gets list of questionnaires available for insert.

POST PlanCare2Api/Questionnaires/FilledQuestionnaires/Create

Create new filledquestionnaire.

POST PlanCare2Api/Questionnaires/FilledQuestionnaires/Lock

Post lock filledquestionnaire.

POST PlanCare2Api/Questionnaires/FilledQuestionnaires/Status

Post status filledquestionnaire.

POST PlanCare2Api/Questionnaires/FilledQuestionnaires/Unlock

Post unlock filledquestionnaire.

POST PlanCare2Api/Questionnaires/FilledQuestionnaires/UpdateAnswer

Post answer.

POST PlanCare2Api/Questionnaires/FilledQuestionnaires/UpdateAnswers

Post answers.

RealizedWorktime

Obtain realized worktime

At least one of these modules is required: TimeRegistration

APIDescription
GET PlanCare2Api/RealizedWorktime?dateFrom={dateFrom}&dateUntil={dateUntil}

Retrieve all realized worktime

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

GET PlanCare2Api/RealizedWorktime?dateFrom={dateFrom}&dateUntil={dateUntil}&approvalLevel={approvalLevel}

Retrieve all realized worktime filtered by approval level

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

GET PlanCare2Api/RealizedWorktime?dateFrom={dateFrom}&dateUntil={dateUntil}&employmentOrganizationEntity={employmentOrganizationEntity}

Retrieve all realized worktime filtered by organization entity

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

GET PlanCare2Api/RealizedWorktime?dateFrom={dateFrom}&dateUntil={dateUntil}&approvalLevel={approvalLevel}&employmentOrganizationEntity={employmentOrganizationEntity}

Retrieve all realized worktime filtered by approval level and organization entity

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

Relations

Obtains relation information

At least one of these modules is required: RelationManagement

APIDescription
DELETE PlanCare2Api/Relations/Correlations/{correlationId}

Delete correlation.

DELETE PlanCare2Api/Relations/Note/{id}

Delete note.

Requires 'Edit' permission for function Notes {29EDAA20-4561-4B98-846B-4AF0F7E3FA93}

GET PlanCare2Api/Relations/{relationId}/ActiveCorrelations?referenceDate={referenceDate}&correlationTypeId={correlationTypeId}&allowAccessClientPortal={allowAccessClientPortal}

Get the active correlations on referencedate where user has read permission for.

Relation(s) can be of the following types: Client, Prospect, Family, Employee, ContactPerson

GET PlanCare2Api/Relations/{relationId}/Addresses

Gets addresses by relation.

Relation(s) can be of the following types: Client, Prospect, Family, Employee, ContactPerson, CareProvider

GET PlanCare2Api/Relations/{relationId}/CareProviders

Get the CareProviders by relation.

Requires 'Start' permission for function ClientCorrelationsCareProvider {E2878207-529D-44C8-8E99-8923CDBBCE82}

GET PlanCare2Api/Relations/{relationId}/Contacts

Gets contacts by relation.

Relation(s) can be of the following types: Client, Prospect, Family, Employee, ContactPerson, CareProvider

GET PlanCare2Api/Relations/{relationId}/Correlations

Get the correlations of correlationTypes where user has read permission for.

Relation(s) can be of the following types: Client, Prospect, Family, Employee, ContactPerson

GET PlanCare2Api/Relations/{relationId}/Correlations?correlationTypeId={correlationTypeId}

Get the correlations of correlationTypes where user has read permission for.

Relation(s) can be of the following types: Client, Prospect, Family, Employee, ContactPerson

GET PlanCare2Api/Relations/{relationId}/Correlations/Organization

Get organization-correlations by relation.

Relation(s) can be of the following types: Client, Employee, Family

GET PlanCare2Api/Relations/{relationId}/Correlations/Treatment

Get treatment-correlations by relation.

Relation(s) can be of the following types: Client, Employee, Family

GET PlanCare2Api/Relations/{relationId}/Notes

Get notes by relation.

Relation(s) can be of the following types: Client, Prospect, Family, ContactPerson

Requires 'Start' permission for function Notes {29EDAA20-4561-4B98-846B-4AF0F7E3FA93}

GET PlanCare2Api/Relations/{relationId}/Photo

Get a photo of a relation

Relation(s) can be of the following types: Client, Prospect, Employee, ContactPerson

GET PlanCare2Api/Relations/{relationId}/Thumbnail

Get a thumbnail of a relation.

Relation(s) can be of the following types: Client, Prospect, Employee, ContactPerson

GET PlanCare2Api/Relations/CommonData?relationId={relationId}

Get RelationCommonDataSummary.

Relation(s) can be of the following types: Client, Prospect, Employee, ContactPerson

GET PlanCare2Api/Relations/CorrelationRoles?correlationTypeId={correlationTypeId}

Get correlation roles by type of correlation.

GET PlanCare2Api/Relations/Correlations/Organization/{correlationId}

Get organization-correlation by id.

GET PlanCare2Api/Relations/Correlations/Treatment/{correlationId}

Get treatment-correlation by id.

GET PlanCare2Api/Relations/CorrelationTypes

Get correlation types.

GET PlanCare2Api/Relations/CountriesOfBirth

Get countries of birth.

GET PlanCare2Api/Relations/Genders

Get genders

GET PlanCare2Api/Relations/Languages

Gets Languages.

GET PlanCare2Api/Relations/LastNameFormats

Get formats for the last name.

GET PlanCare2Api/Relations/LegalStatuses

Gets LegalStatuses.

GET PlanCare2Api/Relations/LivingUnits

Gets LivingUnits.

GET PlanCare2Api/Relations/LookupNameFormats

Get formats for the lookup name.

GET PlanCare2Api/Relations/MaritalStatuses

Gets MaritalStatuses.

GET PlanCare2Api/Relations/Nationalities

Gets Nationalities.

GET PlanCare2Api/Relations/Note/{id}

Get note by id.

Requires 'Edit' permission for function Notes {29EDAA20-4561-4B98-846B-4AF0F7E3FA93}

GET PlanCare2Api/Relations/NoteTypes

Get types of notes.

Requires 'Start' permission for function Notes {29EDAA20-4561-4B98-846B-4AF0F7E3FA93}

GET PlanCare2Api/Relations/ParticularFormsOfCommunication

Gets ParticularFormsOfCommunication.

GET PlanCare2Api/Relations/Photo?relationIds[0]={relationIds[0]}&relationIds[1]={relationIds[1]}

Retrieve all photos of the given relations.

Relation(s) can be of the following types: Client, Prospect, Employee, ContactPerson

GET PlanCare2Api/Relations/Religions

Gets Religions.

GET PlanCare2Api/Relations/Thumbnail?relationIds[0]={relationIds[0]}&relationIds[1]={relationIds[1]}

Retrieve all thumbnails of the given relations.

Relation(s) can be of the following types: Client, Prospect, Employee, ContactPerson

POST PlanCare2Api/Relations/{relationId}/Photo

Upload a photo of a relation, with a maximum allowed size of 10MB. Photo content in Base64String format.

Relation(s) can be of the following types: Client, Prospect, Employee, ContactPerson

POST PlanCare2Api/Relations/CommonData

Post RelationCommonData.

Relation(s) can be of the following types: Client, Prospect, Employee, ContactPerson

POST PlanCare2Api/Relations/Correlations/Organization

Insert organization-correlation.

POST PlanCare2Api/Relations/Correlations/Organization/Update

Update organization-correlation.

POST PlanCare2Api/Relations/Correlations/Treatment

Insert treatment-correlation.

POST PlanCare2Api/Relations/Correlations/Treatment/Update

Update treatment-correlation.

POST PlanCare2Api/Relations/Note

Insert note.

Requires 'Edit' permission for function Notes {29EDAA20-4561-4B98-846B-4AF0F7E3FA93}

POST PlanCare2Api/Relations/Note/Update

Update note.

Requires 'Edit' permission for function Notes {29EDAA20-4561-4B98-846B-4AF0F7E3FA93}

Reports

At least one of these modules is required: Reporting

APIDescription
GET PlanCare2Api/Reports/Locations

Gets the available report locations

GET PlanCare2Api/Reports/MetaData?reportLocation={reportLocation}

Gets the available reports for the specified location

GET PlanCare2Api/Reports/Pdf?reportLocation={reportLocation}&clientId={clientId}

Gets an exported report (PDF)

ReportTags

Report tags

At least one of these modules is required: Base

APIDescription
GET PlanCare2Api/ReportTags

Retrieve all report tags.

RiskCards

Obtain Riskcards

At least one of these modules is required: ICP

APIDescription
GET PlanCare2Api/CareRegistration/RiskCards?clientId={clientId}&cardStatus={cardStatus}

Gets RiskCards for the specified client based on a status

Requires 'Read' permission for function ClientCardRiskCard {8FCB802F-C125-4B15-B953-5F577E76CC7B}

GET PlanCare2Api/CareRegistration/RiskCards?clientId={clientId}

Gets RiskCards for the specified client

Requires 'Read' permission for function ClientCardRiskCard {8FCB802F-C125-4B15-B953-5F577E76CC7B}

GET PlanCare2Api/CareRegistration/RiskCards/Actual?clientId={clientId}

Gets the actual RiskCard for the specified client

Requires 'Read' permission for function ClientCardRiskCard {8FCB802F-C125-4B15-B953-5F577E76CC7B}

RootData

Obtains root data entities

At least one of these modules is required: Base

APIDescription
GET PlanCare2Api/RootData/ApplicationCustomLabels

Fetch available customer specific terms

GET PlanCare2Api/RootData/ApplicationSettings

Returns a list of application settings

Requires 'Start' permission for function BackOfficeOverview {FA1038EC-0FED-49E9-9376-D5DCE92D694E}

GET PlanCare2Api/RootData/ChoiceTypes

Gets all choice types

GET PlanCare2Api/RootData/ChoiceTypes/{choiceType}/Choices

Gets the choices of the specified choice type.

GET PlanCare2Api/RootData/costTypes

Fetch available cost types

GET PlanCare2Api/RootData/DisciplineGroups?groupId={groupId}&showDisciplines={showDisciplines}

Returns a list of all discipline groups.

GET PlanCare2Api/RootData/Disciplines

Returns a list of all PlanCare2 disciplines.

GET PlanCare2Api/RootData/TravelMethods

Fetch available travel methods

GET PlanCare2Api/RootData/Worktypes

Get all worktypes

GET PlanCare2Api/RootData/Worktypes?referenceDate={referenceDate}&contractTypeId={contractTypeId}&productId={productId}

Get available worktypes by referenceDate, contractTypeId and productId

GET PlanCare2Api/RootData/Worktypes?dateFrom={dateFrom}&dateUntil={dateUntil}

Get worktypes within date selection where the startdate of the worktype should by in the selectedperiod

GET PlanCare2Api/RootData/Worktypes/{workTypeId}/WorkTypeLevels

Get available worktypelevels by worktypeId

GET PlanCare2Api/RootData/Worktypes/WorkTypeLevels/{workTypeLevelId}/WorkTypeCompetences

Get available worktypecompetences by worktypeLevelId

Shifts

Provides the ability to load Shifts

At least one of these modules is required: Base

APIDescription
GET PlanCare2Api/Shifts

Retrieve all shifts

SocialNetwork

Obtains information about the social network of clients.

At least one of these modules is required: RelationManagement

APIDescription
GET PlanCare2Api/SocialNetwork/{relationId}/Relations

Gets the social network relation summaries of a relation.

Relation(s) must be of the following type: Client

Requires 'Start' permission for function ClientSocialNetwork {AF5A3543-0BF7-49CE-9023-4FF605C225A4}

GET PlanCare2Api/SocialNetwork/Priorities

Gets all social network priorities.

Requires 'Start' permission for function ClientSocialNetwork {AF5A3543-0BF7-49CE-9023-4FF605C225A4}

GET PlanCare2Api/SocialNetwork/RelationTypes

Gets all social network relation types.

Requires 'Start' permission for function ClientSocialNetwork {AF5A3543-0BF7-49CE-9023-4FF605C225A4}

GET PlanCare2Api/SocialNetwork/Tasks

Gets all social network tasks.

Requires 'Start' permission for function ClientSocialNetwork {AF5A3543-0BF7-49CE-9023-4FF605C225A4}

TeamAppointments

Obtain Team appointments

At least one of these modules is required: ICP

APIDescription
DELETE PlanCare2Api/TeamAppointments/{appointmentId}

Deletes a TeamAppointment instance

Requires 'Start' permission for function TeamCalendar {C3F247FC-E417-49CB-81F0-823D1E835B68}

DELETE PlanCare2Api/TeamAppointments/{appointmentId}/OccurrenceIndex/{occurrenceIndex}

Deletes a TeamAppointment instance

Requires 'Start' permission for function TeamCalendar {C3F247FC-E417-49CB-81F0-823D1E835B68}

GET PlanCare2Api/TeamAppointments?teamCalendarId={teamCalendarId}&dateFrom={dateFrom}&dateUntil={dateUntil}

Obtains all appointments for the specified Team Calendar

Requires 'Start' permission for function TeamCalendar {C3F247FC-E417-49CB-81F0-823D1E835B68}

GET PlanCare2Api/TeamAppointments/{appointmentId}?occurrenceRangeFrom={occurrenceRangeFrom}&occurrenceRangeUntil={occurrenceRangeUntil}

Obtains the specified team calendar appointment

Requires 'Start' permission for function TeamCalendar {C3F247FC-E417-49CB-81F0-823D1E835B68}

GET PlanCare2Api/TeamAppointments/OccurrenceAppointments/{appointmentId}

Obtains the occurrence appointment

Requires 'Start' permission for function TeamCalendar {C3F247FC-E417-49CB-81F0-823D1E835B68}

POST PlanCare2Api/TeamAppointments/ChangeOfOccurrenceAppointments

Saves a new OccurrenceAppointment instance. This appointment is part of a recurring Appointment

Requires 'Start' permission for function TeamCalendar {C3F247FC-E417-49CB-81F0-823D1E835B68}

POST PlanCare2Api/TeamAppointments/ChangeOfTeamAppointments

Updates an existing TeamAppointment instance

Requires 'Start' permission for function TeamCalendar {C3F247FC-E417-49CB-81F0-823D1E835B68}

POST PlanCare2Api/TeamAppointments/OccurrenceAppointments

Saves a new OccurrenceAppointment instance. This appointment is part of a recurring Appointment

Requires 'Start' permission for function TeamCalendar {C3F247FC-E417-49CB-81F0-823D1E835B68}

POST PlanCare2Api/TeamAppointments/TeamAppointments

Creates a new TeamAppointment instance

Requires 'Start' permission for function TeamCalendar {C3F247FC-E417-49CB-81F0-823D1E835B68}

Teams

Obtain Team information

At least one of these modules is required: Base

APIDescription
GET PlanCare2Api/Teams

Retrieve all teams

GET PlanCare2Api/Teams/Current

Retrieve all teams for the current user

Timesheets

Obtain and create timesheets

At least one of these modules is required: TimeRegistration

APIDescription
GET PlanCare2Api/Timesheets/{timesheetId}

Fetch Client/Organization timesheet by identifier

GET PlanCare2Api/Timesheets/DOTLocations?contractId={contractId}&productId={productId}&referenceDate={referenceDate}

Fetch possible locations for DBC GRZ contract

GET PlanCare2Api/Timesheets/FZ/{timesheetId}

Fetch FZ timesheet by identifier

Deprecated, please use the PlanCare2Api/Timesheets/{timesheetId} endpoint

GET PlanCare2Api/Timesheets/GRZ/{timesheetId}

Fetch GRZ timesheet by identifier

Deprecated, please use the PlanCare2Api/Timesheets/{timesheetId} endpoint

GET PlanCare2Api/Timesheets/NonClient/{timesheetId}

Fetch a NonClient timesheet instance

Deprecated, please use the PlanCare2Api/Timesheets/{timesheetId} endpoint

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

GET PlanCare2Api/Timesheets/Other/{timesheetId}

Fetch Client/Organization timesheet by identifier

Deprecated, please use the PlanCare2Api/Timesheets/{timesheetId} endpoint

GET PlanCare2Api/Timesheets/PCD/{timesheetId}

Retrieve a PCD timesheet

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

GET PlanCare2Api/Timesheets/PCDDBC/{timesheetId}

Retrieve a PCDDBC timesheet

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

GET PlanCare2Api/Timesheets/RealizedTimesheets?dateFrom={dateFrom}&dateUntil={dateUntil}&forCurrentEmployeeOnly={forCurrentEmployeeOnly}

Fetch realized timesheets within the given time period

GET PlanCare2Api/Timesheets/WLZ/{timesheetId}

Fetch WLZ timesheet by identifier

Deprecated, please use the PlanCare2Api/Timesheets/{timesheetId} endpoint

GET PlanCare2Api/Timesheets/WMO/{timesheetId}

Fetch WMO timesheet by identifier

Deprecated, please use the PlanCare2Api/Timesheets/{timesheetId} endpoint

POST PlanCare2Api/Timesheets

Saves a new timesheet instance

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

POST PlanCare2Api/Timesheets/Approval

Approve a timesheet

POST PlanCare2Api/Timesheets/ChangeOfTimesheets

Update an existing timesheet instance

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

POST PlanCare2Api/Timesheets/ChangeOfTimesheets/FZ

Updates an existing FZ timesheet instance

Deprecated, please use the PlanCare2Api/Timesheets/ChangeOfTimesheets endpoint

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

POST PlanCare2Api/Timesheets/ChangeOfTimesheets/GRZ

Updates an existing GRZ timesheet instance

Deprecated, please use the PlanCare2Api/Timesheets/ChangeOfTimesheets endpoint

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

POST PlanCare2Api/Timesheets/ChangeOfTimesheets/NonClient

Updates an existing NonClient timesheet instance

Deprecated, please use the PlanCare2Api/Timesheets/ChangeOfTimesheets endpoint

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

POST PlanCare2Api/Timesheets/ChangeOfTimesheets/Other

Updates an existing Client/Organization timesheet instance

Deprecated, please use the PlanCare2Api/Timesheets/ChangeOfTimesheets endpoint

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

POST PlanCare2Api/Timesheets/ChangeOfTimesheets/PCD

Updates an existing PCD timesheet instance

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

POST PlanCare2Api/Timesheets/ChangeOfTimesheets/PCDDBC

Updates an existing PCD-DBC timesheet instance

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

POST PlanCare2Api/Timesheets/ChangeOfTimesheets/WLZ

Updates an existing WLZ timesheet instance

Deprecated, please use the PlanCare2Api/Timesheets/ChangeOfTimesheets endpoint

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

POST PlanCare2Api/Timesheets/ChangeOfTimesheets/WMO

Updates an existing WMO timesheet instance

Deprecated, please use the PlanCare2Api/Timesheets/ChangeOfTimesheets endpoint

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

POST PlanCare2Api/Timesheets/DeleteOfTimesheet

Delete timesheet by identifier

POST PlanCare2Api/Timesheets/FZ

Saves a new FZ timesheet instance

Deprecated, please use the PlanCare2Api/Timesheets endpoint

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

POST PlanCare2Api/Timesheets/GRZ

Saves a new GRZ timesheet instance

Deprecated, please use the PlanCare2Api/Timesheets endpoint

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

POST PlanCare2Api/Timesheets/NonClient

Saves a new NonClient timesheet instance

Deprecated, please use the PlanCare2Api/Timesheets endpoint

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

POST PlanCare2Api/Timesheets/Other

Saves a new Client/Organization timesheet instance

Deprecated, please use the PlanCare2Api/Timesheets endpoint

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

POST PlanCare2Api/Timesheets/PCD

Saves a new PCD timesheet instance

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

POST PlanCare2Api/Timesheets/PCDDBC

Saves a new PCD-DBC timesheet instance

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

POST PlanCare2Api/Timesheets/WLZ

Saves a new WLZ timesheet instance

Deprecated, please use the PlanCare2Api/Timesheets endpoint

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

POST PlanCare2Api/Timesheets/WMO

Saves a new WMO timesheet instance

Deprecated, please use the PlanCare2Api/Timesheets endpoint

Requires 'Start' permission for function RegistrationOverview {2C05CECA-9B4D-4159-86C6-B39F4E167D86}

TransferAdvices

Obtain transfer advices

At least one of these modules is required: CareRegistration

APIDescription
DELETE PlanCare2Api/CareRegistration/TransferAdvices/{id}

Deletes a transfer advice instance and its lines

Requires 'Start' permission for function TransferAdviceOverview {EAD9BE2E-E6DF-4DC4-B018-D72876C3FB9C}

GET PlanCare2Api/CareRegistration/TransferAdvices?clientId={clientId}&includeImages={includeImages}

Gets the Transfer advices for the specified client

Requires 'Start' permission for function TransferAdviceOverview {EAD9BE2E-E6DF-4DC4-B018-D72876C3FB9C}

GET PlanCare2Api/CareRegistration/TransferAdvices?clientId={clientId}&from={from}&maxRecordCount={maxRecordCount}

Gets the transfer advice registrations of the specified client

Requires 'Start' permission for function TransferAdviceOverview {EAD9BE2E-E6DF-4DC4-B018-D72876C3FB9C}

GET PlanCare2Api/CareRegistration/TransferAdvices?bsn={bsn}&from={from}&maxRecordCount={maxRecordCount}

Gets the transfer advice registrations of the specified client

Requires 'Start' permission for function TransferAdviceOverview {EAD9BE2E-E6DF-4DC4-B018-D72876C3FB9C}

GET PlanCare2Api/CareRegistration/TransferAdvices/TransferAdviceLineImage?imageId={imageId}

Gets the Transfer advices line image

Requires 'Start' permission for function TransferAdviceOverview {EAD9BE2E-E6DF-4DC4-B018-D72876C3FB9C}

POST PlanCare2Api/CareRegistration/TransferAdvices

Saves a new transfer advice instance

Requires 'Start' permission for function TransferAdviceOverview {EAD9BE2E-E6DF-4DC4-B018-D72876C3FB9C}

POST PlanCare2Api/CareRegistration/TransferAdvices/ChangeOfTransferAdvices

Updates an existing transfer advice instance

Requires 'Start' permission for function TransferAdviceOverview {EAD9BE2E-E6DF-4DC4-B018-D72876C3FB9C}

TransferReports

Obtains transfer reports

At least one of these modules is required: GroupCalendar

APIDescription
DELETE PlanCare2Api/TransferReports/{id}

Deletes a transfer report

GET PlanCare2Api/TransferReports?fromDate={fromDate}&untilDate={untilDate}&groupcalendarId={groupcalendarId}

Gets the transfer reports

POST PlanCare2Api/TransferReports

Create a new transfer report

POST PlanCare2Api/TransferReports/ChangeOfTransferReport

Updates a transfer report

TubeFeeding

Obtain and create TubeFeeding registration

At least one of these modules is required: CareRegistration

APIDescription
DELETE PlanCare2Api/CareRegistration/TubeFeeding/{id}

Deletes a tube feeding instance

Requires 'Start' permission for function TubeFeedingOverview {79D687A3-2A56-4C47-AC57-43FAB41D3B5D}

GET PlanCare2Api/CareRegistration/TubeFeeding?clientId={clientId}&from={from}&maxRecordCount={maxRecordCount}

Gets the tube feeding registrations of the specified client

Requires 'Start' permission for function TubeFeedingOverview {79D687A3-2A56-4C47-AC57-43FAB41D3B5D}

GET PlanCare2Api/CareRegistration/TubeFeeding?bsn={bsn}&from={from}&maxRecordCount={maxRecordCount}

Gets the tube feeding registrations of the specified client

Requires 'Start' permission for function TubeFeedingOverview {79D687A3-2A56-4C47-AC57-43FAB41D3B5D}

POST PlanCare2Api/CareRegistration/TubeFeeding

Saves a new tube feeding registration

Requires 'Start' permission for function TubeFeedingOverview {79D687A3-2A56-4C47-AC57-43FAB41D3B5D}

POST PlanCare2Api/CareRegistration/TubeFeeding/ChangeOfTubeFeedings

Updates a tube feeding registration

Requires 'Start' permission for function TubeFeedingOverview {79D687A3-2A56-4C47-AC57-43FAB41D3B5D}

UrineResults

Obtain and create urine results registrations

At least one of these modules is required: CareRegistration

APIDescription
DELETE PlanCare2Api/CareRegistration/UrineResults/{id}

Deletes a urine result instance

Requires 'Start' permission for function UrineResultOverview {D18F70D5-D50C-4114-9754-8D305FBD1F32}

GET PlanCare2Api/CareRegistration/UrineResults?clientId={clientId}&from={from}&maxRecordCount={maxRecordCount}

Gets the urine result registrations of the specified client

Requires 'Start' permission for function UrineResultOverview {D18F70D5-D50C-4114-9754-8D305FBD1F32}

GET PlanCare2Api/CareRegistration/UrineResults?bsn={bsn}&from={from}&maxRecordCount={maxRecordCount}

Gets the urineResult registrations of the specified client

Requires 'Start' permission for function UrineResultOverview {D18F70D5-D50C-4114-9754-8D305FBD1F32}

POST PlanCare2Api/CareRegistration/UrineResults

Saves a new urine result instance

Requires 'Start' permission for function UrineResultOverview {D18F70D5-D50C-4114-9754-8D305FBD1F32}

POST PlanCare2Api/CareRegistration/UrineResults/ChangeOfUrineResults

Stores a urine result instance

Requires 'Start' permission for function UrineResultOverview {D18F70D5-D50C-4114-9754-8D305FBD1F32}

VisionModels

VisionModels

At least one of these modules is required: Base

APIDescription
GET PlanCare2Api/VisionModels?clientId={clientId}

Retrieve all visionmodels for the selected client.

At least one of these modules is required: ICP

GET PlanCare2Api/VisionModels/{visionModelId}/VisionModelItems

Retrieve all visionModelItems for the provided visionModel.

At least one of these modules is required: ICP

GET PlanCare2Api/VisionModels/{visionModelId}/VisionModelItems/{visionModelItemId}/MainGoals

Retrieve all maingoals for the provided visionModelItem.

At least one of these modules is required: ICP

GET PlanCare2Api/VisionModels/{visionModelId}/VisionModelItems/{visionModelItemId}/MainGoals/{mainGoalId}/GoalLibrary

Retrieve the goal library for the the provided mainGoal.

At least one of these modules is required: ICP

WebHookFilters

The allows the caller to get the list of filters with which a WebHook can be registered. This enables a client to provide a user experience indicating which filters can be used when registering a .

APIDescription
GET api/webhooks/filters

Gets all WebHook filters that a user can register with. The filters indicate which WebHook events that this WebHook will be notified for.

WebHookRegistrations

The allows the caller to create, modify, and manage WebHooks through a REST-style interface.

APIDescription
DELETE api/webhooks/registrations

Deletes all existing WebHook registrations.

DELETE api/webhooks/registrations/{id}

Deletes an existing WebHook registration.

GET api/webhooks/registrations

Gets all registered WebHooks for a given user.

GET api/webhooks/registrations/{id}

Looks up a registered WebHook with the given for a given user.

POST api/webhooks/registrations

Registers a new WebHook for a given user.

PUT api/webhooks/registrations/{id}

Updates an existing WebHook registration.

Workplans

Provides the ability to load workplans

At least one of these modules is required: ICP

APIDescription
GET PlanCare2Api/Workplans?clientId={clientId}

Retrieve all legacy workplans for the selected client. The current version workplans are available using the route /Clientplans/{clientplanId}/Workplans Also the details of workplans are available using the route /WorkplansV2/{workplanId}, /WorkplansV2/{workplanId}/appointments and /WorkplansV2/{workplanId}/evaluations

WorkplansV2

Provides the ability to load workplans V2

At least one of these modules is required: ICP

APIDescription
DELETE PlanCare2Api/WorkplansV2/{actionId}/Action

Delete an existing action from workplan V2.

Requires 'Start' permission for function WorkplanOverview {E5355268-B1D3-4447-B43B-B5DE20B8ADD8}

DELETE PlanCare2Api/WorkplansV2/{subGoalId}/SubGoal

Delete an existing sub goal from workplan V2.

Requires 'Start' permission for function WorkplanOverview {E5355268-B1D3-4447-B43B-B5DE20B8ADD8}

DELETE PlanCare2Api/WorkplansV2/{workplanId}

Delete an existing workplan V2.

Requires 'Start' permission for function WorkplanOverview {E5355268-B1D3-4447-B43B-B5DE20B8ADD8}

GET PlanCare2Api/WorkplansV2/{clientId}/Workplans

Retrieve all workplans V2 for client.

GET PlanCare2Api/WorkplansV2/{id}

Retrieve a workplan V2.

GET PlanCare2Api/WorkplansV2/{id}/appointments?dateFrom={dateFrom}&dateUntil={dateUntil}

Retrieve the appointments of a workplan V2.

GET PlanCare2Api/WorkplansV2/{id}/evaluations

Retrieve the evaluation information of a workplan V2.

POST PlanCare2Api/WorkplansV2

Create a new workplanV2.

Requires 'Start' permission for function WorkplanOverview {E5355268-B1D3-4447-B43B-B5DE20B8ADD8}

POST PlanCare2Api/WorkplansV2/{actionId}/ChangeOfAction

Update an action.

Requires 'Start' permission for function WorkplanOverview {E5355268-B1D3-4447-B43B-B5DE20B8ADD8}

POST PlanCare2Api/WorkplansV2/{subGoalId}/ChangeOfSubGoal

Update a subgoal.

Requires 'Start' permission for function WorkplanOverview {E5355268-B1D3-4447-B43B-B5DE20B8ADD8}

POST PlanCare2Api/WorkplansV2/{workplanId}/Action

Create a new ActionV2.

Requires 'Start' permission for function WorkplanOverview {E5355268-B1D3-4447-B43B-B5DE20B8ADD8}

POST PlanCare2Api/WorkplansV2/{workplanId}/SubGoal

Create a new workplanSubGoalV2.

Requires 'Start' permission for function WorkplanOverview {E5355268-B1D3-4447-B43B-B5DE20B8ADD8}