Nedap Ons API
The REST API for the Nedap Ons electronic health record suite used by Dutch care organisations. 926 operations across 782 paths covering clients, employees, dossiers and reports, care plans, goals and actions, medical notes, agenda and rostering, care allocation and orders, declarations, payroll and expenses, surveys and client stories — plus an openEHR composition and archetype surface, three FHIR R3 bundle-wrapper endpoints, and domain models written against the Dutch ZIBs, SNOMED CT and the Omaha System. Requests are authenticated with an SSL client certificate signed by Nedap's own Certificate Authority and bound to one connector and one customer environment.
This API exposes 926 operations across 782 paths, organized into 266 resource areas, and defines 790 schemas. It is described by OpenAPI 3.0.3, at version 0.0.0.
Requests are made against a single base URL, https://api-development.ons.io.
926 operations
782 paths
790 schemas
70 DELETE618 GET14 PATCH129 POST95 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 926
Across 782 paths, the API surfaces 926 operations — 70 DELETE, 618 GET, 14 PATCH, 129 POST, 95 PUT. They span 266 resource areas, including payroll.AccountEntry, payroll.AccountTypeExpireStatistic, payroll.AccountType, Address, admin.BackgroundImage, admin.License, admin.LogoImage, admin.TimesheetConfig, and 258 more. Each is listed below with its method, path, parameters, and response codes.
payroll.AccountEntry 7
GET
/v0/administration/account_entries/{id}
Return the Account Entry corresponding to the given id
GET
/v0/administration/account_entries/by_employee_and_type_in_period/{employee_id}
Retrieve all AccountEntry for an Employee for a specific AccountType in a period
GET
/v0/administration/account_entries/by_employee_and_type_till_date/{employee_id}
Retrieve the account entries up until the specified date for a specific employee and specified type
GET
/v0/administration/account_entries/by_employee_and_type/{employee_id}
Retrieve all AccountEntry for an Employee and a specific AccountType
GET
/v0/administration/account_entries/by_employee_in_period/{employee_id}
Retrieve all the AccountEntry for an Employee in a specified period
GET
/v0/administration/account_entries/by_employee_till_date/{employee_id}
Retrieve the account entries up until the specified date for a specific employee
GET
/v0/administration/account_entries/by_employee/{employee_id}
Retrieve all AccountEntry for an Employee
payroll.AccountTypeExpireStatistic 1
GET
/v0/administration/account_type_expire_statistics/by_employee_at_date/{employee_id}
Retrieve all the AccountTypeExpireStatistic for an Employee calculated at the given date
payroll.AccountType 2
GET
/v0/administration/account_types
Returns every AccountType available from the AccountTypeAPI
GET
/v0/administration/account_types/{id}
Return the AccountType corresponding to the given id
Address 7
GET
/v0/administration/addresses/{id}
Find address by id
GET
/v0/administration/careproviders/{care_provider_id}/addresses
Return the addresses of a CareProvider corresponding to the given id.
GET
/v0/administration/client_contact_relations/{relation_id}/addresses
Return the addresses of a ClientContactRelation corresponding to the given id.
GET
/v0/administration/clients/{client_id}/addresses
Return the addresses of a Client corresponding to the given id.
GET
/v0/administration/clients/{client_id}/primary_address
Return the address where the client currently resides.
GET
/v0/administration/employees/{employee_id}/addresses
Return the addresses of an Employee corresponding to the given id.
GET
/v0/administration/employees/{employee_id}/primary_address
Return the currently active main address of the employee corresponding to the given id.
admin.BackgroundImage 1
GET
/v0/administration/admin/background_image
Retrieves the BackgroundImage
admin.License 1
GET
/v0/administration/admin/licenses
Returns every License available from the LicenseAPI
admin.LogoImage 2
GET
/v0/administration/admin/logo_image
Retrieves the LogoImage
GET
/v0/administration/admin/logo_image/download
Download logo image.
admin.TimesheetConfig 2
GET
/v0/administration/admin/timesheetconfig
Retrieves the TimesheetConfig
PUT
/v0/administration/admin/timesheetconfig
Updates the given TimesheetConfig
admin.Version 1
GET
/v0/administration/admin/version
Retrieves the Version
Agbcode 3
GET
/v0/administration/agbcodes
Returns every Agbcode available from the AgbcodeAPI
GET
/v0/administration/agbcodes/{id}
Return the Agbcode corresponding to the given id
GET
/v0/administration/agbcodes/by_client_id/{id}/sorted
Return a list of sorted agbcodes, using the tree depth of the location of given person
arrangement.IntentPreference 5
POST
/v0/administration/arrangement/intent_preferences/add_intent_to_time_slot/{intent_uuid}
Adds an extra or first Intent to the TimeSlot.
GET
/v0/administration/arrangement/intent_preferences/for_client_in_period/{client_uuid}
Gets a list of IntentPreferences for the client in a period.
DELETE
/v0/administration/arrangement/intent_preferences/remove_intent_from_time_slot/{intent_uuid}
Removes an Intent from the TimeSlot.
POST
/v0/administration/arrangement/intent_preferences/set_intent_to_time_slots/{intent_uuid}
Ties an Intent to a list of TimeSlots, replacing all previous connections.
POST
/v0/administration/arrangement/intent_preferences/set_time_slot_to_intents/{time_slot_uuid}
Connects a TimeSlot to a list of Intents, replacing all, if any, previous connections.
arrangement.Intent 7
POST
/v0/administration/arrangement/intentsdeprecated
Create Intent
PUT
/v0/administration/arrangement/intents/{uuid}deprecated
Updates the given Intent
DELETE
/v0/administration/arrangement/intents/{uuid}deprecated
Deletes the Intent with given uuid
GET
/v0/administration/arrangement/intents/by_client_period_plannable/{client_id}
Gets all intents for a Client in a given period and whether they are plannable
GET
/v0/administration/arrangement/intents/by_employee/{employee_id}
Gets all intents for an Employee.
PUT
/v0/administration/arrangement/intents/by_timeline/{timeline_uuid}
Updates all intents for a timeline identified by a UUID
DELETE
/v0/administration/arrangement/intents/by_timeline/{timeline_uuid}
Deletes all intents for a timeline identified by a UUID
arrangement.Stakeholder 6
POST
/v0/administration/arrangement/stakeholders
Create Stakeholder
GET
/v0/administration/arrangement/stakeholders/{uuid}
Gets an Stakeholder by UUID
PUT
/v0/administration/arrangement/stakeholders/{uuid}
Updates the given Stakeholder
DELETE
/v0/administration/arrangement/stakeholders/{uuid}
Deletes the Stakeholder with given uuid
GET
/v0/administration/arrangement/stakeholders/by_intent/{intent_uuid}
Gets the Stakeholders which belong to an Intent
GET
/v0/administration/arrangement/stakeholders/by_timeline/{timeline_uuid}
Gets the Stakeholders which belong to a Timeline
arrangement.TimeSlot 7
POST
/v0/administration/arrangement/time_slots
Create TimeSlot
GET
/v0/administration/arrangement/time_slots/{uuid}
Gets a time slot by UUID.
PUT
/v0/administration/arrangement/time_slots/{uuid}
Updates the given TimeSlot
DELETE
/v0/administration/arrangement/time_slots/{uuid}
Deletes the TimeSlot with given uuid
GET
/v0/administration/arrangement/time_slots/all_for_client/{client_uuid}
Gets the time slots that have been specified for a client.
GET
/v0/administration/arrangement/time_slots/all_for_intent/{intent_uuid}
Gets the time slots for an intent, i.e.
GET
/v0/administration/arrangement/time_slots/generic_for_client/{client_uuid}
Gets all time slots that are generic to a client (have no connection to Intents (yet)).
expense.ExpenseAddressModel 3
GET
/v0/administration/authorized/employees/{employee_id}/expense_address
Returns the expense addresses of given employee
PUT
/v0/administration/authorized/employees/{employee_id}/expense_address
Update an expense address
DELETE
/v0/administration/authorized/employees/{employee_id}/expense_address/{expenseAddress_id}
Removes expense address
VehicleAssignmentModel 3
GET
/v0/administration/authorized/employees/{employee_id}/vehicle
Returns the vehicleAssignments corresponding of the given employeeid
PUT
/v0/administration/authorized/employees/{employee_id}/vehicle
Updates a specific vehicleAssignment for the given employeeid
DELETE
/v0/administration/authorized/employees/{employee_id}/vehicle/{vehicle_assignment_id}
deletes a specific vehicleAssignment for the given employeeid
Bsn 4
POST
/v0/administration/bsns
Create Bsn
GET
/v0/administration/bsns/{id}
Return the Bsn corresponding to the given id
GET
/v0/administration/clients/{client_id}/bsn
Return the bsn of a client corresponding to the given client id.
PUT
/v0/administration/clients/{client_id}/bsn
Updates the BSN of a client
capacity.CapacityProfile 3
GET
/v0/administration/capacity/capacity_profiles
Returns every CapacityProfile available from the CapacityProfileAPI
GET
/v0/administration/capacity/capacity_profiles/{id}
Return the Capacity Profile corresponding to the given id
GET
/v0/administration/capacity/capacity_profiles/all_active
Find a list of CapacityProfiles that are active on the given date.
CareProviderAddress 2
POST
/v0/administration/care_provider_addresses
Create CareProviderAddress
GET
/v0/administration/care_provider_addresses/{id}
Return the address of a Careprovider corresponding to the given id.
CareAllocation 7
POST
/v0/administration/careallocations
Create a CareAllocation
GET
/v0/administration/careallocations/{id}
Return the Care Allocation corresponding to the given id
PUT
/v0/administration/careallocations/{id}
Update the Care Allocation corresponding to the given id
GET
/v0/administration/clients/{client_id}/care_allocations
Return the care providers of a Client corresponding to the given id.
GET
/v0/xstream/care_allocations/data
Return all CareAllocation models in a streaming manner
GET
/v0/xstream/care_allocations/deletes
Return all CareAllocation models which where deleted since the date given in the request.
GET
/v0/xstream/care_allocations/updates
Return all CareAllocation models which where updated since the date given in the request.
CareProvider 8
POST
/v0/administration/careproviders
Create CareProvider
POST
/v0/administration/careproviders/{care_provider_id}/assign_to_client/{client_id}
Assigns an external care provider to a client.
DELETE
/v0/administration/careproviders/{care_provider_id}/unassign_from_client/{client_id}
Unassigns an external care provider from a client.
GET
/v0/administration/careproviders/{id}
Return the Care Provider corresponding to the given id
GET
/v0/administration/careproviders/category/{category_id}/{identification}
GET
/v0/administration/careproviders/identification/{identification}
Return the Care Provider corresponding to the given identification
GET
/v0/administration/careproviders/ura/{ura_number}
Return the Care Providers corresponding to the given URA number
GET
/v0/administration/clients/{client_id}/careproviders
Return the care providers of a Client corresponding to the given id.
ClientAddress 5
POST
/v0/administration/client_addresses
Create ClientAddress
GET
/v0/administration/client_addresses/{id}
Return the Client Address corresponding to the given id
PUT
/v0/administration/client_addresses/{id}
Update ClientAddress
GET
/v0/xstream/client_addresses/data
Return all ClientAddress models in a streaming manner
GET
/v0/xstream/client_addresses/updates
Return all ClientAddress models which where updated since the date given in the request.
ClientContactRelationAddress 4
POST
/v0/administration/client_contact_relation_addresses
Create ClientContactRelationAddress
GET
/v0/administration/client_contact_relation_addresses/{id}
Return the client contact Relation Address corresponding to the given id
GET
/v0/xstream/client_contact_relation_addresses/data
Return all ClientContactRelationAddress models in a streaming manner
GET
/v0/xstream/client_contact_relation_addresses/updates
Return all ClientContactRelationAddress models which where updated since the date given in the request.
ClientContactRelationType 2
GET
/v0/administration/client_contact_relation_types
Returns every ClientContactRelationType available from the ClientContactRelationTypeAPI
GET
/v0/administration/client_contact_relation_types/{id}
Returns the ClientContactRelationType corresponding to the given id
ClientContactRelation 9
GET
/v0/administration/client_contact_relations
Returns every ClientContactRelation available from the ClientContactRelationAPI
POST
/v0/administration/client_contact_relations
Create ClientContactRelation
GET
/v0/administration/client_contact_relations/{id}
Return the ClientContactRelation corresponding to the given id
PUT
/v0/administration/client_contact_relations/{id}
Updates the given ClientContactRelation
DELETE
/v0/administration/client_contact_relations/{id}
Deletes the ClientContactRelation with given id
GET
/v0/administration/client_contact_relations/by_client_ids
Return the client contact relations of multiple clients corresponding to the given ids.
GET
/v0/administration/client_contact_relations/by_client/{client_id}
Return the client contact relations of a client corresponding to the given id.
GET
/v0/xstream/relations/data
Return all ClientContactRelation models in a streaming manner
GET
/v0/xstream/relations/updates
Return all ClientContactRelation models which where updated since the date given in the request.
ClientEmployeeRelationType 2
GET
/v0/administration/client_employee_relation_types
Returns every ClientEmployeeRelationType available from the ClientEmployeeRelationTypeAPI
GET
/v0/administration/client_employee_relation_types/{id}
Returns the ClientEmployeeRelationType corresponding to the given id
ClientEmployeeRelation 6
POST
/v0/administration/client_employee_relations
Creates a ClientEmployeeRelation
GET
/v0/administration/client_employee_relations/{id}
Returns the ClientEmployeeRelation corresponding to the given id
PUT
/v0/administration/client_employee_relations/{id}
Updates the ClientEmployeeRelation corresponding to the given id
DELETE
/v0/administration/client_employee_relations/{id}
Deletes the ClientEmployeeRelation corresponding to the given id
GET
/v0/administration/clients/{client_id}/client_employee_relations
Return the ClientEmployeeRelations corresponding to the given client id
GET
/v0/administration/employees/{employee_id}/client_employee_relations
Return the ClientEmployeeRelations corresponding to the given employee id
ClientAbsenceReason 2
GET
/v0/administration/clientAbsenceReasons/{id}
Get the Client Absence Reason corresponding to the given id
GET
/v0/administration/clientAbsenceReasons/all
Returns every ClientAbsenceReason available from the ClientAbsenceReasonAPI
ClientAbsence 7
POST
/v0/administration/clientAbsences
Create ClientAbsence
GET
/v0/administration/clientAbsences/{id}
Get the Client Absence corresponding to the given id
PUT
/v0/administration/clientAbsences/{id}
Updates the given ClientAbsence
DELETE
/v0/administration/clientAbsences/{id}
Deletes the ClientAbsence with given id
GET
/v0/administration/clientAbsences/search_by_client
Return the client absences of a Client corresponding to the given id.
GET
/v0/administration/clientAbsences/search_by_client_and_type
Return the type-specific client absences for a Client corresponding to the provided clientid and Type corresponding to the provided typeid.
GET
/v0/xstream/client_absences/data
Return all ClientAbsences models in a streaming manner
Client 22
POST
/v0/administration/clients
Create Client
GET
/v0/administration/clients/{employee_id}/last_visited_clients
Returns the last visited clients of an employee based on presence logs.
GET
/v0/administration/clients/{id}
Find a client by their primary key
PUT
/v0/administration/clients/{id}
Update Client
GET
/v0/administration/clients/by_bsn
Find a client by its BSN number
GET
/v0/administration/clients/by_bsn/{bsn}deprecated
Find a client by its BSN number
GET
/v0/administration/clients/by_skn
Find a client by its SKN (strafrechtketennummer).
GET
/v0/administration/clients/by_uuid/{uuid}
Find a client by its UUID
GET
/v0/administration/clients/byIdentificationNumber/{identification_no}
Find a client based on it's identification number, a logical identifier
GET
/v0/administration/clients/finddeprecated
Results returned by this call are not grouped, i.e. This endpoint is deprecated, use: /omnisearch/client/search
GET
/v0/administration/clients/find_groupeddeprecated
Searches performed through this method are 'grouped' according to the groups defined in com.nedap.healthcare.domain.ClientSearchResultGroup, which value is set on the com.nedap.healthcare.domain.Clie…
GET
/v0/administration/clients/ids_in_care_in_period
Find clientObjectIds of all clients in care in a given period
GET
/v0/administration/clients/in_care_in_period
Find all clients in care in a given period
GET
/v0/administration/clients/multiple
Method used for requesting multiple Client objects using their ids.
GET
/v0/administration/clients/search_by_location
Find clients by location
GET
/v0/administration/users/{user_id}/last_visited_clients
Return the last visited Clients of a User corresponding to the given id.
POST
/v0/administration/users/{user_id}/last_visited_clients/{client_id}
Add or update client in favorite table
GET
/v0/omnisearch/client/search
Client Search via Omnisearch
GET
/v0/openehr_dossier/back_channel/unauthorized/clients/by_archetype_id/{archetype_id}
Returns the clients (but only the client ids) who have data for the given archetype in the given period.
GET
/v0/xstream/clients/data
Return all Client models in a streaming manner
GET
/v0/xstream/clients/deletes
Return all Client models which where deleted since the date given in the request.
GET
/v0/xstream/clients/updates
Return all Client models which where updated since the date given in the request.
ClientsInCare 2
GET
/v0/administration/clients_in_care
Return the clients in and out of care in a certain period
GET
/v0/administration/clients_in_care/old_methoddeprecated
The old way of invoicing.
BankAccount 3
GET
/v0/administration/clients/{client_id}/bank_account
Return the BankAccount of a client based on the clientId.
GET
/v0/xstream/bank_accounts/data
Return all BankAccount models in a streaming manner
GET
/v0/xstream/bank_accounts/updates
Return all BankAccount models which where updated since the date given in the request.
CareArrangement 3
GET
/v0/administration/clients/{client_id}/care_arrangements
Return the care arrangements of a Client corresponding to the given id.
GET
/v0/xstream/care_arrangements/data
Return all CareArrangement models in a streaming manner
GET
/v0/xstream/care_arrangements/updates
Return all CareArrangement models which where updated since the date given in the request.
ClientCard 1
GET
/v0/administration/clients/{client_id}/clipped_cards
Return the client cards of a Client corresponding to the given id.
Location 9
GET
/v0/administration/clients/{client_id}/clipped_locations
Return the locations of a Client corresponding to the given id.
GET
/v0/administration/clients/{client_id}/main_location
Returns the main location of the client
GET
/v0/administration/locations
Returns every Location available from the LocationAPI
POST
/v0/administration/locations
Create Location
GET
/v0/administration/locations/{id}
Return the Location corresponding to the given id
PUT
/v0/administration/locations/{id}
Update Location.
GET
/v0/administration/locations/multiple
Method used for requesting multiple Location objects using their ids.
GET
/v0/xstream/locations/data
Return all Location models in a streaming manner
GET
/v0/xstream/locations/updates
Return all Location models which where updated since the date given in the request.
nuts.Consent 2
GET
/v0/administration/clients/{client_id}/consents
Return the list of consent of a client corresponding to the given client id.
GET
/v0/administration/consents/{id}
Return the Consent corresponding to the given id
Debtor 5
GET
/v0/administration/clients/{client_id}/debtors
Return the debtors of a Client corresponding to the given id.
GET
/v0/administration/debtors
Return a DebtorList containing all Debtors available from the DebtorAPI.
GET
/v0/administration/debtors/{id}
Return the Debtor corresponding to the given id
GET
/v0/xstream/debtors/data
Return all Debtor models in a streaming manner
GET
/v0/xstream/debtors/updates
Return all Debtor models which where updated since the date given in the request.
Document 9
POST
/v0/administration/clients/{client_id}/documents
Create a document for a client. The maximum file size can vary between 10MB and 250MB, but is set to 40MB by default.
GET
/v0/administration/clients/{client_id}/documents/{doc_id}
Find the document corresponding to the given client and document id's.
GET
/v0/administration/clients/{client_id}/documents/{doc_id}/download
Returns a stream of bytes representing the document, be sure to close the stream when done.
GET
/v0/administration/clients/{client_id}/documents/all
Find all documents for a client.
GET
/v0/administration/clients/{client_id}/documents/all_archived_included
Find all active and archived documents.
PUT
/v0/administration/documents/{document_object_id}/status
Update the status of a document
GET
/v0/xstream/documents/data
Return all Document models in a streaming manner.
GET
/v0/xstream/documents/deletes
Return all Document models which where deleted since the date given in the request.
GET
/v0/xstream/documents/updates
Return all Document models which where updated since the date given in the request.
Employee 15
GET
/v0/administration/clients/{client_id}/finance_types/{finance_type_id}/coordinating_practitioner
Find the coordinating practitioner by client, finance type and date.
POST
/v0/administration/employees
Create Employee
GET
/v0/administration/employees/{employee_id}
Find employee by employee object id.
PUT
/v0/administration/employees/{employee_id}
Updates an employee
GET
/v0/administration/employees/{employee_id}/bank_account
Return the bank account assigned to the Employee corresponding to the given id
GET
/v0/administration/employees/by_email
Return the employees with the given emailaddress.
GET
/v0/administration/employees/by_identification_no/{identification_no}
Return the Employee corresponding to the given identification number.
GET
/v0/administration/employees/by_uuid/{uuid}
Return the Employee corresponding to the given uuid.
GET
/v0/administration/employees/find
Search for employees
GET
/v0/administration/employees/multiple
Method used for requesting multiple Employee objects using their ids.
GET
/v0/administration/employees/search_by_team
Return the Employees who are a member of team corresponding to the given id.
GET
/v0/administration/users/{user_id}/last_visited_employees
Return the last visited Employees of a User corresponding to the given id.
GET
/v0/xstream/employees/data
Return all Employee models in a streaming manner
GET
/v0/xstream/employees/deletes
Return all Employee models which where deleted since the date given in the request.
GET
/v0/xstream/employees/updates
Return all Employee models which where updated since the date given in the request.
Insurance 5
GET
/v0/administration/clients/{client_id}/insurances
Return the insurances of a Client corresponding to the given id.
POST
/v0/administration/insurances
Create an Insurance for a Client.
GET
/v0/administration/insurances/{id}
Return the Insurance corresponding to the given id
GET
/v0/xstream/insurances/data
Return all Insurance models in a streaming manner
GET
/v0/xstream/insurances/updates
Return all Insurance models which where updated since the date given in the request.
LocationAssignment 8
GET
/v0/administration/clients/{client_id}/locations
Return the location assignments of a Client corresponding to the given id.
GET
/v0/administration/clients/{client_id}/main_location_assignment
Returns the main location assignment of the client
POST
/v0/administration/location_assignments
Create LocationAssignment
GET
/v0/administration/location_assignments/{id}
Return the Location Assignment corresponding to the given id
PUT
/v0/administration/location_assignments/{id}
Updates the given LocationAssignment
DELETE
/v0/administration/location_assignments/{id}
Deletes the LocationAssignment with given id
GET
/v0/xstream/location_assignments/data
Return all LocationAssignment models in a streaming manner
GET
/v0/xstream/location_assignments/updates
Return all LocationAssignment models which where updated since the date given in the request.
PresenceLog 6
GET
/v0/administration/clients/{client_id}/presence_logs
Return the presence logs of a Client corresponding to the given id.
GET
/v0/administration/employees/{employee_id}/presence_logs
Return the presence logs of a Employee corresponding to the given id.
GET
/v0/administration/finance/care_orders/{care_order_id}/presence_logs
Return the PresenceLogs of a CareOrder corresponding to the given id.
GET
/v0/administration/presence/presence_logs/{id}
Return Presence Log corresponding to the given id
GET
/v0/administration/presence/presence_logs/with_care_order/{presence_log_object_id}
GET
/v0/agenda/agenda_occurrences/{agenda_occurrence_id}/presence_logs
Return the PresenceLogs of a AgendaOccurrence corresponding to the given id.
LocationAssignmentWaitingList 4
GET
/v0/administration/clients/{client_id}/waiting_list_locations
Return the waiting list location assignments of a Client corresponding to the given id.
POST
/v0/administration/location_assignment_waiting_lists
Create LocationAssignmentWaitingList
GET
/v0/administration/location_assignment_waiting_lists/{id}
PUT
/v0/administration/location_assignment_waiting_lists/{id}
Updates the given LocationAssignmentWaitingList
payroll.CollectiveAgreementAssignment 6
POST
/v0/administration/collective_agreement_assignments
Create the provided collective agreement assignment and assign it to the employee corresponding to the provided id
GET
/v0/administration/collective_agreement_assignments/{id}
Returns the collective agreement assignment corresponding to the given id
PUT
/v0/administration/collective_agreement_assignments/{id}
Update the provided collective agreement assignment
DELETE
/v0/administration/collective_agreement_assignments/{id}
Remove the collective agreement assignment corresponding to the given id
GET
/v0/administration/collective_agreement_assignments/by_employee_id/{employee_id}
Return the collective agreement assignments of an Employee corresponding to the given id.
DELETE
/v0/administration/collective_agreement_assignments/by_employee_id/{employee_id}
Remove all collective agreement assignments for the employee corresponding to the given id
payroll.CollectiveAgreementRule 2
GET
/v0/administration/collective_agreement_rules/{id}
GET
/v0/administration/collective_agreement_rules/by_collective_agreement_id/{collective_agreement_id}
Return the CollectiveAgreementRules of an employee corresponding to the given id.
payroll.CollectiveAgreement 2
GET
/v0/administration/collective_agreements
Returns every CollectiveAgreement available
GET
/v0/administration/collective_agreements/{id}
payroll.ContractType 2
GET
/v0/administration/contract_types/{id}
Return the Contract Type corresponding to the given id
GET
/v0/xstream/contract_types/data
Return all ContractType models in a streaming manner
payroll.Contract 6
POST
/v0/administration/contracts
Create a new Contract
GET
/v0/administration/contracts/{id}
Return the Contract corresponding to the given id
PUT
/v0/administration/contracts/{id}
Update an existing Contract
GET
/v0/administration/employees/{employee_id}/contracts
Return the contracts of an Employee corresponding to the given id.
GET
/v0/xstream/contracts/data
Return all Contract models in a streaming manner
GET
/v0/xstream/contracts/updates
Return all Contract models which where updated since the date given in the request.
CostCenterSelectionOption 1
GET
/v0/administration/cost_centers/costCenterSelectionOptions
Returns every CostCenterSelectionOption for the selection from the CostCenterSelectionOptionAPI
DashboardProfile 1
GET
/v0/administration/dashboard_profiles
Return all dashboard profiles
dbc.DBCSubTraject 3
GET
/v0/administration/dbc/dbc_sub_trajects/{id}
Return the specific dbcsubtraject as specified by the id
GET
/v0/administration/dbc/dbc_sub_trajects/in_period
Return all dbc subtrajects that have been active at any time in the requested period
GET
/v0/administration/dbc/dbc_trajects/{dbc_traject_id}/dbc_sub_trajects
Return the DBCSubTrajects of a DBCTraject corresponding to the given id.
dbc.DBCTraject 2
GET
/v0/administration/dbc/dbc_trajects/{id}
Return the specific dbctraject as specified by the id
GET
/v0/administration/dbc/dbc_trajects/by_client/{client_id}
Return the dbc trajects of a Client corresponding to the given id.
dossier.ActionEntry 4
POST
/v0/administration/dossier/action_entries
Create ActionEntry
PUT
/v0/administration/dossier/action_entries/{id}
Updates the given ActionEntry
DELETE
/v0/administration/dossier/action_entries/{id}
Deletes the ActionEntry with given id
GET
/v0/administration/dossier/care_plan_entries/{care_plan_entry_id}/action_entries
Return the ActionEntries of a CarePlanEntry corresponding to the given id.
dossier.Action 8
POST
/v0/administration/dossier/actions
Create Action
GET
/v0/administration/dossier/actions/{id}
Get a resource by its ID
PUT
/v0/administration/dossier/actions/{id}
Updates the given Action
DELETE
/v0/administration/dossier/actions/{id}
Deletes the Action with given id
GET
/v0/administration/dossier/actions/multiple
Method used for requesting multiple Action objects using their ids.
GET
/v0/administration/dossier/actions/search
Returns the Actions which meet the search criteria.
GET
/v0/administration/dossier/domains/{domain_id}/actions
Return the Actions of a Domain corresponding to the given id.
GET
/v0/administration/dossier/goals/{goal_id}/actions
Return the Actions of a Goal corresponding to the given id.
dossier.CarePlanEntry 6
POST
/v0/administration/dossier/care_plan_entries
Create CarePlanEntry
GET
/v0/administration/dossier/care_plan_entries/{id}
Get a resource by its ID
PUT
/v0/administration/dossier/care_plan_entries/{id}
Updates the given CarePlanEntry
DELETE
/v0/administration/dossier/care_plan_entries/{id}
Deletes the CarePlanEntry with given id
POST
/v0/administration/dossier/care_plan_entries/createdeprecated
Create a Care Plan Entry
GET
/v0/administration/dossier/care_plans/{care_plan_id}/entries
Return the CarePlanEntries of a CarePlan corresponding to the given id.
dossier.CarePlanReportRight 1
GET
/v0/administration/dossier/care_plan_report_rights/last_report
Return the care plan report rights of the most recent report created by the given employee and for the given client.
dossier.CarePlan 10
POST
/v0/administration/dossier/care_plans
Create CarePlan
GET
/v0/administration/dossier/care_plans/{id}
Get the CarePlan corresponding to the given id
PUT
/v0/administration/dossier/care_plans/{id}
Updates the given CarePlan
DELETE
/v0/administration/dossier/care_plans/{id}
Deletes the CarePlan with given id
POST
/v0/administration/dossier/care_plans/{id}/activate
Activate care plan
POST
/v0/administration/dossier/care_plans/{id}/archive
Archive care plan
GET
/v0/administration/dossier/care_plans/by_client/{client_id}
Return the care plans of a Client corresponding to the given id.
GET
/v0/administration/dossier/care_plans/by_client/{client_id}/active
Return the active care plan of a client corresponding to the given client id.
GET
/v0/administration/dossier/care_plans/by_client/{client_id}/draft
Return the draft care plan of a client corresponding to the given client id.
POST
/v0/administration/dossier/care_plans/by_client/{client_id}/new
Draft new care plan for client
dossier.ClientNote 6
GET
/v0/administration/dossier/client_notes
Returns every ClientNote available from the ClientNote API
POST
/v0/administration/dossier/client_notes
Create ClientNote
GET
/v0/administration/dossier/client_notes/{id}
PUT
/v0/administration/dossier/client_notes/{id}
Updates the given ClientNote
DELETE
/v0/administration/dossier/client_notes/{id}
Deletes the ClientNote with given id
GET
/v0/administration/dossier/client_notes/by_client/{client_id}
Return the client notes of a Client corresponding to the given id.
dossier.DemandEntry 2
POST
/v0/administration/dossier/demand_entries
Create DemandEntry
DELETE
/v0/administration/dossier/demand_entries/{id}
Deletes the DemandEntry with given id
dossier.Demand 6
POST
/v0/administration/dossier/demands
Create Demand
GET
/v0/administration/dossier/demands/{id}
Get a resource by its ID
PUT
/v0/administration/dossier/demands/{id}
Updates the given Demand
DELETE
/v0/administration/dossier/demands/{id}
Deletes the Demand with given id
GET
/v0/administration/dossier/demands/multiple
Method used for requesting multiple Demand objects using their ids.
GET
/v0/administration/dossier/domains/{domain_id}/demands
Return the Demands of a Domain corresponding to the given id.
dossier.Goal 8
GET
/v0/administration/dossier/demands/{demand_id}/goals
Return the Goals of a Demand corresponding to the given id.
GET
/v0/administration/dossier/domains/{domain_id}/goals
Return the Goals of a Domain corresponding to the given id.
POST
/v0/administration/dossier/goals
Create Goal
GET
/v0/administration/dossier/goals/{id}
Get a resource by its ID
PUT
/v0/administration/dossier/goals/{id}
Updates the given Goal
DELETE
/v0/administration/dossier/goals/{id}
Deletes the Goal with given id
GET
/v0/administration/dossier/goals/multiple
Method used for requesting multiple Goal objects using their ids.
GET
/v0/administration/dossier/goals/search
Returns the Goals which meet the search criteria.
dossier.Domain 5
GET
/v0/administration/dossier/domains
Returns every Domain available from the DomainAPI
POST
/v0/administration/dossier/domains
Create Domain
GET
/v0/administration/dossier/domains/{id}
Get a resource by its ID
PUT
/v0/administration/dossier/domains/{id}
Updates the given Domain
GET
/v0/administration/dossier/domains/multiple
Method used for requesting multiple Domain objects using their ids.
dossier.GoalEntry 4
POST
/v0/administration/dossier/goal_entries
Create GoalEntry
GET
/v0/administration/dossier/goal_entries/{id}
Get a resource by its ID
PUT
/v0/administration/dossier/goal_entries/{id}
Updates the given GoalEntry
DELETE
/v0/administration/dossier/goal_entries/{id}
Deletes the GoalEntry with given id
dossier.MedicalNote 7
GET
/v0/administration/dossier/medical_notes
Returns every MedicalNote available from the MedicalNoteAPI
POST
/v0/administration/dossier/medical_notes
Create MedicalNote
GET
/v0/administration/dossier/medical_notes/{id}
PUT
/v0/administration/dossier/medical_notes/{id}
Updates the given MedicalNote
DELETE
/v0/administration/dossier/medical_notes/{id}
Deletes the MedicalNote with given id
GET
/v0/administration/dossier/medical_notes/by_client/{client_id}
Return the active medical notes of a Client corresponding to the given id.
GET
/v0/administration/dossier/medical_notes/unfiltered_by_client/{client_id}
Return all the medical notes (including archived) of a Client corresponding to the given id.
dossier.ReportType 3
GET
/v0/administration/dossier/report_types
Returns every ReportType available from the ReportTypeAPI
GET
/v0/administration/dossier/report_types/{id}
PUT
/v0/administration/dossier/report_types/{id}
Updates the given ReportType
dossier.Report 28
POST
/v0/administration/dossier/reports
Create Report
GET
/v0/administration/dossier/reports/{id}
Return the Report corresponding to the given id
PUT
/v0/administration/dossier/reports/{id}
Updates the given Report
DELETE
/v0/administration/dossier/reports/{id}
Deletes the Report with given id
GET
/v0/administration/dossier/reports/{report_id}/children
Returns all the reactions for a given report
GET
/v0/administration/dossier/reports/by_care_plan_entry_unescaped/{care_plan_entry_id}
Returns all reports filtered by care plan entry without applying HTML esaping.
GET
/v0/administration/dossier/reports/by_care_plan_entry/{care_plan_entry_id}
Returns all reports filtered by care plan entry with HTML escaping applied to text fields.
GET
/v0/administration/dossier/reports/by_date/{valid_from}...{valid_to}
Returns all reports filtered by date.
GET
/v0/administration/dossier/reports/by_demand/{demand_id}
Returns all reports filtered by demand id.
GET
/v0/administration/dossier/reports/by_episode/{episode_id}
Returns all reports filtered by episode id.
GET
/v0/administration/dossier/reports/by_report_link/{report_link_id}
Returns all reports filtered by report link id.
GET
/v0/administration/dossier/reports/by_restrictive_measure/{restrictive_measure_id}
Returns all reports filtered by restrictive measures id.
GET
/v0/administration/dossier/reports/by_uuid/{uuid}
Return the Report corresponding to the given uuid
GET
/v0/administration/dossier/reports/last_report_authorizations
Return the child Reports of a Report corresponding to the given id.
GET
/v0/administration/dossier/reports/search_by_client
Searches for Reports for the Client (corresponding to the given id)
POST
/v0/administration/dossier/reports/soap/report
Create a SOAP report where each soap-part (optionally) has it's own authorization To make use of the per-soap-part authorization model make sure to fill each of the S-O-A-P parts of a SOAP report and…
PUT
/v0/administration/dossier/reports/soap/report/{id}
Updates a SOAP report where each soap-part (optionally) has it's own authorization To make use of the per-soap-part authorization model make sure to fill each of the S-O-A-P parts of a SOAP report an…
POST
/v0/dossier/back_channel/authorized/clients/{client_id}/reports
Create Report. Authorization is done in dossier controller this points to.
PUT
/v0/dossier/back_channel/authorized/clients/{client_id}/reports/{report_id}
Update Report. Authorization is done in dossier controller this points to.
GET
/v0/dossier/back_channel/authorized/clients/{client_id}/reports/search_by_client
Return Reports, filtered by params Authorization is done in dossier controller this points to.
GET
/v0/dossier/back_channel/authorized/clients/{client_id}/reports/search_by_client_with_updated_since
Return Reports with updated since option, filtered by params Authorization is done in dossier controller this points to.
GET
/v0/dossier/back_channel/authorized/clients/{client_id}/reports/vital_signs_reports
Lists vital signs from reports
GET
/v0/dossier/back_channel/authorized/reports/with_actions
Return reports that have actions created by user or for user's expertise
GET
/v0/dossier/back_channel/authorized/reports/with_actions_summary
Return a count of reports that have actions created by user or for user's expertise
GET
/v0/dossier/back_channel/unauthorized/clients/{client_id}/reports/unfiltered_search_by_client
Return Reports Unfiltered, filtered by params Authorization is done in dossier controller this points to.
GET
/v0/dossier/back_channel/unauthorized/reports/by_next_dossier_report_link/{report_link_id}
Returns report by next dossier report link
GET
/v0/xstream/reports/data
Return all Report models in a streaming manner
GET
/v0/xstream/reports/updates
Return all Report models which were updated since the date given in the request
dossier.SystemNote 5
GET
/v0/administration/dossier/system_notes
Returns every SystemNote available from the SystemNoteAPI
POST
/v0/administration/dossier/system_notes
Create SystemNote
GET
/v0/administration/dossier/system_notes/{id}
PUT
/v0/administration/dossier/system_notes/{id}
Updates the given SystemNote
DELETE
/v0/administration/dossier/system_notes/{id}
Deletes the SystemNote with given id
EmployeeAddress 4
POST
/v0/administration/employee_addresses
Create EmployeeAddress
GET
/v0/administration/employee_addresses/{id}
Return the Employee Address corresponding to the given
GET
/v0/xstream/employee_addresses/data
Return all EmployeeAddress models in a streaming manner
GET
/v0/xstream/employee_addresses/updates
Return all EmployeeAddress models which where updated since the date given in the request.
EmployeeWorkflow 2
PUT
/v0/administration/employee_workflows/{employee_id}/timesheet_submit_date
PUT
/v0/administration/employee_workflows/{employee_id}/timesheet_submit_date_authorized
PractitionerAgbCode 5
GET
/v0/administration/employees/{employee_id}/agb_codes
Return the AGB codes assigned to the employee corresponding to the provided id
POST
/v0/administration/employees/{employee_id}/agb_codes
Creates the provided AGB code and assigns it to the employee corresponding to the provided id
GET
/v0/administration/employees/{employee_id}/agb_codes/{agb_code_id}
Return the AGB code with the provided id assigned to the employee corresponding to the provided id
PUT
/v0/administration/employees/{employee_id}/agb_codes/{agb_code_id}
Updates the provided AGB code assigned to the employee corresponding to the provided id
DELETE
/v0/administration/employees/{employee_id}/agb_codes/{agb_code_id}
Deletes the AGB code with the provided id assigned to the employee corresponding to the provided id
PractitionerBigCode 5
GET
/v0/administration/employees/{employee_id}/big_codes
Return the BIG codes assigned to the employee corresponding to the provided id
POST
/v0/administration/employees/{employee_id}/big_codes
Creates the provided BIG code and assigns it to the employee corresponding to the provided id
GET
/v0/administration/employees/{employee_id}/big_codes/{big_code_id}
Return the BIG code with the provided id assigned to the employee corresponding to the provided id
PUT
/v0/administration/employees/{employee_id}/big_codes/{big_code_id}
Updates the provided BIG code assigned to the employee corresponding to the provided id
DELETE
/v0/administration/employees/{employee_id}/big_codes/{big_code_id}
Deletes the BIG code with the provided id assigned to the employee corresponding to the provided id
Team 11
GET
/v0/administration/employees/{employee_id}/clipped_teams
Return the teams of a Employee corresponding to the given id between 2 dates.
GET
/v0/administration/teams
Return all teams
GET
/v0/administration/teams/{id}
Return the Team corresponding to the given id
GET
/v0/administration/teams/by_code/{code}
Return the code of a Team corresponding to the given id.
GET
/v0/administration/teams/multiple
Method used for requesting multiple Team objects using their ids.
GET
/v0/administration/users/{user_id}/last_visited_teams
Return the last visited Teams of a User corresponding to the given id.
GET
/v0/administration/users/{user_id}/scoped_teamsdeprecated
Return the scoped Teams of a User corresponding to the given id.
GET
/v0/agenda/teams
Check whether agenda is enabled
GET
/v0/xstream/teams/data
Return all Team models in a streaming manner
GET
/v0/xstream/teams/deletes
Return all Team models which where deleted since the date given in the request.
GET
/v0/xstream/teams/updates
Return all Team models which where updated since the date given in the request.
ExpertiseProfileAssignment 9
GET
/v0/administration/employees/{employee_id}/expertise_profile_assignments
Return the expertise profile assignments of a Employee corresponding to the given id.
POST
/v0/administration/expertise_profile_assignments
Create new expertise profile assignment for the Employee corresponding to the given employeeid.
GET
/v0/administration/expertise_profile_assignments/{id}
Return the expertise profile assignment corresponding to the given id.
PUT
/v0/administration/expertise_profile_assignments/{id}
Update the expertise profile assignment corresponding to the given id.
DELETE
/v0/administration/expertise_profile_assignments/{id}
Deletes the expertise profile assignment corresponding to the given id.
GET
/v0/administration/expertise_profile_assignments/by_employee_ids
Return all the expertise profile assignments for a list of employees.
GET
/v0/administration/expertise_profile_assignments/multiple
Method used for requesting multiple ExpertiseProfileAssignment objects using their ids.
GET
/v0/xstream/expertise_profile_assignments/data
Return all ExpertiseProfileAssignment models in a streaming manner
GET
/v0/xstream/expertise_profile_assignments/updates
Return all ExpertiseProfileAssignment models which where updated since the date given in the request.
ExpertiseProfile 6
GET
/v0/administration/employees/{employee_id}/expertise_profiles
Return the expertise profiles of a Employee corresponding to the given id between the given dates.
GET
/v0/administration/expertise_profiles
Returns every ExpertiseProfile available from the ExpertiseProfileAPI
GET
/v0/administration/expertise_profiles/{id}
Return the Expertise Profile corresponding to the given id
GET
/v0/administration/expertise_profiles/multiple
Method used for requesting multiple ExpertiseProfile objects using their ids.
GET
/v0/xstream/educations/data
Return all ExpertiseProfile models in a streaming manner
GET
/v0/xstream/educations/updates
Return all ExpertiseProfile models which where updated since the date given in the request.
EmployeePrivacySettings 1
PUT
/v0/administration/employees/{employee_id}/privacy_settings
Update the employee privacy settings corresponding to the given id.
PractitionerProfession 5
GET
/v0/administration/employees/{employee_id}/professions
Return the professions assigned to the employee corresponding to the provided id
POST
/v0/administration/employees/{employee_id}/professions
Creates the provided profession and assigns it to the employee corresponding to the provided id
GET
/v0/administration/employees/{employee_id}/professions/{profession_id}
Return the profession with the provided id assigned to the employee corresponding to the provided id
PUT
/v0/administration/employees/{employee_id}/professions/{profession_id}
Updates the provided profession assigned to the employee corresponding to the provided id
DELETE
/v0/administration/employees/{employee_id}/professions/{profession_id}
Deletes the profession with the provided id assigned to the employee corresponding to the provided id
TeamAssignment 9
GET
/v0/administration/employees/{employee_id}/teams
Return the team assignments of a Employee corresponding to the given id.
POST
/v0/administration/employees/{employee_id}/teams
Create the provided team assignment and assign it to the employee corresponding to the provided id.
GET
/v0/administration/employees/{employee_id}/teams/{team_assignment_id}
Update the team assignment with the provided id assigned to the employee corresponding to the provided id.
PUT
/v0/administration/employees/{employee_id}/teams/{team_assignment_id}
Update the team assignment with the provided id assigned to the employee corresponding to the provided id.
DELETE
/v0/administration/employees/{employee_id}/teams/{team_assignment_id}
Remove the team assignment with the provided id assigned to the employee corresponding to the provided id.
GET
/v0/administration/team_assignments/{id}
Return the team assignment with the given id.
GET
/v0/xstream/team_assignments/data
Return all TeamAssignment models in a streaming manner
GET
/v0/xstream/team_assignments/deletes
Return all TeamAssignment models which where deleted since the date given in the request.
GET
/v0/xstream/team_assignments/updates
Return all TeamAssignment models which where updated since the date given in the request.
WeeksheetProfile 4
GET
/v0/administration/employees/{employee_id}/weeksheet_profile
Return the weeksheet profile of a employee corresponding to the given employee id.
DELETE
/v0/administration/employees/{employee_id}/weeksheet_profile
Delete the weeksheet profile of a employee corresponding to the given employee id.
PUT
/v0/administration/employees/{employee_id}/weeksheet_profile/{weeksheet_profile_id}
Update the weeksheet profile of an employee corresponding to the given employee id and weeksheet profile id
GET
/v0/administration/weeksheet_profiles
Return all weeksheet profiles
ProfileActivityAssignment 7
GET
/v0/administration/employees/{employee_id}/weeksheet_profile/direct_profile_activity_assignments
Return the direct profile activity assignments of an Employee corresponding to the given id.
GET
/v0/administration/employees/{employee_id}/weeksheet_profile/indirect_duration_profile_activity_assignments
Return the indirect duration profile activity assignments of an Employee corresponding to the given id.
GET
/v0/administration/employees/{employee_id}/weeksheet_profile/indirect_profile_activity_assignments
Return the indirect profile activity assignments of an Employee corresponding to the given id.
GET
/v0/administration/weeksheet_profiles/{weeksheet_profile_id}/direct_profile_activity_assignments
Return the direct profile activity assignments of an WeeksheetProfile corresponding to the given id.
GET
/v0/administration/weeksheet_profiles/{weeksheet_profile_id}/expense_profile_activity_assignments
Return the indirect duration profile activity assignments of an WeeksheetProfile corresponding to the given id.
GET
/v0/administration/weeksheet_profiles/{weeksheet_profile_id}/indirect_duration_profile_activity_assignments
Return the indirect duration profile activity assignments of an WeeksheetProfile corresponding to the given id.
GET
/v0/administration/weeksheet_profiles/{weeksheet_profile_id}/indirect_profile_activity_assignments
Return the indirect profile activity assignments of an WeeksheetProfile corresponding to the given id.
ons_administration.WorkdayNormSettingsModel 7
GET
/v0/administration/employees/{employee_object_id}/workday_norms
Returns all workday norms settings for the given employee. Does NOT include any default settings.
POST
/v0/administration/employees/{employee_object_id}/workday_norms
Creates a new workday norm settings for the given employee.
GET
/v0/administration/employees/{employee_object_id}/workday_norms/{settings_object_id}
Returns the specified workday norm settings for the given employee.
PUT
/v0/administration/employees/{employee_object_id}/workday_norms/{settings_object_id}
Updates the specified workday norm settings for the given employee.
DELETE
/v0/administration/employees/{employee_object_id}/workday_norms/{settings_object_id}
Deletes the specified workday norm settings for the given employee.
GET
/v0/administration/employees/workday_norms
Returns the current and future workday norms settings for the given employees. This MAY include default settings when no specific settings exist.
GET
/v0/administration/employees/workday_norms/from
Returns the workday norm settings for the given employees that were valid from a certain date. This MAY include default settings when no specific settings exist.
ons_administration.ExtendedEmployeeModel 1
PUT
/v0/administration/employees/extended/snapshot
Create or update an employee snapshot
ons_administration.TimeCompensationFactorModel 1
GET
/v0/administration/employees/time_compensation_factors
Returns the time compensation factor (minimum wage divided by hourly wage) for the given GHZ employees, if they have enabled time compensation via the CLA assignment setting. The default setting can…
ons_administration.WorkdayNormPeriodModel 1
GET
/v0/administration/employees/workday_norms/current
Returns the workday norm periods for the given employees. Includes the default norm agreement.
ons_administration.EmployeeWorkdaysOverviewModel 1
GET
/v0/administration/employees/workday_norms/workdays
Returns the workdays for the given employees according to the workday norm clause count.
evs.ResponseMessage 1
PUT
/v0/administration/evs/response_message
Send a response of an earlier sent message from FVC back to OA
evs.EvsAbility 1
GET
/v0/administration/evsabilities/{action}
expense.ExpenseType 2
GET
/v0/administration/expense_types
Returns every ExpenseType available from the ExpenseTypeAPI
GET
/v0/administration/expense_types/{id}
Return the Expense Type corresponding to the given id
expense.Expense 7
POST
/v0/administration/expenses
Create Expense
GET
/v0/administration/expenses/{id}
Return the Expense corresponding to the given id
PUT
/v0/administration/expenses/{id}
Updates the given Expense
DELETE
/v0/administration/expenses/{id}
Deletes the Expense with given id
GET
/v0/administration/expenses/employees/{employee_id}
Retrieve all expenses for the employee corresponding to the given employee id.
PUT
/v0/administration/expenses/expensedistance/{expense_distance_id}
Updates an expense distance position with a new position value
POST
/v0/administration/expenses/preview
Used to get created Expense Route Without saving the expense
ExpertiseGroup 5
GET
/v0/administration/expertise_groups
Returns every ExpertiseGroup available from the ExpertiseGroupAPI
GET
/v0/administration/expertise_groups/{id}
Returns the ExpertiseGroup corresponding to the given id
GET
/v0/administration/expertise_groups/multiple
Method used for requesting multiple ExpertiseGroup objects using their ids.
GET
/v0/xstream/expertise_groups/data
Return all ExpertiseGroup models in a streaming manner
GET
/v0/xstream/expertise_groups/updates
Return all ExpertiseGroup models which where updated since the date given in the request.
HourType 4
GET
/v0/administration/expertise_profiles/{expertise_profiles_id}/hour_types
Return the hour type of a ExpertiseProfiles corresponding to the given id.
GET
/v0/administration/hour_types
Returns every HourType available from the HourTypeAPI
GET
/v0/administration/hour_types/{id}
Get the Hour Type corresponding to the given id
GET
/v0/administration/hour_types/multiple
Method used for requesting multiple HourType objects using their ids.
export.ExportPresenceLog 3
GET
/v0/administration/export/export_presence_logs/collect
Collects the Export Presence Logs
GET
/v0/administration/export/export_presence_logs/result/{uuid}
Return the results of the Export Presence Log corresponding to the given uuid
GET
/v0/administration/export/export_presence_logs/status/{uuid}
Return the status of the Export Presence Log corresponding to the given uuid
finance.GroupActivitySuggestionModel 2
GET
/v0/administration/finance/activity_suggestions
Get all group activities
GET
/v0/administration/finance/activity_suggestions/{group_activity_object_id}
Get activities for a group activity and clients at a given date
finance.CareOrderProduct 7
POST
/v0/administration/finance/care_order_products
Create CareOrderProduct
GET
/v0/administration/finance/care_order_products/{id}
Return the CareOrderProduct corresponding to the given id
PUT
/v0/administration/finance/care_order_products/{id}
Updates the given CareOrderProduct
DELETE
/v0/administration/finance/care_order_products/{id}
Deletes the CareOrderProduct with given id
GET
/v0/administration/finance/care_orders/{care_order_id}/care_order_products
Return the CareOrderProducts of a CareOrder corresponding to the given id.
GET
/v0/xstream/care_order_products/data
Return all CareOrderProduct models in a streaming manner
GET
/v0/xstream/care_order_products/updates
Return all CareOrderProduct models which where updated since the date given in the request.
finance.CareOrder 9
POST
/v0/administration/finance/care_orders
Create CareOrder
GET
/v0/administration/finance/care_orders/{id}
Return the CareOrder corresponding to the given id
PUT
/v0/administration/finance/care_orders/{id}
Updates the given CareOrder
DELETE
/v0/administration/finance/care_orders/{id}
Deletes the CareOrder with given id
GET
/v0/administration/finance/care_orders/by_client_and_finance_type/{client_object_id}
If you are looking for 'zorglegitimaties', then you can use the CareOrder API.
GET
/v0/administration/finance/care_orders/by_client/{client_id}
If you are looking for 'zorglegitimaties', then you can use the CareOrder API.
GET
/v0/administration/finance/care_orders/by_identification_no/{identification_no}
Finds a CareOrder by its identification number ('legitimatienummer').
GET
/v0/xstream/care_orders/data
Return all CareOrder models in a streaming manner
GET
/v0/xstream/care_orders/updates
Return all CareOrder models which where updated since the date given in the request.
finance.ClientFinancedProduct 2
GET
/v0/administration/finance/client_financed_products/by_location_and_finance_type_in_period
Retrieve the legally financeable products for all clients on a certain locations for a certain finance type.
GET
/v0/administration/finance/client_financed_products/by_location_and_finance_types_in_period
Retrieve the legally financeable products for all clients on a certain locations for a certain finance type.
finance.DeclarationRule 7
POST
/v0/administration/finance/declaration_rules
Create DeclarationRule
GET
/v0/administration/finance/declaration_rules/{id}
PUT
/v0/administration/finance/declaration_rules/{id}
Updates the given DeclarationRule
DELETE
/v0/administration/finance/declaration_rules/{id}
Deletes the DeclarationRule with given id
GET
/v0/administration/finance/declaration_rules/by_client/{client_id}
Return the Declaration rules belonging to a certain client.
GET
/v0/administration/finance/declaration_rules/by_client/{client_id}/is_verified
Returns whether the declaration rules for a given client are (partly) verified within the specified period
GET
/v0/administration/finance/declaration_rules/by_client/{client_id}/verified_until
finance.Product 4
GET
/v0/administration/finance/finance_types/{finance_type_id}/products
Return the Products of a FinanceType corresponding to the given id.
GET
/v0/administration/finance/products/{id}
Return the Product corresponding to the given id
GET
/v0/xstream/products/data
Return all Product models in a streaming manner
GET
/v0/xstream/products/updates
Return all Product models which where updated since the date given in the request.
finance.FinanceType 3
GET
/v0/administration/finance/finance_types/{id}
Return the Finance Type corresponding to the given id
GET
/v0/xstream/finance_types/data
Return all FinanceType models in a streaming manner
GET
/v0/xstream/finance_types/updates
Return all FinanceType models which where updated since the date given in the request.
finance.ForensicCareOrder 4
POST
/v0/administration/finance/forensic_care_orders
Create ForensicCareOrder
GET
/v0/administration/finance/forensic_care_orders/{id}
Return the Forensic Care Order corresponding to the given id
PUT
/v0/administration/finance/forensic_care_orders/{id}
Updates the given ForensicCareOrder
DELETE
/v0/administration/finance/forensic_care_orders/{id}
Deletes the ForensicCareOrder with given id
finance.InvoiceProviderGroup 1
GET
/v0/administration/finance/invoiceProviderGroups
Returns every InvoiceProviderGroup available from the InvoiceProviderGroupAPI
finance.ParallelCareOrder 1
GET
/v0/administration/finance/parallel_care_orders/by_employee_and_client_at_date/{employee_object_id}
payroll.holiday.Holiday 2
GET
/v0/administration/holidays
Returns every Holiday available from the HolidayAPI
GET
/v0/administration/holidays/between
Returns a list with holidays which lay between the given days.
HourTypeCategory 3
GET
/v0/administration/hour_type_categories
Returns every HourTypeCategory available from the HourTypeCategoryAPI
GET
/v0/administration/hour_type_categories/{id}
Get the Hour Type Category corresponding to the given id
GET
/v0/administration/hour_type_categories/by_name/{name}
Return the hour type category corresponding to the given name.
HourTypeProductAssignment 3
GET
/v0/administration/hour_type_product_assignments
Returns every HourTypeProductAssignment available
GET
/v0/administration/hour_type_product_assignments/{id}
Returns the HourTypeProductAssignment with the provided id
GET
/v0/administration/hour_types/{id}/product_assignments
Returns the HourTypeProductAssignments assigned to the HourType with the provided id
ons_administration.WorkdayHourTypeModel 1
GET
/v0/administration/hour_types/workdays
Returns all workday hour types (activities) with their validity periods. During these periods, the corresponding hour type is counted as a workday. If the hour type is not present in this list, it is…
payroll.HourlyWage 4
GET
/v0/administration/hourly_wages/{id}
Return the Hourly Wage corresponding to the given id
GET
/v0/administration/hourly_wages/by_employee/{employee_object_id}
Retrieves all the hourly wages of the employee.
GET
/v0/xstream/hourly_wages/data
Return all Hourly wages odels in a streaming manner
GET
/v0/xstream/hourly_wages/updates
Return all Hourly wages models which where updated since the date given in the request.
jw.JwZorglegitimatie 3
POST
/v0/administration/jw/zorglegitimaties
Create JwZorglegitimatie
GET
/v0/administration/jw/zorglegitimaties/{id}
Return the JwZorglegitimatie corresponding to the given id
DELETE
/v0/administration/jw/zorglegitimaties/{id}
Delete a JwZorglegitimatie
LocationAssignmentResidence 4
POST
/v0/administration/location_assignment_residences
Create LocationAssignmentResidence
GET
/v0/administration/location_assignment_residences/{id}
Return the Location Assignment Residence corresponding to the given id
PUT
/v0/administration/location_assignment_residences/{id}
Updates the given LocationAssignmentResidence
GET
/v0/administration/location_assignment_residences/by_careorder/{care_order_object_id}
Find a list of locationAssignmentResidences based on the careorderobjectid
NavigationAvailability 1
GET
/v0/administration/navigation/availabilities
Get all navigation availabilities for Ons Administration
dossier.omaha.OmahaClassification 4
GET
/v0/administration/omaha/classifications/{id}
Get the OmahaClassification corresponding to the given id
PUT
/v0/administration/omaha/classifications/{id}
Updates the given OmahaClassification
POST
/v0/administration/omaha/classifications/by_client/{client_id}/new
Create an OmahaClassification for the Client corresponding to the given id
GET
/v0/administration/omaha/classifications/by_survey_result/{survey_result_id}
dossier.omaha.ClassifiedProblem 4
POST
/v0/administration/omaha/classified_problems
Create ClassifiedProblem
GET
/v0/administration/omaha/classified_problems/{id}
Return the Omaha Classified Problem corresponding to the given id
PUT
/v0/administration/omaha/classified_problems/{id}
Updates the given ClassifiedProblem
DELETE
/v0/administration/omaha/classified_problems/{id}
Deletes the ClassifiedProblem with given id
dossier.omaha.InterventionCategory 1
GET
/v0/administration/omaha/intervention_categories
Returns every InterventionCategory available from the InterventionCategoryAPI
dossier.omaha.InterventionTarget 1
GET
/v0/administration/omaha/intervention_targets
Returns every InterventionTarget available from the InterventionTargetAPI
dossier.omaha.Problem 1
GET
/v0/administration/omaha/problems
Returns every Problem available from the ProblemAPI
payroll.PayableHoursAverage 4
GET
/v0/administration/payable_hours_averages/on_day_of_week_in_period/{employee_id}deprecated
Get the average payable hours for a given day of the week, for the specified employee and the requested period (inclusive).
GET
/v0/administration/payable_hours_averages/on_days_of_week_in_period/{employee_id}
Get the average payable hours for the given days of the week, for the specified employee and the requested period (inclusive).
GET
/v0/administration/payable_hours_averages/per_day_in_period/{employee_id}
Get the average payable hours per day, for the specified employee and the requested period (inclusive).
GET
/v0/administration/payable_hours_averages/per_week_in_period/{employee_id}
Get the average payable hours per week, for the specified employee and the requested period (inclusive).
PersonalRelationType 2
GET
/v0/administration/personal_relation_types
Returns every PersonalRelationType available from the PersonalRelationTypeAPI
GET
/v0/administration/personal_relation_types/{id}
Returns the PersonalRelationType corresponding to the given id
Practitioner 3
GET
/v0/administration/practitioners/by_agb/{agbcode}
Return the practitioner based on the given agbcode
GET
/v0/administration/practitioners/by_employee/{employee_id}
Return the practitioner based on the given id of an employee
GET
/v0/administration/practitioners/search
Return the practitioners based on the given search query
Referral 4
POST
/v0/administration/referrals
Create Referral
GET
/v0/administration/referrals/{id}
Return the Referral corresponding to the given id
GET
/v0/administration/referrals/by_client/{client_id}
Returns the referrals of the client corresponding to the given client id.
GET
/v0/administration/referrals/categories
Fetch all available ReferrerCategories accompanied by their available referrer types
Skn 1
GET
/v0/administration/skns/{id}
Return the Skn corresponding to the given id
status.ApplicationStatus 1
GET
/v0/administration/status/application
Retrieves the ApplicationStatus
survey.Answer 1
DELETE
/v0/administration/survey_answer/{id}
Deletes the Answer with given id
survey.SurveyResult 7
POST
/v0/administration/survey_result
Create SurveyResult
GET
/v0/administration/survey_result/{id}
PUT
/v0/administration/survey_result/{id}
Updates the given SurveyResult
DELETE
/v0/administration/survey_result/{id}
Deletes the SurveyResult with given id
POST
/v0/administration/survey_result/{survey_result_id}/duplicate
Duplicate a Survey Result
GET
/v0/administration/survey_result/by_survey/{survey_id}
Return the SurveyResults of a Survey corresponding to the given id.
GET
/v0/administration/survey_result/survey_results_by_client/{client_id}
Return the survey results of a Client corresponding to the given id.
survey.AnswerDefinitionGroup 4
GET
/v0/administration/survey/answer_definition_groups
Returns every AnswerDefinitionGroup available from the AnswerDefinitionGroupAPI
POST
/v0/administration/survey/answer_definition_groups
Create AnswerDefinitionGroup
GET
/v0/administration/survey/answer_definition_groups/{id}
PUT
/v0/administration/survey/answer_definition_groups/{id}
Updates the given AnswerDefinitionGroup
survey.GroupAnswer 1
GET
/v0/administration/survey/group_answers/{id}
Return the Survey Group Answer corresponding to the given id
survey.Survey 6
GET
/v0/administration/survey/surveys
Returns every Survey available from the SurveyAPI
POST
/v0/administration/survey/surveys
Create Survey
GET
/v0/administration/survey/surveys/{id}
PUT
/v0/administration/survey/surveys/{id}
Updates the given Survey
DELETE
/v0/administration/survey/surveys/{id}
Deletes the Survey with given id
GET
/v0/administration/survey/surveys/creatable_surveys_by_employee/{employee_id}
Return the creatable Surveys for the Employee corresponding to the given id
TeamAddress 4
POST
/v0/administration/team_addresses
Create TeamAddress
GET
/v0/administration/team_addresses/{id}
Return the Team Address corresponding to the given id
PUT
/v0/administration/team_addresses/{id}
Updates the given TeamAddress
DELETE
/v0/administration/team_addresses/{id}
Used to delete TeamAddress by a given id
transport.ClientTransport 1
GET
/v0/administration/transport/client_transport/by_client/{client_id}
Find the ClientTransport information for a given client on the given date
TreatmentLocation 1
GET
/v0/administration/treatment_locations/{id}
Return the treatment location by id
User 16
POST
/v0/administration/users
Create User
GET
/v0/administration/users/{id}
Get user by ID
PUT
/v0/administration/users/{id}
Updates the given User
DELETE
/v0/administration/users/{id}
Deletes the User with given id
GET
/v0/administration/users/{user_id}/last_visited_locations
Return the last visited Locations of a User corresponding to the given id.
PUT
/v0/administration/users/{user_id}/password
Changes the users password
GET
/v0/administration/users/{user_id}/status
returns the status of the user
GET
/v0/administration/users/{user_id}/viewable_locationsdeprecated
Return the viewable Locations of a User corresponding to the given id.
GET
/v0/administration/users/by_employee_id/{employee_id}
Get user by employee ID
GET
/v0/administration/users/by_sso
Return the User with the given SSO id
GET
/v0/administration/users/by_username
Find by user name.
GET
/v0/administration/users/by_username/{user_name}deprecated
Find by user name.
GET
/v0/administration/users/by_uuid/{uuid}
Get user by UUID
GET
/v0/xstream/responsibilities/data
Return all User models in a streaming manner
GET
/v0/xstream/responsibilities/deletes
Return all User models which where deleted since the date given in the request.
GET
/v0/xstream/responsibilities/updates
Return all User models which where updated since the date given in the request.
wlz.WlzZorglegitimatie 3
POST
/v0/administration/wlz/zorglegitimaties
Create WlzZorglegitimatie
GET
/v0/administration/wlz/zorglegitimaties/{id}
Return the WlzZorgLegitimatie corresponding to the given id
DELETE
/v0/administration/wlz/zorglegitimaties/{id}
Delete a WlzZorglegitimatie
wmo.WmoZorglegitimatie 3
POST
/v0/administration/wmo/zorglegitimaties
Create WmoZorglegitimatie
GET
/v0/administration/wmo/zorglegitimaties/{id}
Return the WmoZorgLegitimatie corresponding to the given id
DELETE
/v0/administration/wmo/zorglegitimaties/{id}
Delete a WmoZorglegitimatie
payroll.WorkHoursBalance 4
GET
/v0/administration/work_hours_balances/by_employee_at_date/{employee_object_id}
Retrieves a list with all workhour balances for the given employee and for the given date.
GET
/v0/administration/work_hours_balances/by_employee_with_type_at_date/{employee_object_id}
Retrieves a workhour balance for the given employee/accounttype and date.
GET
/v0/administration/work_hours_balances/by_employee_with_type/{employee_object_id}
Retrieves a workhour balance for the given employee and account type.
GET
/v0/administration/work_hours_balances/by_employee/{employee_object_id}
Retrieves a list with all workhour balances for the given employee.
payroll.WorkLoad 1
GET
/v0/administration/work_load/by_employee_in_year/{employee_object_id}
Retrieves the workload for the given year and employee.
worksheet.Worksheet 1
GET
/v0/administration/worksheets/{employee_id}
Returns worksheet in pdf format
zpm.CareOrderZpmDetails 2
POST
/v0/administration/zpm/care_orders
Create ZPM detail records for a given care order.
GET
/v0/administration/zpm/care_orders/{care_order_id}
Fetches ZPM detail records for a given care order.
zpm.ZpmGbggzProfiel 1
GET
/v0/administration/zpm/gbggz_profielen
Returns a list of all ZPM GB-ggz profielen.
zpm.ZpmSetting 1
GET
/v0/administration/zpm/settings
Returns a list of all ZPM settings.
zpm.ZpmZorglabel 1
GET
/v0/administration/zpm/zorglabels
Returns a list of all ZPM zorglabels.
agenda.AgendaOccurrence 9
GET
/v0/agenda/agenda_occurrences/{id}
Get event occurrence
DELETE
/v0/agenda/agenda_occurrences/{id}/destroy_following
Removes the given agenda occurrence item and all of the following occurrences of that item
DELETE
/v0/agenda/agenda_occurrences/{id}/destroy_incidentally
Removes only the given agenda occurrence item
PUT
/v0/agenda/agenda_occurrences/{id}/update_following
Updates the given AgendaOccurrence item and all of the following occurrences of that item.
PUT
/v0/agenda/agenda_occurrences/{id}/update_incidentally
Updates only the given AgendaOccurrence.
GET
/v0/agenda/clients/{client_id}/agenda_occurrences
Return the agenda occurrences of a Client corresponding to the given id.
GET
/v0/agenda/employees/{employee_id}/agenda_occurrences
Return the agenda occurrences of a Employee corresponding to the given id.
GET
/v0/agenda/groups/{group_uuid}/agenda_occurrencesdeprecated
Return the agenda occurrences of a group corresponding to the given uuid.
GET
/v0/agenda/locations/{location_id}/agenda_occurrences
Return the agenda occurrences of a Location corresponding to the given id.
agenda.RegistrationStatus 1
GET
/v0/agenda/agenda_registration_status
Return the agenda registrations status of a specific type corresponding to the given id.
agenda.AgendaSeries 3
POST
/v0/agenda/agenda_series
Create AgendaSeries
POST
/v0/agenda/agenda_series/archive_groupdeprecated
Archive an AgendaSeries from a Groupcare Group
PUT
/v0/agenda/agenda_series/update_groupdeprecated
Update the Group information for an Agenda series
agenda.ClientAbsenceOccurrence 2
GET
/v0/agenda/client_absence_occurrences/{id}
Used for selecting a ClientAbsenceOccurrence
GET
/v0/agenda/client_absence_occurrences/by_client_in_period
Used for selecting ClientAbsenceOccurrences from a client and moment in time.
agenda.ReservationOccurrence 5
GET
/v0/agenda/employees/{employee_id}/entries/reservation
Return the reservation occurrences of an Employee in the given period.
DELETE
/v0/agenda/entries/reservations/occurrences/{occurrence_id}
Delete a single reservation occurrence.
PATCH
/v0/agenda/entries/reservations/occurrences/{occurrence_id}
Update a single reservation occurrence.
DELETE
/v0/agenda/entries/reservations/occurrences/{occurrence_id}/following
Delete a reservation occurrence and all following occurrences.
PATCH
/v0/agenda/entries/reservations/occurrences/{occurrence_id}/following
Update a reservation occurrence and all following occurrences.
agenda.ReservationCreate 1
POST
/v0/agenda/entries/reservations
Creates a reservation for the specified employee
agenda.Label 1
GET
/v0/agenda/labels
Returns every Label available from the LabelAPI
agenda.Unavailability 1
POST
/v0/agenda/unavailabilities
Creates an Agenda Unavailability for the specified employee
herald.AnnouncementCount 1
GET
/v0/announcements/announcement_count
toezicht.Audit 1
GET
/v0/auditing/export
Export audits for a given time period
authorization.provisioning.Role 1
GET
/v0/authorization/provisioning/roles
Returns every Role available from the RoleAPI
authorization.provisioning.User 1
PUT
/v0/authorization/provisioning/users/{user_uuid}deprecated
This endpoint is meant to assign roles with a certain scope (teams/locations) to a user.
authorization.provisioning.UserDuties 1
PUT
/v0/authorization/provisioning/users/{user_uuid}/duties
This endpoint is meant to assign roles with a certain scope to a user.
authorization.provisioning.MyLocations 1
PUT
/v0/authorization/provisioning/users/{user_uuid}/my_locations
This endpoint is meant to set the list of MyLocations of a user.
authorization.provisioning.MyTeams 1
PUT
/v0/authorization/provisioning/users/{user_uuid}/my_teams
This endpoint is meant to set the list of MyTeams of a user.
authorization.provisioning.UserScopeSettings 1
PUT
/v0/authorization/provisioning/users/{user_uuid}/scope_settings
Updates scope settings of a user.
authorization.provisioning.DefaultScope 1
PUT
/v0/authorization/provisioning/users/{user_uuid}/scopesdeprecated
This endpoint is meant to set the default scope of a user.
kamino.KaminoSetting 2
GET
/v0/berichten/employees/{employee_id}/setting
Return the kamino setting of a employee corresponding to the given employee id.
PATCH
/v0/berichten/employees/{employee_id}/setting
Updates the kamino setting of the employee corresponding to the given employee id.
caretech.Order 3
GET
/v0/caretech/server/orders
Get all care technology orders with optional product codes and statuses
GET
/v0/caretech/server/orders/{order_id}
Get an care technology order
PATCH
/v0/caretech/server/orders/{order_id}/status
Update the status of an order
caretech.ProductAllocation 1
POST
/v0/caretech/server/product_allocations
Create a product allocation, including a new product instance, for a client
caretech.ReturnRequest 3
GET
/v0/caretech/server/return_requests
Get all care technology return requests matching the provided parameters.
GET
/v0/caretech/server/return_requests/{return_request_id}
Get a care technology return request
PATCH
/v0/caretech/server/return_requests/{return_request_id}/status
Update the status of a return request
client_story.Story 7
GET
/v0/client_story/authorized/clients/{client_id}/client_story/images
Authorized api Return a base64 encoded string of the image that is identified by the given reference
GET
/v0/client_story/authorized/stories/full_by_client/{client_id}
Return the full client story for the given client id.
POST
/v0/client_story/care_relations/request_for_client/{client_id}
Get permission for the current careprovider to view the client story
GET
/v0/client_story/clients/{client_id}/client_story/images
Return a base64 encoded string of the image that is identified by the given reference
PUT
/v0/client_story/stories/by_client/{client_id}
Save updates to the story of the client incrementally
GET
/v0/client_story/stories/full_by_client/{client_id}
Return the full client story for the given client id
GET
/v0/client_story/stories/single_answer_full_by_client/{client_id}
Return the full client story for the given client id Collapses the full json schema and form data to a single answer
client_story.ChangeSet 1
GET
/v0/client_story/change_sets/most_recent_by_client/{client_id}
Returns the most recent change set for the client
ons_client.SharedResource 1
GET
/v0/client/shared_resources
Retrieve all shared resources
dbc.ggz.fz.Subtraject 3
GET
/v0/dbc/fz/subtraject
Fetches a number ('limit') of subtrajects that lay within the given time period.
GET
/v0/dbc/fz/subtraject/{id}/history
Return the (financial) value for a dbbc in a given moment in time
GET
/v0/dbc/fz/subtraject/gesloten
Returns all the subtrajects that where closed within the given period.
dbc.ggz.Zorgtraject 3
GET
/v0/dbc/ggz/client/{client_id}/zorgtrajecten
POST
/v0/dbc/ggz/zorgtraject
Create Zorgtraject
GET
/v0/dbc/ggz/zorgtraject/{id}
Fetch a zorgtraject
dbc.ggz.Subtraject 5
GET
/v0/dbc/ggz/jw/subtraject/gesloten
Returns all the youth subtrajects that where closed within the given period.
GET
/v0/dbc/ggz/subtraject
Fetches a number ('limit') of subtrajects that lay within the given time period.
GET
/v0/dbc/ggz/subtraject/{id}
Fetch a subtraject
GET
/v0/dbc/ggz/subtraject/{id}/history
Return the (financial) value for a dbc in a given moment in time
GET
/v0/dbc/ggz/subtraject/gesloten
Returns all the subtrajects that where closed within the given period.
dbc.ggz.ValidationError 2
GET
/v0/dbc/ggz/subtraject/{subtraject_id}/validation_errors
Retrieve validation errors by subtrajectId.
GET
/v0/dbc/ggz/subtraject/validation_errors
Requires subtrajectIds.join('&').length < 2000 Retrieve validation errors by multiple subtrajectIds.
dbc.ggz.DiagnoseToekenning 2
POST
/v0/dbc/ggz/zorgtraject/{zorgtraject_id}/diagnose_toekenningen
DELETE
/v0/dbc/ggz/zorgtraject/{zorgtraject_id}/diagnose_toekenningen
Deletes diagnosis with a given externalid that belong to a given zorgtraject
dbc.ggz.PresenceLogSynchronisationError 2
GET
/v0/dbc/presencelog_sync_error/{id}
Fetch a synchronization error
GET
/v0/dbc/presencelog_sync_error/in_period
Fetches a number ('limit') of presencelog syncrhonisation errors from ons-dbc having the creation date between validFrom and validTo and updatedAt set to within the last hour (to only fetch errors th…
dienst_verwijzen_module.BundleWrapper 1
POST
/v0/dienst_verwijzen_module/cupido/fhir/r3/bundle_wrapper
Create a new item using a FHIR R3 bundle wrapped in a json object
dossier.ActiveCarePlanMetadata 1
GET
/v0/dossier/back_channel/authorized/active_care_plan_metadata
Returns active care plan metadata given the client ids.
dossier.admin.alerts.Topic 5
GET
/v0/dossier/back_channel/authorized/admin/alerts/topics
Get every topic
POST
/v0/dossier/back_channel/authorized/admin/alerts/topics
Create an alert topic
GET
/v0/dossier/back_channel/authorized/admin/alerts/topics/{id}
Get a specific topic
PUT
/v0/dossier/back_channel/authorized/admin/alerts/topics/{id}
Update the given Topic
DELETE
/v0/dossier/back_channel/authorized/admin/alerts/topics/{id}
Deletes the Topic with given id
dossier.Alert 5
POST
/v0/dossier/back_channel/authorized/alerts
Create an alert
GET
/v0/dossier/back_channel/authorized/alerts/{id}
Get a specific Alert
PUT
/v0/dossier/back_channel/authorized/alerts/{id}
Update the given Alert
GET
/v0/dossier/back_channel/unauthorized/alerts/{id}
Get a specific Alert
GET
/v0/dossier/back_channel/unauthorized/alerts/by_client_ids
Get a specific Alert
dossier.LastMedicalMoment 1
GET
/v0/dossier/back_channel/authorized/clients/{client_id}/last_medical_moments
Returns LastMedicalMoment timestamps by client
dossier.medical.PropensityToAdverseReaction 5
GET
/v0/dossier/back_channel/authorized/clients/{client_id}/medical/propensities_to_adverse_reaction
Returns allergies of the given client corresponding to the given id.
POST
/v0/dossier/back_channel/authorized/medical/propensities_to_adverse_reaction
Creates allergy or propensity to adverse reaction of the given client
GET
/v0/dossier/back_channel/authorized/medical/propensities_to_adverse_reaction/{id}
Returns allergy of the given client corresponding to the given id.
PUT
/v0/dossier/back_channel/authorized/medical/propensities_to_adverse_reaction/{id}
Updates allergy or propensity to adverse reaction of the given client
DELETE
/v0/dossier/back_channel/authorized/medical/propensities_to_adverse_reaction/{id}
Deletes allergy of the given client corresponding to the given id.
dossier.ReportWithActions 1
GET
/v0/dossier/back_channel/authorized/clients/{client_id}/reports_with_actions
Returns ReportsWithActions that have actions created by user or for user's expertise
dossier.ActionEntrySummary 1
GET
/v0/dossier/back_channel/unauthorized/action_entry_summaries/last_by_persistent_ids
Return the latest ActionEntrySummaries corresponding to the given persistentIds.
dossier.CarePlanAgreement 1
GET
/v0/dossier/back_channel/unauthorized/care_plan/{id}/agreement
Find care plan agreement by id
dossier.CarePlanSignatureRequirement 1
GET
/v0/dossier/back_channel/unauthorized/care_plan/{id}/signature_requirement
Find signature requirement by id
dossier.RestrictiveMeasureRegistration 3
POST
/v0/dossier/back_channel/unauthorized/care_plan/restrictive_measure_registrations
Create RestrictiveMeasureRegistration
PUT
/v0/dossier/back_channel/unauthorized/care_plan/restrictive_measure_registrations/{id}
Update RestrictiveMeasureRegistration
GET
/v0/dossier/back_channel/unauthorized/clients/{client_id}/care_plan/restrictive_measure_registrations
Get the registrations by client
dossier.RestrictiveMeasureCarePlanEntry 6
POST
/v0/dossier/back_channel/unauthorized/care_plan/restrictive_measures
Create RestrictiveMeasureCarePlanEntry
GET
/v0/dossier/back_channel/unauthorized/care_plan/restrictive_measures/{id}
Find restrictive measure care plan entry
PUT
/v0/dossier/back_channel/unauthorized/care_plan/restrictive_measures/{id}
Updates the given RestrictiveMeasureCarePlanEntry
DELETE
/v0/dossier/back_channel/unauthorized/care_plan/restrictive_measures/{id}
Deletes restrictive measure care plan entry by ID.
PATCH
/v0/dossier/back_channel/unauthorized/care_plan/restrictive_measures/{id}
Patches RestrictiveMeasureCarePlanEntry with given id
GET
/v0/dossier/back_channel/unauthorized/clients/{client_id}/care_plan/restrictive_measures
Return the restrictive measure care plan entries of a Client corresponding to the given id.
dossier.medical.advance_directives.Context 5
GET
/v0/dossier/back_channel/unauthorized/clients/{client_id}/medical/advance_directives/contexts
Return the contexts of a Client corresponding to the given id.
POST
/v0/dossier/back_channel/unauthorized/medical/advance_directives/contexts
Create Context
PUT
/v0/dossier/back_channel/unauthorized/medical/advance_directives/contexts/{id}
Updates the given Context
DELETE
/v0/dossier/back_channel/unauthorized/medical/advance_directives/contexts/{id}
Deletes the Context with given id
PATCH
/v0/dossier/back_channel/unauthorized/medical/advance_directives/contexts/{id}
Patches Context with given id
dossier.medical.dsm.ClassificationSeries 4
GET
/v0/dossier/back_channel/unauthorized/clients/{client_id}/medical/dsm/classification_series
Gets the DSM classification series for the given client, optionally filtered by the care order that is linked to the series
POST
/v0/dossier/back_channel/unauthorized/medical/dsm/classification_series
Create ClassificationSeries
GET
/v0/dossier/back_channel/unauthorized/medical/dsm/classification_series/{classification_series_id}/diagnosis_assignments
Gets all the diagnosis assignments for the specified DSM classification series ID
GET
/v0/dossier/back_channel/unauthorized/medical/dsm/classification_series/{id}
Gets the DSM classification series for the specified ID
dossier.medical.involuntary_care.LegalStatus 6
GET
/v0/dossier/back_channel/unauthorized/clients/{client_id}/medical/involuntary_care/legal_statuses
Return the legal statuses of a Client corresponding to the given id.
POST
/v0/dossier/back_channel/unauthorized/medical/involuntary_care/legal_statuses
Create LegalStatus
GET
/v0/dossier/back_channel/unauthorized/medical/involuntary_care/legal_statuses/{id}
Gets the legal status for the specified ID
PUT
/v0/dossier/back_channel/unauthorized/medical/involuntary_care/legal_statuses/{id}
Updates the given LegalStatus
DELETE
/v0/dossier/back_channel/unauthorized/medical/involuntary_care/legal_statuses/{id}
Deletes the legal status by ID.
PATCH
/v0/dossier/back_channel/unauthorized/medical/involuntary_care/legal_statuses/{id}
Patches LegalStatus with given id
dossier.episodes.Episode 5
POST
/v0/dossier/back_channel/unauthorized/episodes
Create Episode
GET
/v0/dossier/back_channel/unauthorized/episodes/{id}
Gets the episode with the specified ID
PUT
/v0/dossier/back_channel/unauthorized/episodes/{id}
Updates the given Episode
PATCH
/v0/dossier/back_channel/unauthorized/episodes/{id}
Patches Episode with given id
GET
/v0/dossier/back_channel/unauthorized/episodes/by_client_id/{client_id}
Gets all the episodes for the specified client ID
dossier.episodes.Action 5
POST
/v0/dossier/back_channel/unauthorized/episodes/actions
Create Action
PUT
/v0/dossier/back_channel/unauthorized/episodes/actions/{id}
Updates the given Action
PATCH
/v0/dossier/back_channel/unauthorized/episodes/actions/{id}
Patches Action with given id
GET
/v0/dossier/back_channel/unauthorized/episodes/actions/by_episode_id/{episode_id}
Gets all the actions for the specified episode ID
GET
/v0/dossier/back_channel/unauthorized/episodes/actions/by_sub_goal_id/{sub_goal_id}
Gets alls the actions for the specified episode sub goal ID
dossier.episodes.SubGoal 4
POST
/v0/dossier/back_channel/unauthorized/episodes/sub_goals
Create SubGoal
PUT
/v0/dossier/back_channel/unauthorized/episodes/sub_goals/{id}
Updates the given SubGoal
PATCH
/v0/dossier/back_channel/unauthorized/episodes/sub_goals/{id}
Patches SubGoal with given id
GET
/v0/dossier/back_channel/unauthorized/episodes/sub_goals/by_episode_id/{episode_id}
Gets all the sub goals for the specified episode ID
dossier.InvoluntaryCareExportEntry 1
GET
/v0/dossier/back_channel/unauthorized/involuntary_care_export/entries
Get the involuntary care export entries for given parameters.
dossier.medical.dsm.Classification 2
GET
/v0/dossier/back_channel/unauthorized/medical/dsm/classifications
Returns every Classification available from the ClassificationAPI
GET
/v0/dossier/back_channel/unauthorized/medical/dsm/classifications/{id}
Gets the DSM classification for the specified ID
dossier.medical.involuntary_care.Incompetence 5
POST
/v0/dossier/back_channel/unauthorized/medical/involuntary_care/incompetences
Create Incompetence
GET
/v0/dossier/back_channel/unauthorized/medical/involuntary_care/incompetences/{id}
Gets a Incompetence by specified identifier
PUT
/v0/dossier/back_channel/unauthorized/medical/involuntary_care/incompetences/{id}
Updates the given Incompetence
DELETE
/v0/dossier/back_channel/unauthorized/medical/involuntary_care/incompetences/{id}
Deletes the Incompetence with given id
PATCH
/v0/dossier/back_channel/unauthorized/medical/involuntary_care/incompetences/{id}
Patches Incompetence with given id
dossier.medical.MedicalSummary 1
GET
/v0/dossier/back_channel/unauthorized/medical/medical_summaries/by_client_ids
Gets the medical summaries for the specified clients. The parameters determine what data should be included in the summary
dossier.medical.Problem 5
POST
/v0/dossier/back_channel/unauthorized/medical/problems
Create Problem
GET
/v0/dossier/back_channel/unauthorized/medical/problems/{id}
Get a specific topic
PUT
/v0/dossier/back_channel/unauthorized/medical/problems/{id}
Updates the given Problem
DELETE
/v0/dossier/back_channel/unauthorized/medical/problems/{id}
Deletes the Problem with given id
PATCH
/v0/dossier/back_channel/unauthorized/medical/problems/{id}
Patches Problem with given id
dossier.medical.SimplifiedPropensityToAdverseReaction 2
PUT
/v0/dossier/back_channel/unauthorized/medical/simplified/propensities_to_adverse_reaction
Updates the given SimplifiedPropensityToAdverseReaction
POST
/v0/dossier/back_channel/unauthorized/medical/simplified/propensities_to_adverse_reaction
Create SimplifiedPropensityToAdverseReaction
fvc.FvcMessage 1
POST
/v0/farmed_visie/message
Send a message to FVC
finance.DebtorGroup 3
GET
/v0/finance/debtorGroups
Returns every DebtorGroup available from the DebtorGroupAPI
GET
/v0/finance/debtorGroups/{id}
Retrieve debtor group by id
GET
/v0/finance/debtorGroups/byDebtorId/{debtor_id}
Return a DebtorGroupsList for which holds that every DebtorGroup contains debtorId
groupcare.Occurrence 1
GET
/v0/groupcare/clients/{client_id}/occurrences
Return the groupcare agenda occurrences of a Client corresponding to the given id.
groupcare.Group 5
GET
/v0/groupcare/groups
Retrieves all groups that are not expired on the given date.
POST
/v0/groupcare/groups
Create Groupcare Group
GET
/v0/groupcare/groups/{id}
Get GroupCare group by its identifier
PUT
/v0/groupcare/groups/{id}
Updates the given Groupcare Group
GET
/v0/xstream/groups/data
Returns Groups models in a streaming manner.
onsimport.Run 12
GET
/v0/import/run
Returns a list of all runs.
POST
/v0/import/run
Creates a new run.
DELETE
/v0/import/run/{run_id}
Deletes a run and any corresponding records, lookups, files and validations.
GET
/v0/import/run/{run_id}/idlist
Requests generating an ID list for a run.
GET
/v0/import/run/{run_id}/report
Requests generating a report for a run.
GET
/v0/import/run/{run_id}/report/{report_id}
Returns a report for a run.
GET
/v0/import/run/{run_id}/status
Returns status information about a run.
GET
/v0/import/run/{run_id}/status/{upload_id}
Returns status information about a run, including any file validation messages resulting from the file upload identified by uploadId.
GET
/v0/import/run/{run_id}/uploads
Returns uploaded files for the specified run.
GET
/v0/import/run/{run_id}/validations
Returns all validation messages for the specified run.
POST
/v0/import/run/binary
Uploads a binary file to be processed by Ons Import.
POST
/v0/import/run/xml
Uploads xml content to be processed by Ons Import.
harmony.ZorgdomeinFhirConnector 1
POST
/v0/ketenverkeer/fhir/r3/bundle_wrapper
Create BundleWrapper
portal.EmployeePortalProfile 1
GET
/v0/medewerkerportaal/employees/{employee_id}/employee_portal_profile
Return the employee portal profile of a employee corresponding to the given employee id.
medication.DoubleCheckChange 1
POST
/v0/medicatie_legacy/double_check_changes
Create DoubleCheckChange
medication.DoubleCheck 1
GET
/v0/medicatie_legacy/double_checks/{uuid}
medication.MedicationAdministration 2
GET
/v0/medicatie_legacy/medication_administrations
Fetch medication administrations for a client.
GET
/v0/medicatie_legacy/medication_administrations/{id}
Fetch a medication administration.
medication.MedicationPlan 3
GET
/v0/medicatie_legacy/medication_plan_overviews/current_week
Returns information about current medication plans
GET
/v0/medicatie_legacy/medication_plan_overviews/next_week
Returns information about upcoming medication plans
GET
/v0/medicatie_legacy/medication_plans/clients/{client_id}/weeks/{week}
Fetch a medication plan
milo.Device 6
GET
/v0/mobile_backend/devices/by_device_code/{device_code}
Return the device based on devicecode.
GET
/v0/mobile_backend/devices/by_employee/{employee_id}
Return the devices of an Employee corresponding to the given id.
GET
/v0/mobile_backend/totp/by_employee/{employee_id}/request_totp
Request a one time password by employee.
POST
/v0/mobile_backend/totp/by_employee/{employee_id}/verify_totp
Verify if one time password is valid by employee.
GET
/v0/mobile_backend/totp/request_totpdeprecated
Request a one time password for the device which correspond with the device id.
POST
/v0/mobile_backend/totp/verify_totpdeprecated
Verify if one time password is valid by device.
hermes.CareProviderSettings 1
GET
/v0/notification/care_provider_settings
Retrieves the CareProviderSettings
hermes.ContactMethod 2
GET
/v0/notification/clients/{client_id}/contact_method
Return the hermes contact method of a Client corresponding to the given id.
POST
/v0/notification/clients/{client_id}/contact_methods/set_primary_type
Set primary contact method for client by given contact method type and enable/disable notifications for it.
hermes.Notification 4
GET
/v0/notification/employees/{employee_id}/notifications
Return the hermes notifications of an Employee corresponding to the given id.
POST
/v0/notification/notifications
Send a notification to an employee or user.
GET
/v0/notification/notifications/{id}
GET
/v0/notification/notifications/by_uuid/{uuid}
nexus.ClientContactRelationType 2
GET
/v0/ons_nexus/client_contact_relation_typesdeprecated
Deprecated. Please use /administration/clientcontactrelationtypes instead.
GET
/v0/ons_nexus/client_contact_relation_types/{id}deprecated
Deprecated. Please use /administration/clientcontactrelationtypes/{id} instead.
nexus.ClientEmployeeRelationType 2
GET
/v0/ons_nexus/client_employee_relation_typesdeprecated
Deprecated. Please use /administration/clientemployeerelationtypes instead.
GET
/v0/ons_nexus/client_employee_relation_types/{id}deprecated
Deprecated. Please use /administration/clientemployeerelationtypes/{id} instead.
nexus.ClientEmployeeRelation 8
POST
/v0/ons_nexus/client_employee_relationsdeprecated
Deprecated. Please use /administration/clientemployeerelations instead.
GET
/v0/ons_nexus/client_employee_relations/{id}deprecated
Deprecated. Please use /administration/clientemployeerelations/{id} instead.
PUT
/v0/ons_nexus/client_employee_relations/{id}deprecated
Deprecated. Please use /administration/clientemployeerelations/{id} instead.
DELETE
/v0/ons_nexus/client_employee_relations/{id}deprecated
Deprecated. Please use /administration/clientemployeerelations/{id} instead.
GET
/v0/ons_nexus/clients/{client_id}/client_employee_relationsdeprecated
Deprecated. Please use /administration/clients/{clientid}/clientemployeerelations instead.
GET
/v0/ons_nexus/employees/{employee_id}/client_employee_relationsdeprecated
Deprecated. Please use /administration/employees/{employeeid}/clientemployeerelations instead.
GET
/v0/xstream/client_employee_relations/data
Return all ClientEmployeeRelation models in a streaming manner
GET
/v0/xstream/client_employee_relations/updates
Return all ClientEmployeeRelation models which where updated since the date given in the request.
nexus.OrganisationCategory 2
GET
/v0/ons_nexus/organisation_categories
Returns every OrganisationCategory available from the OrganisationCategoryAPI
GET
/v0/ons_nexus/organisation_categories/{id}
nexus.PersonalRelationType 2
GET
/v0/ons_nexus/personal_relation_typesdeprecated
Deprecated. Please use /administration/personalrelationtypes instead.
GET
/v0/ons_nexus/personal_relation_types/{id}deprecated
Deprecated. Please use /administration/personalrelationtypes/{id} instead.
openehr.EmployeeGroup 3
GET
/v0/openehr_db/unauthorized/cupido/employee_groups/{id}
Returns the employee group corresponding to the given id, including direct parent and child groups
GET
/v0/openehr_dossier/back_channel/unauthorized/employee_groups
Returns every EmployeeGroup available from the EmployeeGroupAPI
GET
/v0/openehr_dossier/back_channel/unauthorized/employee_groups/by_employee/{employee_id}
Returns employee groups that an employee is or was a member of
openehr.ArchetypeWrapper 5
GET
/v0/openehr_dossier/back_channel/unauthorized/archetype_wrappers
Finds a list of all archetypeWrappers in the requested format, filtering by archetypeId.
GET
/v0/openehr_dossier/back_channel/unauthorized/archetype_wrappers/{id}
Finds an archetypeWrapper by archetypeId in the requested format
GET
/v0/openehr_dossier/back_channel/unauthorized/archetype_wrappers/creatable
Finds a list of archetypeWrappers that are creatable
GET
/v0/openehr_dossier/back_channel/unauthorized/archetype_wrappers/creatable/current_versions
Finds a list of archetypeWrappers that are the creatable current versions
GET
/v0/openehr_dossier/back_channel/unauthorized/archetype_wrappers/for_client/{client_id}
Finds a list of archetypeWrappers for a given client id
ons_ehr.NavigationAvailability 1
GET
/v0/openehr_dossier/back_channel/unauthorized/clients/{client_id}/navigation_availabilities
Get available navigation keys for the given client
openehr.CompositionWrapper 15
GET
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers
Finds all CompositionWrappers of all clients that are an instance of the given archetypeId.
POST
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers
Create CompositionWrapper
DELETE
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers
Deletes multiple Compositions by given id's
GET
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/{id}
Finds a compositionWrapper in the requested form
PUT
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/{id}
Updates the given CompositionWrapper
DELETE
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/{id}
Deletes the CompositionWrapper with given id
GET
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/{id}/composition_versions
Finds all CompositionVersionWrappers of a given composition.
GET
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/{id}/incoming_links
Finds all reference model objects linking to given composition that are an instance of the given archetypeIds.
POST
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/by_item_tags
Returns all compositions that contain all given item tags.
POST
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/evaluate
Posts a compositionWrapper and returns the ruleEvaluation.
GET
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/export_to_xlsx
Returns an XLSX file with the content of all compositions within a clients ehr as stream of bytes
GET
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/plan_elements
Lists all plan element compositions associated with the requested executor group names
POST
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/selected_values
Query composition data by archetype and path
GET
/v0/openehr_dossier/back_channel/unauthorized/vvt_care_profiles/{careplan_id}
Finds a VVT care profile compositionWrapper in the requested form
POST
/v0/openehr_dossier/back_channel/unauthorized/vvt_care_profiles/{careplan_id}/copy
Copies a VVT care profile compositionWrapper to a new careplan.
openehr.ItemTag 2
POST
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/{versioned_composition_id}/item_tags
Creates an item tag for a spesific versioned composition and returns the created item tag.
POST
/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/{versioned_composition_id}/item_tags/delete
Deletes item tag for a versioned composition.
ons_ehr.LastVisitedPlan 1
GET
/v0/openehr_dossier/back_channel/unauthorized/employees/{employee_id}/last_visited_plan
Finds the last visited plan of the given employee
openehr.MultimediaFile 4
POST
/v0/openehr_dossier/back_channel/unauthorized/multimedia_files
Creates a MultimediaFile and associated meta object
GET
/v0/openehr_dossier/back_channel/unauthorized/multimedia_files/{id}
Finds a MultimediaFile metadata
GET
/v0/openehr_dossier/back_channel/unauthorized/multimedia_files/{id}/download
Returns a stream of bytes representing the file related to this MultimediaFile meta data
GET
/v0/openehr_dossier/back_channel/unauthorized/multimedia_files/{id}/thumbnail
Returns a stream of bytes representing the thumbnail with specified scale related to this MultimediaFile meta data
ons_ehr.GgzPlanStatistics 1
GET
/v0/openehr_dossier/back_channel/unauthorized/plan_statistics/ggz
Retrieves plan statistics for the mental healthcare plan
ons_ehr.Setting 1
GET
/v0/openehr_dossier/back_channel/unauthorized/settings
Return all settings from OnsEhr
openehr.CarePlanVvtCareProfileLink 1
POST
/v0/openehr_dossier/back_channel/unauthorized/vvt_care_profiles/care_plan_links
Returns care plan IDs for given VVT care profile composition IDs
moves.ClientPlanningFilter 1
GET
/v0/plannen_roosteren/clients/{client_id}/client_planning_filters
Return the client planning filters of a Client within a specified period.
moves.ClientPlannedSchedulePlannedVisit 1
GET
/v0/plannen_roosteren/clients/{client_id}/planned_schedule
Return the client planning filters of a Client within a specified period.
moves.Container 1
POST
/v0/plannen_roosteren/containers/search
Return the active containers searched for within a specified period.
moves.EmployeeExportJob 2
POST
/v0/plannen_roosteren/employee_export_jobs/create
Request to run the export for a single employee/date combination. (1) PresenceLogs are created in OnsPlanning, and immediately exported to OnsAdministration. When the export times out, the created Pr…
POST
/v0/plannen_roosteren/employee_export_jobs/preview
Return a preview for the specified employee export job
moves.EmployeeSchedule 1
GET
/v0/plannen_roosteren/employee_schedules/by_employee_id/{employee_id}
Returns the EmployeeSchedule for the given Employee for the requested period.
moves.EmployeeMovesProfile 1
GET
/v0/plannen_roosteren/employees/{employee_id}/employee_moves_profile
Return the moves profile of an employee specified by id.
moves.EmployeeHoursReport 1
GET
/v0/plannen_roosteren/employees/{employee_id}/hours_report
Return a report of the worked and leave hours of an employee in the current state and the future.
moves.NavigationAvailability 1
GET
/v0/plannen_roosteren/employees/{employee_id}/navigation_availabilities
Return the navigation availabilities of an employee specified by id.
moves.EmployeePlanning 2
GET
/v0/plannen_roosteren/employees/{employee_id}/planning
Returns the Planning for the given Employee for the requested period.
GET
/v0/plannen_roosteren/employees/{employee_id}/roster
Returns the Roster for the given Employee for the requested period.
moves.ShiftAssignment 2
GET
/v0/plannen_roosteren/employees/{employee_id}/shift_assignments/upcoming
Return the first upcoming shift assignment of an Employee specified by id
GET
/v0/plannen_roosteren/shift_assignments/starting_between
Return all the shift assignments starting within the specified period
moves.Absence 3
POST
/v0/plannen_roosteren/employees/absences
EXPERIMENTAL: Create or update an absence
GET
/v0/plannen_roosteren/employees/absences/{remote_absence_id}
Retrieve an absence by remote ID
DELETE
/v0/plannen_roosteren/employees/absences/{remote_absence_id}
EXPERIMENTAL: Delete an absence by remote ID
moves.FlexSignup 1
POST
/v0/plannen_roosteren/flex_signups
Creates a flex signup for an employee on a flex request
moves.PlanCardOccurrence 3
PATCH
/v0/plannen_roosteren/plan_cards/{checksum}
Update a plan card occurrence
POST
/v0/plannen_roosteren/plan_cards/{checksum}/plan
Plan a single plan card into a container
POST
/v0/plannen_roosteren/plan_cards/search
Return the active plan cards searched for within a specified period.
moves.PlannedVisit 2
GET
/v0/plannen_roosteren/planned_visits/by_client_id/{client_id}
Return the planned visits of a Client within a specified period.
GET
/v0/plannen_roosteren/planned_visits/by_employee_id/{employee_id}
Return the planned visits of an Employee within a specified period.
moves.RosterSlot 7
GET
/v0/plannen_roosteren/roster_slots
Return the roster slots of a unit (referred to with either a teamid or unitid) within the specified period. Slots which are incidentally changed in time contain a ShiftAssignment with the adjusted ti…
GET
/v0/plannen_roosteren/roster_slots/{id}
Return the roster slot with the specified id.
POST
/v0/plannen_roosteren/roster_slots/{roster_slot_id}/assign
Assigns a RosterSlot to an Employee by creating a ShiftAssignment for it.
DELETE
/v0/plannen_roosteren/roster_slots/{roster_slot_id}/clear_assignments
Clears all ShiftAssignments for the specified RosterSlot.
GET
/v0/plannen_roosteren/roster_slots/on_call
Return the on call roster slots of a unit on the specified date.
GET
/v0/plannen_roosteren/teams/{team_id}/on_call_rosterslotsdeprecated
Return the on call roster slots of a Team on the specified date.
GET
/v0/plannen_roosteren/teams/{team_id}/rosterslotsdeprecated
Return the roster slots of a Team within the specified period. Slots which are incidentally changed in time contain a ShiftAssignment with the adjusted times and no employee.
moves.Shift 4
GET
/v0/plannen_roosteren/shifts/{id}
Get a shift by its ID
GET
/v0/xstream/shifts/data
Return all Shift models in a streaming manner
GET
/v0/xstream/shifts/deletes
Return all Shift models which where deleted since the date given in the request.
GET
/v0/xstream/shifts/updates
Return all Shift models which where updated since the date given in the request.
moves.Team 3
GET
/v0/plannen_roosteren/units
Return all Teams used for planning and rostering ( also known as a unit ). Every unit (mostly) corresponds to a team in Ons Administration (however, it is possible to have a unit used for planning an…
GET
/v0/plannen_roosteren/units/{unit_id}
Return the team used for planning and rostering (also known as a unit) for the given unit Identifier. Every unit (mostly) corresponds to a team in Ons Administration (however, it is possible to have…
GET
/v0/plannen_roosteren/units/{unit_id}/clients
Return a list of relevant clients for the team, for given start and end date.
moves.WorkingEmployeeReport 1
GET
/v0/plannen_roosteren/working_employee_report
Return the list of Employee ids working within the specified period.
tasque.CareTaskGroupStatus 1
GET
/v0/taken/care_task_group_statuses
Returns every CareTaskGroupStatus available from the CareTaskGroupStatusAPI
tasque.CareTaskGroup 4
POST
/v0/taken/care_task_groups
Create CareTaskGroup
GET
/v0/taken/care_task_groups/{id}
Gets task group
PUT
/v0/taken/care_task_groups/{id}
Updates the given CareTaskGroup
DELETE
/v0/taken/care_task_groups/{id}
Deletes the CareTaskGroup with given id
tasque.CareTaskOccurrence 19
GET
/v0/taken/care_task_occurrences/{id}
DELETE
/v0/taken/care_task_occurrences/{id}/destroy_following
Removes the given task occurrences item and all of the following occurrences of that item
DELETE
/v0/taken/care_task_occurrences/{id}/destroy_incidentally
Removes the given task occurrence item
PUT
/v0/taken/care_task_occurrences/{id}/finish
Set state of the given task occurrence to finish
GET
/v0/taken/care_task_occurrences/{id}/next_date/{date}
DELETE
/v0/taken/care_task_occurrences/{id}/next_date/{date}/destroy_following
Find the next CareTaskOccurrence based on the id and a baseline search date and removes that found task occurrence item and all of the following occurrences of that item
DELETE
/v0/taken/care_task_occurrences/{id}/next_date/{date}/destroy_incidentally
Find the next CareTaskOccurrence based on the id and a baseline search date and removes that found task occurrence item
PUT
/v0/taken/care_task_occurrences/{id}/next_date/{date}/update_following
Find the next CareTaskOccurrence based on the id and a baseline search date and update only that found CareTaskOccurrence and all of the following occurrence of that item.
PUT
/v0/taken/care_task_occurrences/{id}/next_date/{date}/update_incidentally
Find the next CareTaskOccurrence based on the id and a baseline search date and update only that found CareTaskOccurrence.
PUT
/v0/taken/care_task_occurrences/{id}/update_following
Updates the given CareTaskOccurrence item and all of the following occurrences of that item
PUT
/v0/taken/care_task_occurrences/{id}/update_incidentally
Updates only the given CareTaskOccurrence item
GET
/v0/taken/care_task_occurrences/by_sub_type_id/{sub_type_id}
Returns the care task occurrences for the given sub-type and sub-type query.
GET
/v0/taken/care_task_occurrences/client_ids_by_sub_type
Query unique pairs [ , , ] by sub type.
GET
/v0/taken/clients/{client_id}/care_task_occurrences
Returns the care task occurrences of a Client corresponding to the given id.
GET
/v0/taken/clients/{client_id}/care_task_occurrences/by_sub_type
Returns the care task occurrences for a client and the given sub-type and sub-type query.
GET
/v0/taken/employees/{employee_id}/care_task_occurrences/by_sub_type
Returns the care task occurrences for a employee and the given sub-type and sub-type query.
GET
/v0/taken/locations/{location_id}/care_task_occurrences
Returns the care task occurrences of a Location corresponding to the given id.
GET
/v0/taken/locations/{location_id}/care_task_occurrences/by_sub_type
Returns the care task occurrences for a location and the given sub-type and sub-type query.
GET
/v0/taken/teams/{team_id}/care_task_occurrences/by_sub_type
Returns the care task occurrences for a team and the given sub-type and sub-type query.
tasque.CareTaskSeries 1
POST
/v0/taken/care_task_series
Create CareTaskSeries
whismur.CareProviderSetting 1
GET
/v0/whismur/settings
Retrieve speech to text settings for Care Organization
moves.Availability 3
GET
/v0/xstream/availabilities/data
Return all Availability models in a streaming manner
GET
/v0/xstream/availabilities/deletes
Return all Availability models which where deleted since the date given in the request.
GET
/v0/xstream/availabilities/updates
Return all Availability models which where updated since the date given in the request.
moves.AvailabilityType 1
GET
/v0/xstream/availability_types/data
Return all AvailabilityType models in a streaming manner
moves.ExpertiseProfile 3
GET
/v0/xstream/expertise_profiles/data
Return all ExpertiseProfile models in a streaming manner
GET
/v0/xstream/expertise_profiles/deletes
Return all ExpertiseProfile models which where deleted since the date given in the request.
GET
/v0/xstream/expertise_profiles/updates
Return all ExpertiseProfile models which where updated since the date given in the request.
finance.ExportProfile 2
GET
/v0/xstream/export_profiles/data
Return all ExportProfile models in a streaming manner
GET
/v0/xstream/export_profiles/updates
Return all ExportProfile models which where updated since the date given in the request.
finance.FinanceLog 2
GET
/v0/xstream/finance_logs/data
Return all FinanceLog models in a streaming manner
GET
/v0/xstream/finance_logs/updates
Return all FinanceLog models which where updated since the date given in the request.
FreeFieldAssignment 2
GET
/v0/xstream/free_field_assignments/data
Retrieve all entries for freefieldassignments
GET
/v0/xstream/free_field_assignments/updates
Retrieve all updates for freefieldassignments since date
FreeFieldCategory 1
GET
/v0/xstream/free_field_categories/data
Retrieve all entries for freefieldcategories
FreeFieldDefinition 1
GET
/v0/xstream/free_field_definitions/data
Retrieve all entries for freefielddefinitions
groepsplanning.Group 1
GET
/v0/xstream/groepsplanning_groups/data
Return all Group models from groepsplanning in a streaming manner
finance.InvoiceRowFinanceLog 1
GET
/v0/xstream/invoice_row_finance_logs/updates
Return all InvoiceRowFinanceLog models which where updated since the date given in the request.
finance.InvoiceRow 2
GET
/v0/xstream/invoice_rows/data
Return all InvoiceRow models in a streaming manner
GET
/v0/xstream/invoice_rows/updates
Return all InvoiceRow models which where updated since the date given in the request.
finance.Invoice 2
GET
/v0/xstream/invoices/data
Return all Invoice models in a streaming manner
GET
/v0/xstream/invoices/updates
Return all Invoice models which where updated since the date given in the request.
moves.Membership 3
GET
/v0/xstream/memberships/data
Return all Membership models in a streaming manner
GET
/v0/xstream/memberships/deletes
Return all Membership models which where deleted since the date given in the request.
GET
/v0/xstream/memberships/updates
Return all Membership models which where updated since the date given in the request.
finance.Restitution 2
GET
/v0/xstream/restitutions/data
Return all Restitution models in a streaming manner
GET
/v0/xstream/restitutions/updates
Return all Restitution models which where updated since the date given in the request.
moves.Unit 3
GET
/v0/xstream/units/data
Return all Unit models in a streaming manner
GET
/v0/xstream/units/deletes
Return all Unit models which where deleted since the date given in the request.
GET
/v0/xstream/units/updates
Return all Unit models which where updated since the date given in the request.
finance.VecozoInvoiceRelation 2
GET
/v0/xstream/vecozo_invoice_relations/data
Return all VecozoInvoiceRelation models in a streaming manner
GET
/v0/xstream/vecozo_invoice_relations/updates
Return all VecozoInvoiceRelation models which where updated since the date given in the request.
zorgdomein_module.BundleWrapper 1
POST
/v0/zorgdomein_module/cupido/fhir/r3/bundle_wrapper
Create a new item using a FHIR R3 bundle wrapped in a json object
zorgmail_module.DiagnosticProcedure 1
GET
/v0/zorgmail_connector/clients/{client_id}/diagnostic_procedures
Searches for diagnostic procedures.
zorgmail_module.ZorgmailMailboxDto 1
POST
/v0/zorgmail_module/cupido/zorgmail/credentials/validate
validate
carepath.CarePath 2
GET
/v0/zorgpaden/carepath/{uuid}
Fetch a care path
GET
/v0/zorgpaden/carepath/active/{client_id}
Return the active care path for a client.
carepath.Template 2
POST
/v0/zorgpaden/template/v2
Create Template
GET
/v0/zorgpaden/template/v2/{uuid}
Fetch a care path template
Schemas 790
The contract defines 790 schemas that model the data the API accepts and returns. The most detailed are dossier.RestrictiveMeasureCarePlanEntry (59 properties), Debtor (45 properties), tasque.CareTaskOccurrence (42 properties), tasque.CareTaskSeries (37 properties). Each schema is shown below with its type and property counts.
dossier.ReportLinkType
string
ReportLinkType enum (no description)
dossier.ReportFilter
string
ReportFilter model (no description)
agenda.RegistrationStatusType
string
RegistrationStatusType model (no description)
openehr.ArchetypeForm
string
ArchetypeForm enum (no description)
openehr.ReferenceModelObjectForm
string
ReferenceModelObjectForm enum. METADATA: Return only the metadata. referenceModelObject and pathsAndValues will be empty. PATHSANDVALUES: Return the pathsAndVa…
openehr.Scale
string
Requested size for example of an image expressed as enum scale
admin.TimesheetConfig
object
TimesheetConfig model (no description)
7 properties
arrangement.UuidList
object
UuidList model (no description)
1 property
arrangement.Intent
object
Intent of the preference
19 properties
12 required
arrangement.QuantityUnit
string
The Intent's quantity unit, for example MINUTE or HOUR. In combination with the quantity amount, it determines the quantity of th the care that is intended. Fo…
arrangement.RecurrenceType
string
Together with the recurrence interval, the recurrence type determines how the intent is repeated over time. Examples: - 1, WEEK corresponds to 'every week' - 2…
arrangement.list.IntentList
object
IntentList model (no description)
1 property
arrangement.Stakeholder
object
Stakeholder model (no description)
10 properties
3 required
arrangement.TimeSlot
object
TimeSlot of the preference
6 properties
6 required
expense.ExpenseAddressModel
object
Departure location of an employee
4 properties
DepartureLocation
string
DepartureLocation which is used to determine which address should be used for the automated travel calculations
VehicleAssignmentModel
object
Vehicle assignment for a given employee during a given period
6 properties
WpmVehicle
string
The vehicle used for travel by the employee stated in the WPM legislation
Bsn
object
Bsn model (no description)
19 properties
bsn.BsnDocumentType
integer
BsnDocumentType model (no description)
bsn.BsnSource
integer
BsnSource model (no description)
bsn.BsnIdVerifiedType
integer
BsnIdVerifiedType model (no description)
CareProviderAddress
object
CareProviderAddress model (no description)
1 property
Address
object
Address model.
30 properties
CareAllocation
object
CareAllocation model (no description)
9 properties
2 required
CareProvider
object
The source of this MedicationChart. A pharmacy. identificationNumber and companyName should be filled. The identificationNumber should be the AGB-code of the p…
15 properties
ClientAddress
object
ClientAddress model (no description)
1 property
ClientContactRelationAddress
object
ClientContactRelationAddress model (no description)
1 property
ClientContactRelation
object
ClientContactRelation model (no description)
22 properties
AuditedBase
object
AuditedBase model (no description)
3 properties
nexus.ClientContactRelationType
object
Vektiscode
nexus.RelationType
object
RelationType model (no description)
13 properties
nexus.RelationCategory
object
RelationCategory model (no description)
3 properties
nexus.PersonalRelationType
object
Vektiscode
ClientEmployeeRelation
object
ClientEmployeeRelation model (no description)
8 properties
ClientEmployeeRelationType
object
ClientEmployeeRelationType model (no description)
RelationType
object
RelationType model (no description)
13 properties
RelationCategory
object
RelationCategory model (no description)
3 properties
ClientAbsence
object
ClientAbsence domain model used by Cupido system.
9 properties
ClientAbsenceReason
object
ClientAbsenceReason domain model used by Cupido system.
3 properties
Client
object
Client registered on Cupido system.
24 properties
Person
object
Common attributes for Client and Employee.
22 properties
Pronouns
object
The usage of this schema is deprecated and has been replaced by PronounsType.
2 properties
PronounsType
string
Predefined type of pronouns: SHEHER: 'zij/haar', HEHIS: 'hij/hem', WHOTHEIR: 'die/diens', THEMTHEIRS: 'hen/hun'
GenderIdentity
object
The usage of this schema is deprecated and has been replaced by GenderIdentityType.
2 properties
GenderIdentityType
string
Predefined type of gender identity. MALE: 'man', FEMALE: 'vrouw', NONBINARY: 'non-binair'
Document
object
Document model (no description)
12 properties
2 required
RightSelection
string
RightSelection enum (no description)
ExpertiseProfile
object
Model is used to check to see if a person can be connected to a certain {@link HourType}.
8 properties
ExpertiseGroup
object
Model is used to group {@link ExpertiseProfile}'s, with possibly other {@link ExpertiseGroup}'s as parent/children.
6 properties
payroll.CollectiveAgreementAssignment
object
CollectiveAgreementAssignment model Created on 06/05/21.
6 properties
payroll.CollectiveAgreementSetting
object
CollectiveAgreementSetting model Created on 16/12/25.
4 properties
payroll.ClaSettingsOptions
string
Enum defining the supported configuration options that can be applied to collective agreement assignments. SLEEPSHIFTCOMPENSATEINTIME: Determines whether sleep…
payroll.Contract
object
Contract model Created on 22/04/15.
7 properties
dossier.ActionEntry
object
Zorgplan "actie" entry
7 properties
dossier.Action
object
Zorgplan "actie"
11 properties
dossier.Domain
object
Zorgplan "domein"
4 properties
dossier.Goal
object
Zorgplan "doel"
10 properties
dossier.CarePlanEntry
object
"Zorgplan" entry.
11 properties
dossier.DemandEntry
object
Zorgplan "aandachtspunt" entry
5 properties
dossier.Demand
object
Zorgplan "aandachtspunt"
7 properties
dossier.GoalEntry
object
Zorgplan "doel" entry.
7 properties
survey.ImportantForCarePlanGroup
object
ImportantForCarePlanGroup model (no description)
5 properties
survey.AnsweredQuestion
object
AnsweredQuestion model (no description)
1 property
survey.Question
object
Question model (no description)
13 properties
survey.AnswerDefinitionGroup
object
AnswerDefinitionGroup model (no description)
6 properties
survey.AnswerDefinition
object
AnswerDefinition model (no description)
9 properties
survey.Answer
object
Answer model (no description)
7 properties
dossier.CreateCarePlanEntry
object
@deprecated This class is deprecated, at the moment of writing this class there is no way in Cupido to create a model that depends on creations of other models.
4 properties
dossier.CarePlan
object
"Zorgplan"
7 properties
dossier.CarePlanStatus
string
CarePlanStatus enum (no description)
dossier.ClientNote
object
ClientNote model (no description)
1 property
dossier.BaseNote
object
BaseNote model (no description)
8 properties
dossier.MedicalNote
object
MedicalNote model (no description)
1 property
dossier.ReportType
object
ReportType model (no description)
9 properties
dossier.Report
object
The report for which this report right applies
28 properties
1 required
dossier.ReportEntry
object
ReportEntry model (no description)
5 properties
dossier.ReportAction
object
ReportAction model (no description)
2 properties
dossier.ReportAuthorization
object
Only present when dossier.Report.confidential == true, then: - In the case of SOEP-reports (reportType 315), contains all disciplines that can see any of the S…
4 properties
dossier.SoapReportEntry
object
SoapReportEntry model (no description)
5 properties
dossier.SystemNote
object
SystemNote model (no description)
EmployeeAddress
object
EmployeeAddress model (no description)
1 property
Employee
object
Employee model (no description)
16 properties
EmployeePrivacySettings
object
EmployeePrivacySettings model (no description)
5 properties
PractitionerAgbCode
object
PractitionerAgbCode model (no description)
6 properties
PractitionerBigCode
object
PractitionerBigCode model (no description)
3 properties
PractitionerProfession
object
Practioner profession returned from Cupido for an Employee. When PUT-ing or POST-ing PractitionerProfessions, the combination of code and professionType is use…
9 properties
1 required
PractitionerProfessionType
integer
Indicates the codelist this profession orginates from
TeamAssignment
object
Team assignment.
5 properties
ons_administration.WorkdayNormSettingsModel
object
Workday norm settings model. This model describes the maximum workdays a given employee has to work per week during a given measurement period.
9 properties
2 required
ons_administration.ExtendedEmployeeModel
object
Extended employee model containing detailed employee information
27 properties
3 required
ons_administration.Gender
string
Gender of the person: - M: Male - F: Female - X: Other - U: Unknown
ons_administration.NameType
string
Printable format for the name of a person
ons_administration.EmployeeAddressModel
object
Address model for an employee. This model can be used on its own or as part of an extended employee model. When used on its own, either an employeeObjectId or…
14 properties
1 required
ons_administration.EmployeeCollectiveAgreementModel
object
Collective agreement assignment model for an employee. This model can be used on its own or as part of an extended employee model. When used on its own, either…
8 properties
1 required
ons_administration.CollectiveAgreementType
string
Type of collective labour agreement: - VVT: Verpleeg-, Verzorgingshuizen, Thuiszorg en Jeugdgezondheidszorg - GHZ: Gehandicaptenzorg - GGZ: Geestelijke gezondh…
ons_administration.EmployeeContractModel
object
Contract model for an employee. This model can be used on its own or as part of an extended employee model. When used on its own, either an employeeObjectId or…
10 properties
1 required
ons_administration.EmployeeExpertiseModel
object
Expertise profile assignment model for an employee. This model can be used on its own or as part of an extended employee model. When used on its own, either an…
8 properties
1 required
ons_administration.EmployeeHourlyWageModel
object
Hourly wage model for an employee. This model can be used on its own or as part of an extended employee model. When used on its own, either an employeeObjectId…
7 properties
1 required
ons_administration.EmployeeRegistrationProfileModel
object
Registration profile assignment model for an employee. This model can be used on its own or as part of an extended employee model. When used on its own, either…
8 properties
1 required
ons_administration.EmployeeTeamModel
object
Team assignment model for an employee. This model can be used on its own or as part of an extended employee model. When used on its own, either an employeeObje…
8 properties
1 required
ons_administration.EmployeeWorkdayNormSettingsModel
object
Workday norm settings model. This model can be used on its own or as part of an extended employee model. This model describes the maximum workdays a given empl…
10 properties
1 required
evs.ResponseMessage
object
ResponseMessage model (no description)
4 properties
1 required
expense.Expense
object
An expense is a value of some kind (determined) by its type, that an employee will be compensated for (usually via her payroll). Expenses can either be manual…
13 properties
expense.ExpenseDistance
object
An expense distance is the distance traveled to a location (position).
6 properties
registration.Position
object
A Position denotes a physical location on a map. This position can either consist of address information, a longitude/latitude pair or both. Not all fields are…
9 properties
ExpertiseProfileAssignmentUpdateModel
object
Expertise profile assignment model for creating and modifying.
2 properties
finance.CareOrderProduct
object
CareOrderProduct model (no description)
19 properties
finance.CareOrder
object
CareOrder model (no description)
16 properties
finance.DeclarationRule
object
Declaration Rule retrieved from OnsAdmin.
30 properties
Period
object
Based on http://hl7.org/fhir/STU3/datatypes.htmlperiod
2 properties
finance.ForensicCareOrder
object
ForensicCareOrder model (no description)
9 properties
Insurance
object
Insurance entry for a Client.
19 properties
6 required
Debtor
object
Debtor entry returned from Cupido.
45 properties
BankAccount
object
BankAccount model (no description)
10 properties
InsuranceType
string
Insurance type. Possible values: BV (Basis Verzekering) AV (Aanvullende Verzekering) TV (Tand Verzekering) HV (Hoofd Verzekering)
jw.JwZorglegitimatie
object
JwZorglegitimatie model (no description)
3 properties
3 required
lz.Bericht
object
Bericht model (no description)
1 property
1 required
LocationAssignmentResidence
object
LocationAssignmentResidence model (no description)
3 properties
LocationAssignment
object
LocationAssignment model (no description)
12 properties
LocationAssignmentType
string
LocationAssignmentType enum (no description)
LocationAssignmentWaitingList
object
Developed as a (temporary) solution to enable (GGZ) customers to indicate a client is on a 'waiting list'
5 properties
Location
object
Location model (no description)
25 properties
dossier.omaha.OmahaClassification
object
represents a full Omaha classification for one client, including both problem and intervention classification
15 properties
dossier.omaha.ClassifiedProblem
object
(nl) Omaha Gebieden
15 properties
dossier.omaha.ClassifiedSignOrSymptom
object
(nl) Omaha 'Signalen en symptomen'
2 properties
dossier.omaha.SignOrSymptom
object
Omaha definitie van 'signalen en symptomen'
4 properties
dossier.omaha.ClassifiedIntervention
object
(nl) Omaha Acties
6 properties
dossier.omaha.InterventionCategory
object
Omaha soort actie
2 properties
dossier.omaha.InterventionTarget
object
Omaha Actievlak
2 properties
dossier.omaha.ModifierReach
string
(nl) Omaha kenmerken (1/2)
dossier.omaha.ModifierProblemLevel
string
(nl) Omaha kenmerken (2/2)
dossier.omaha.Problem
object
Omaha definitie van 'gebied'
4 properties
dossier.omaha.Domain
object
Omaha Domein
2 properties
dossier.omaha.ClassificationStatus
string
Status of this omaha classification
Referral
object
Referral model (no description)
10 properties
survey.SurveyResult
object
SurveyResult model (no description)
16 properties
survey.SurveyResultStatus
string
SurveyResultStatus model (no description)
Ability
object
Ability model (no description)
3 properties
survey.GroupAnswer
object
GroupAnswer model (no description)
5 properties
survey.Survey
object
Survey model (no description)
19 properties
survey.Category
object
Category model (no description)
6 properties
survey.Group
object
Group model (no description)
8 properties
TeamAddress
object
The address of a team
1 property
User
object
User model (no description)
27 properties
Role
object
Role model (no description)
2 properties
PasswordChange
object
PasswordChange model (no description)
2 properties
wlz.WlzZorglegitimatie
object
WlzZorglegitimatie model (no description)
3 properties
3 required
wmo.WmoZorglegitimatie
object
WmoZorglegitimatie model (no description)
3 properties
3 required
zpm.CareOrderZpmDetails
object
Contains ZPM specific details belonging to a {@link com.nedap.healthcare.domain.finance.CareOrder}.
12 properties
zpm.CareOrderZpmSetting
object
Describes which {@link ZpmSetting} is applicable to a {@link com.nedap.healthcare.domain.finance.CareOrder} over a period of time.
5 properties
2 required
zpm.CareOrderZpmZorglabel
object
Describes which {@link ZpmZorglabel} is applicable to a {@link com.nedap.healthcare.domain.finance.CareOrder} over a period of time.
6 properties
2 required
zpm.CareOrderZpmReferral
object
Describes which {@link com.nedap.healthcare.domain.Referral} is applicable to a {@link com.nedap.healthcare.domain.finance.CareOrder} over a period of time.
5 properties
2 required
zpm.CareOrderZpmRegiebehandelaar
object
Describes which {@link com.nedap.healthcare.domain.Employee ZPM regiebehandelaar} is applicable to a {@link com.nedap.healthcare.domain.finance.CareOrder} over…
5 properties
2 required
zpm.CareOrderZpmTariefniveau
object
Describes which ZPM tariefniveau is applicable to a {@link com.nedap.healthcare.domain.finance.CareOrder} over a period of time.
5 properties
2 required
zpm.CareOrderZpmForensischeZorgtitel
object
Describes which ZPM forensische zorgtitel is applicable to a {@link com.nedap.healthcare.domain.finance.CareOrder} over a period of time.
5 properties
2 required
zpm.CareOrderZpmPlaatsingsbesluitnummer
object
Describes which ZPM plaatsingsbesluitnummer is applicable to a {@link com.nedap.healthcare.domain.finance.CareOrder} over a period of time.
6 properties
2 required
zpm.CareOrderZpmTreatmentLocation
object
Describes which ZPM treatment location is applicable to a {@link com.nedap.healthcare.domain.finance.CareOrder} over a period of time.
5 properties
2 required
zpm.CareOrderZpmMachtigingsnummer
object
Describes which ZPM machtigingsnummer is applicable to a {@link com.nedap.healthcare.domain.finance.CareOrder} over a period of time.
5 properties
2 required
zpm.CareOrderZpmGbggzProfiel
object
Describes which {@link ZpmGbggzProfiel} is applicable to a {@link com.nedap.healthcare.domain.finance.CareOrder} over a period of time.
5 properties
2 required
agenda.AgendaOccurrence
object
Agenda series domain model used by Cupido system.
33 properties
agenda.AgendaInvitation
object
Agenda invitation domain model used by Cupido system.
6 properties
agenda.AgendaClientInvitation
object
Agenda client invitation domain model used by Cupido system.
3 properties
agenda.Label
object
Domain model for Labels for AgendaOccurrences/AgendaSeries
2 properties
RecurrenceType
string
Frequency of the recurrence
agenda.AgendaSeries
object
Agenda series domain model used by Cupido system.
30 properties
3 required
agenda.ReservationCreate
object
Request body used to create a reservation. When a recurrenceRule is supplied, startsAt must be on or before its repeatUntil.
5 properties
3 required
agenda.RecurrenceRule
object
Object describing the recurrence. This object may be omitted, in that case a single occurrence is created
4 properties
1 required
agenda.RecurrenceType
string
When no value is supplied, it defaults to single. Specifies the recurrence rule: single: The entry only occurs a single time, no recurrence is used. daily: The…
agenda.ReservationUpdate
object
Request body used to update a reservation. All fields are optional; when a recurrenceRule is supplied, startsAt must be on or before its repeatUntil.
4 properties
agenda.Unavailability
object
Domain model for the Agenda Unavailabilities
7 properties
3 required
authorization.provisioning.User
object
User model (no description)
5 properties
authorization.provisioning.Duty
object
Duty is a role assigned to the user. It consists of roleUuid, the validity timeline, and scoping policy options, determining what clients and/or employees will…
12 properties
authorization.provisioning.UserDuties
object
3 properties
authorization.provisioning.UserDuty
object
Duty is a role assigned to the user. It consists of roleUuid, the validity timeline, and scoping policy options, determining what clients and/or employees will…
16 properties
authorization.provisioning.MyLocations
object
My locations is a list of locations an employee should have access on a regular basis. This can be used by the role assignment to describe for which clients ar…
1 property
authorization.provisioning.MyTeams
object
My teams is a list of teams an employee should have access on a regular basis. This can be used by the role assignment to describe for which employees are acce…
1 property
authorization.provisioning.UserScopeSettings
object
1 property
authorization.provisioning.UserLegacyAuthScopingOptions
object
3 properties
authorization.provisioning.DefaultScope
object
The default scope is a set of groups which can be used by role assignments to describe for which clients or employees are accessible. To assign roles with the…
6 properties
kamino.KaminoSetting
object
KaminoSetting model (no description)
1 property
caretech.OrderStatus
string
The status of an order, can be OPEN, DECLINED, ACCEPTED or COMPLETED
caretech.OrderStatusUpdate
object
Object for updating a set of fields related to a caretech Order
5 properties
1 required
caretech.ProductAllocation
object
Caretech product which is allocated by a client
11 properties
2 required
caretech.ProductInstanceDto
object
Reference to a caretech product instance
6 properties
1 required
caretech.ProductDto
object
Caretech product
9 properties
caretech.Status
string
The status of a product allocation, can be REQUEST, ACTIVE, INACTIVE or UNKNOWN
caretech.ReturnRequestStatus
string
The status of a return request, can be OPEN, DECLINED, ACCEPTED or COMPLETED
caretech.ReturnRequestUpdate
object
ReturnRequestUpdate model (no description)
4 properties
1 required
caretech.ReturnRequestStatusUpdate
string
The status update of a return request, can be DECLINED, ACCEPTED or COMPLETED
client_story.Story
object
Story model (no description)
6 properties
client_story.Category
object
Category model (no description)
4 properties
client_story.Answer
object
Answer model (no description)
3 properties
client_story.AccessLevel
string
The access level of the story, can be NONE, READONLY, or READWRITE
dbc.ggz.Zorgtraject
object
The corresponding dbc.ggz.Zorgtraject, Only filled in when possible, can be null
17 properties
2 required
dbc.ggz.SoortVerwijzer
object
The type of practitioner of this DBC Part of a code list of the NZA
dbc.StamData
object
Base class for a code list of the NZA. See documentation at https://puc.overheid.nl/nza/zorgsectoren/pagina/NZA003b/-/gdlv/1/p/1/
5 properties
1 required
dbc.ggz.Zorgdomein
object
The zorgdomein as specified by the NZA code lists.
dbc.ggz.DiagnoseToekenning
object
A diagnosis which has been assigned to a client.
8 properties
2 required
dbc.ggz.Diagnose
object
NZA code list values for Diagnosis
18 properties
dbc.ggz.Subtraject
object
The corresponding dbc.ggz.Subtraject, Only filled in when possible, can be null
32 properties
2 required
dbc.ggz.RedenSluiten
object
The reason for closing a DBC or DBBC (Subtraject)
2 properties
dbc.ggz.Zorgtype
object
Type of care provided in this DBC
7 properties
dbc.ggz.Circuit
object
The care circuit, dealing with youth, adult or forensic types of care Part of a code list of the NZA
2 properties
dbc.ggz.grouper.GrouperResultaat
object
A 'grouping' result of a DBC or DBBC. This result is recalculated every time changes are made to the DBC/DBBC (Subtraject), Zorgtraject or activities. Contains…
6 properties
5 required
dbc.ggz.ProductGroep
object
The product group which was calculated.
7 properties
dbc.ggz.Tijdschrijven
object
Tijdschrijven model (no description)
5 properties
3 required
dbc.ggz.Zorgactiviteit
object
A base class for an Activity which a client performs
5 properties
3 required
dbc.ggz.Activiteit
object
The activity that the client performed
12 properties
dbc.ggz.Dagbesteding
object
An activity which the client performs during the day
2 properties
1 required
dbc.ggz.Verblijfsdag
object
A period of time that a client has stayed at a location.
2 properties
1 required
dbc.ggz.Verrichting
object
Some operation/treatment that has been performed on/with the client, such as Electroconvulsive therapy (ECT)
2 properties
1 required
dbc.ggz.fz.Subtraject
object
A Forensic DBBC. Causes the creation of a ForensicCareOrder.
7 properties
dbc.ggz.fz.ForensischeZorgtitel
object
Forensic care title which defines the funding basis for compensation with DJI
5 properties
dbc.ggz.fz.AardDelict
object
The type of delinquency the client performed
dbc.ggz.fz.Gevaar
object
The measure of danger this client imposes
dbc.ggz.list.DiagnoseToekenningList
object
DiagnoseToekenningList model (no description)
1 property
dienst_verwijzen_module.BundleWrapper
object
BundleWrapper model for transporting HL7 FHIR DSTU3 bundle data to the Dienst Verwijzen module.
1 property
1 required
dossier.admin.alerts.Topic
object
Topic model (no description)
7 properties
dossier.Alert
object
Alert model (no description)
18 properties
dossier.medical.MedicalBase
object
MedicalBase model (no description)
7 properties
dossier.Encoding
object
Encoding
3 properties
dossier.FeederAuditContentStoreType
string
Identifier of the content store that is providing this content
dossier.FeederAuditTransferType
string
Type of the transfer containing this content (a.k.a. the use case)
dossier.medical.PropensityToAdverseReaction
object
PropensityToAdverseReaction model (no description)
18 properties
dossier.medical.encoded_concepts.CausativeAgent
object
CausativeAgent model (no description)
2 properties
dossier.snomed.ClinicalFinding
string
ClinicalFinding enum (no description)
dossier.medical.CauseBuilder
object
CauseBuilder model (no description)
dossier.medical.RelationshipBuilder
object
RelationshipBuilder model (no description)
3 properties
dossier.RestrictiveMeasureRegistration
object
RestrictiveMeasureRegistration model (no description)
13 properties
dossier.RestrictiveMeasureCarePlanEntry
object
RestrictiveMeasureCarePlanEntry model (no description)
59 properties
dossier.RestrictiveMeasureEntry
object
RestrictiveMeasureEntry model (no description)
20 properties
dossier.medical.DeviceBuilder
object
DeviceBuilder model (no description)
dossier.medical.Device
object
Optional device that was used as a restrictive measure
2 properties
dossier.RestrictiveMeasureEvaluation
object
RestrictiveMeasureEvaluation model (no description)
2 properties
dossier.RestrictiveMeasureCarePlanEntryReason
object
A reason for a {@link RestrictiveMeasureCarePlanEntry}.
2 properties
dossier.RestrictiveMeasureCarePlanEntryProblemNarrative
object
A problem narrative for a {@link RestrictiveMeasureCarePlanEntry}.
2 properties
dossier.RestrictiveMeasureCarePlanEntryJudgement
object
RestrictiveMeasureCarePlanEntryJudgement model (no description)
11 properties
dossier.episodes.Episode
object
Episode model (no description)
18 properties
dossier.episodes.SubGoal
object
SubGoal model (no description)
5 properties
dossier.episodes.Action
object
Action model (no description)
5 properties
dossier.episodes.EpisodeDocument
object
EpisodeDocument model
2 properties
dossier.medical.advance_directives.Context
object
The current medical policy of the client
11 properties
dossier.medical.DecisionBuilder
object
DecisionBuilder model (no description)
1 property
dossier.medical.advance_directives.Decision
object
Decision model (no description)
3 properties
dossier.medical.advance_directives.context.StatusKey
string
The status of the AdvanceDirective Context.
dossier.medical.dsm.ClassificationSeries
object
ClassificationSeries model (no description)
6 properties
dossier.medical.dsm.Classification
object
Classification model (no description)
16 properties
dossier.medical.dsm.Finding
object
Finding model (no description)
10 properties
dossier.medical.dsm.Evaluation
object
Evaluation model (no description)
2 properties
dossier.medical.involuntary_care.Incompetence
object
An incompetence of a client
6 properties
dossier.medical.involuntary_care.LegalStatus
object
The legal status of a client.
14 properties
dossier.medical.involuntary_care.LegalStatusDocument
object
LegalStatusDocument model (no description)
4 properties
dossier.medical.involuntary_care.LegalStatusSuspension
object
LegalStatusSuspension model (no description)
10 properties
dossier.medical.involuntary_care.LegalGround
object
LegalGround model (no description)
9 properties
dossier.medical.involuntary_care.LegalStatusTypeCode
string
Unique code that identifies the legal status type
dossier.medical.Problem
object
Problem model (no description)
23 properties
dossier.medical.DiagnosisBuilder
object
DiagnosisBuilder model (no description)
dossier.medical.Diagnosis
object
Diagnosis model (no description)
3 properties
dossier.medical.SimplifiedPropensityToAdverseReaction
object
SimplifiedPropensityToAdverseReaction model (no description)
3 properties
fvc.FvcMessage
object
FvcMessage model (no description)
2 properties
2 required
groupcare.Group
object
Group model (no description)
24 properties
onsimport.Run
object
A collection of records to be imported via Ons Import. Records can be added by uploading XML or binary files via RunAPI.
4 properties
1 required
onsimport.BinaryFileRequest
object
Contains a binary file to be added to a run in Ons Import.
3 properties
onsimport.RecordsXmlRequest
object
Contains records to be added to a run in Ons Import, formatted as XML as specified by the Ons Import XSD.
2 properties
harmony.BundleWrapper
object
BundleWrapper model (no description)
harmony.ZorgdomeinFhirConnector
object
This object can be used to transport HL7 FHIR dstu3 bundle data to Ketenverkeer (Harmony).
1 property
1 required
medication.DoubleCheckChange
object
DoubleCheckChange represents a state change on a DoubleCheck. It can be viewed as a log of DoubleCheck changes over time.
7 properties
medication.MedicationAdministrationStatus
string
A recorded status of a medication administration by a care worker.
hermes.ContactMethodConfig
object
This class is used to update notification settings for Clients.
2 properties
2 required
hermes.Notification
object
Notification model (no description)
18 properties
hermes.Recipient
object
The method belongs to a recipient
3 properties
nexus.ClientEmployeeRelation
object
ClientEmployeeRelation model (no description)
8 properties
nexus.ClientEmployeeRelationType
object
ClientEmployeeRelationType model (no description)
openehr.CompositionWrapper
object
OpenEHR CompositionWrapper model, including relevant metadata. Object to return an CompositionWrapper, which extends from the ReferenceModelObjectWrapper See a…
2 properties
openehr.ReferenceModelObjectWrapper
object
OpenEHR Reference Model Object Wrapper model. Object to return an ReferenceModelObjectWrapper. This is the superclass of every object in an EHR, such as Stored…
22 properties
openehr.ItemTag
object
OpenEHR ItemTag, which is a tag with a key and optional value that is associated with a target ReferenceModelObjectWrapper.
4 properties
1 required
openehr.Instruction
object
Contains metadata of an ons-ehr-db Instruction like it's path within a composition, the aggregated state and the receivers of the Instruction.
8 properties
openehr.InstructionState
string
The aggregated state of the instruction.
openehr.Receiver
object
Contains information about the receiving ons-ehr-db Person or EmployeeGroup.
6 properties
openehr.EmployeeGroup
object
Employee group used for authorizations in {@link ArchetypeWrapper} and {@link CompositionWrapper}. Employee groups can be based on {@link com.nedap.healthcare.…
13 properties
openehr.LifecycleState
string
The lifecycle state of a composition version.
openehr.list.ItemTagList
object
List of openEHR ItemTags.
1 property
openehr.list.ArchetypeSelectionList
object
List of archetypes and paths to request the values of
1 property
openehr.ArchetypeSelection
object
Requested archetype id and the paths to get the values for, optionally limited by a start and/or end date/time.
5 properties
openehr.MultimediaFileCreateRequest
object
MultimediaFileCreateRequest model (no description)
2 properties
2 required
openehr.MultimediaFile
object
A JSON object with metadata of the multimedia file
5 properties
openehr.CompositionIdList
object
CompositionIdList model (no description)
1 property
moves.ContainerSearchRequest
object
The request body used to search for containers
5 properties
2 required
moves.EmployeeExportJob
object
EmployeeExportJob model (no description)
5 properties
PresenceLog
object
PresenceLog model (no description)
29 properties
PresenceLogAction
string
PresenceLogAction model (no description)
PresenceLogLocation
object
PresenceLogLocation model (no description)
8 properties
PresenceLogPermission
object
PresenceLogPermission model (no description)
4 properties
PresenceLogMetadata
object
Metadata corresponding to the presence log
1 property
PresenceLogProduct
object
Product stored within {@link PresenceLog}.
6 properties
PresenceLogORT
object
PresenceLogORT model (no description)
5 properties
moves.AbsenceUpsert
object
Experimental API. An absence to be processed as a signal from a remote system. Absences created through this API are not shown in the UI yet.
7 properties
1 required
moves.AbsenceType
string
The type of absence. Possible values: - A: adoptie - B: bedrijfsongeval - D: arbeidsongeschiktdoorderde - O: overigongeval - P: pleegzorg - Z: ziek - ZB: zieka…
moves.FlexSignupRequest
object
FlexSignupRequest model (no description)
2 properties
2 required
moves.PlanCardOccurrenceAttributesRequest
object
Incidentally update a plan card occurrence, for example by canceling a single care moment
5 properties
4 required
moves.PlanCardOccurrencePlanRequest
object
Moves a single plan card to another time and order in a container
9 properties
4 required
moves.ContainerAssignment
object
An assignment of a plan card to a specific container ( shift or employee ) on a specific date. 'null' refers to being unplanned
2 properties
2 required
moves.PlanCardOccurrenceId
object
A set of identifiers linking to a single PlanCardOccurrence with additional checksums for mutation validations.
3 properties
3 required
moves.ShiftAssignment
object
Updated by Jurriën Gosselink on 04-03-19
22 properties
tasque.CareTaskGroup
object
Group of tasks with the same subtype
5 properties
1 required
tasque.CareTaskOccurrence
object
Care Task occurrence domain model used by Cupido system. Only used for read, update and deleting existing care tasks
42 properties
tasque.Executor
object
Executor model (no description)
5 properties
tasque.Subject
object
A client, employee, location or team
4 properties
tasque.CareTaskSeries
object
Care Task series domain model used by Cupido system. Only used for creating new care tasks
37 properties
zorgdomein_module.BundleWrapper
object
BundleWrapper model for transporting HL7 FHIR DSTU3 bundle data to the Zorgdomein module.
1 property
1 required
zorgmail_module.ZorgmailMailboxDto
object
Zorgmail Mailbox model.
4 properties
carepath.Template
object
A template which may be used for creating care paths for clients using the web interface
4 properties
3 required
carepath.ModuleTemplate
object
ModuleTemplate model (no description)
7 properties
3 required
carepath.IntentTemplate
object
Mostly copied from Intent, but without client information and using relative offsets. @see com.nedap.healthcare.domain.arrangement.Intent
11 properties
9 required
payroll.AccountEntry
object
AccountEntry model (no description)
15 properties
payroll.SubType
string
SubType model (no description)
payroll.list.AccountEntryList
object
AccountEntryList model (no description)
1 property
payroll.list.AccountTypeExpireStatisticList
object
AccountTypeExpireStatisticList model (no description)
1 property
payroll.AccountTypeExpireStatistic
object
AccountTypeExpireStatistic model (no description)
5 properties
payroll.list.AccountTypeList
object
AccountTypeList model (no description)
1 property
payroll.AccountType
object
AccountType model (no description)
9 properties
admin.BackgroundImage
object
BackgroundImage model (no description)
3 properties
admin.list.LicenseList
object
LicenseList model (no description)
1 property
admin.License
object
Licenses that are maintained in Ons Administratie
3 properties
admin.LogoImage
object
Used for logo image
1 property
admin.Version
object
Version model (no description)
3 properties
list.AgbcodeList
object
AgbcodeList model (no description)
1 property
Agbcode
object
Agbcode model (no description)
4 properties
arrangement.list.IntentPreferenceList
object
IntentPreferenceList model (no description)
1 property
arrangement.IntentPreference
object
IntentPreference model (no description)
2 properties
2 required
arrangement.list.StakeholderList
object
StakeholderList model (no description)
1 property
arrangement.list.TimeSlotList
object
TimeSlotList model (no description)
1 property
expense.list.ExpenseAddressModelList
object
List of departe location settings (ExpenseAddressModel) for an employee
1 property
list.VehicleAssignmentModelList
object
VehicleAssignmentModel list
1 property
capacity.list.CapacityProfileList
object
CapacityProfileList model (no description)
1 property
capacity.CapacityProfile
object
CapacityProfile is a profile used for capacity management. Every profile can contain multiple {@link CapacityCategory} instances. Every {@link CapacityCategory…
9 properties
2 required
capacity.CapacityCategory
object
Every CapacityCategory is defined for a single {@link FinanceType}. CapacityCategory is a category that can have multiple {@link CapacityExpertiseProfileAssign…
9 properties
4 required
capacity.CapacityExpertiseProfileAssignment
object
CapacityExpertiseProfileAssignment specifies a link between a {@link CapacityCategory} and an {@link ExpertiseProfile}.
6 properties
3 required
capacity.CapacityExpertiseGroupAssignment
object
CapacityExpertiseProfileAssignment specifies a link between a {@link CapacityCategory} and an {@link ExpertiseGroup}.
6 properties
3 required
finance.FinanceType
object
{@link FinanceType} for which this profile is defined.
16 properties
finance.Shape
string
This is the shape of the icon used in Administration
list.AddressList
object
AddressList model (no description)
1 property
list.CareProviderList
object
CareProviderList model (no description)
1 property
list.ClientContactRelationTypeList
object
ClientContactRelationTypeList model (no description)
1 property
ClientContactRelationType
object
ClientContactRelationType model (no description)
list.ClientContactRelationList
object
ClientContactRelationList model (no description)
1 property
list.ClientEmployeeRelationTypeList
object
ClientEmployeeRelationTypeList model (no description)
1 property
list.ClientAbsenceReasonList
object
ClientAbsenceReasonList model (no description)
1 property
list.ClientAbsenceList
object
ClientAbsenceList model (no description)
1 property
ClientsInCare
object
ClientsInCare model (no description)
5 properties
list.CareAllocationList
object
CareAllocationList model (no description)
1 property
list.CareArrangementList
object
CareArrangementList model (no description)
1 property
CareArrangement
object
Care arrangement domain model.
15 properties
list.ClientEmployeeRelationList
object
ClientEmployeeRelationList model (no description)
1 property
list.ClientCardList
object
ClientCardList model (no description)
1 property
ClientCard
object
Card model.
7 properties
TokenStatus
string
TokenStatus model (no description)
list.LocationList
object
LocationList model (no description)
1 property
nuts.list.ConsentList
object
ConsentList model (no description)
1 property
nuts.Consent
object
Consent model (no description)
13 properties
list.DebtorList
object
DebtorList model (no description)
1 property
list.DocumentList
object
DocumentList model (no description)
1 property
list.InsuranceList
object
InsuranceList model (no description)
1 property
list.LocationAssignmentList
object
LocationAssignmentList model (no description)
1 property
list.PresenceLogList
object
PresenceLogList model (no description)
1 property
list.LocationAssignmentWaitingListList
object
LocationAssignmentWaitingListList model (no description)
1 property
list.ClientList
object
ClientList model (no description)
1 property
list.ClientSearchResultList
object
ClientSearchResultList model (no description)
1 property
ClientSearchResult
object
Search Result after querying OnsAdmin
19 properties
ClientSearchResultGroup
string
The group to which this result belongs. This is only set after calling the 'searchGrouped' API.
list.ClientObjectIdList
object
List of clientObjectIds
1 property
ClientObjectId
object
id of a Client object
1 property
1 required
payroll.list.CollectiveAgreementAssignmentList
object
CollectiveAgreementAssignmentList model (no description)
1 property
payroll.CollectiveAgreementRule
object
CollectiveAgreementRule model Created on 06/05/21.
5 properties
payroll.list.CollectiveAgreementRuleList
object
CollectiveAgreementRuleList model (no description)
1 property
payroll.list.CollectiveAgreementList
object
CollectiveAgreementList model (no description)
1 property
payroll.CollectiveAgreement
object
CollectiveAgreement model Created on 06/05/21.
2 properties
payroll.ContractType
object
ContractType model Created on 22/04/15.
5 properties
list.CostCenterSelectionOptionList
object
CostCenterSelectionOptionList model (no description)
1 property
CostCenterSelectionOption
object
CostCenterSelectionOption model (no description)
4 properties
CostCenterSelectionOptionCategory
string
A category about the cost center; can be COMMON/OWNTEAM/CLIENTCOSTCENTER/OTHER.
list.DashboardProfileList
object
List of dashboard profiles
1 property
DashboardProfile
object
Dashboard profile in Ons Administratie
2 properties
dbc.DBCSubTraject
object
DBC sub traject, a.k.a. DBCCareOrder in Administration.
23 properties
dbc.list.DBCSubTrajectList
object
DBCSubTrajectList model (no description)
1 property
dbc.DBCTraject
object
DBC traject, a.k.a. DBCCarePlan in Administration.
15 properties
dbc.list.DBCTrajectList
object
DBCTrajectList model (no description)
1 property
dossier.list.ActionList
object
ActionList model (no description)
1 property
dossier.list.ActionEntryList
object
ActionEntryList model (no description)
1 property
dossier.list.CarePlanReportRightList
object
CarePlanReportRightList model (no description)
1 property
dossier.CarePlanReportRight
object
CarePlanReportRight model (no description)
7 properties
dossier.ReportRightType
string
ReportRightType enum (no description)
dossier.list.CarePlanEntryList
object
CarePlanEntryList model (no description)
1 property
dossier.list.CarePlanList
object
CarePlanList model (no description)
1 property
dossier.list.ClientNoteList
object
ClientNoteList model (no description)
1 property
dossier.list.GoalList
object
GoalList model (no description)
1 property
dossier.list.DemandList
object
DemandList model (no description)
1 property
dossier.list.DomainList
object
DomainList model (no description)
1 property
dossier.list.MedicalNoteList
object
MedicalNoteList model (no description)
1 property
dossier.list.ReportTypeList
object
ReportTypeList model (no description)
1 property
dossier.list.ReportList
object
ReportList model (no description)
1 property
dossier.list.ReportAuthorizationList
object
ReportAuthorizationList model (no description)
1 property
dossier.list.SystemNoteList
object
SystemNoteList model (no description)
1 property
list.PractitionerAgbCodeList
object
PractitionerAgbCodeList model (no description)
1 property
list.PractitionerBigCodeList
object
PractitionerBigCodeList model (no description)
1 property
list.TeamList
object
TeamList model (no description)
1 property
Team
object
Team (Cluster)
10 properties
payroll.list.ContractList
object
ContractList model (no description)
1 property
list.ExpertiseProfileAssignmentList
object
ExpertiseProfileAssignmentList model (no description)
1 property
ExpertiseProfileAssignment
object
Expertise profile assignment.
5 properties
list.ExpertiseProfileList
object
ExpertiseProfileList model (no description)
1 property
list.PractitionerProfessionList
object
PractitionerProfessionList model (no description)
1 property
list.TeamAssignmentList
object
TeamAssignmentList model (no description)
1 property
WeeksheetProfile
object
The weeksheet profile. It contains information about registration deadlines and permissions.
16 properties
ProfilePolicy
object
Contains the weeksheet profile policy
19 properties
list.ProfileActivityAssignmentList
object
ProfileActivityAssignmentList model (no description)
1 property
ProfileActivityAssignment
object
The difference hourtypes from the employees weekcard profile (direct, indirect (time), indirect (duration))
6 properties
HourType
object
A.K.A. Activity.
22 properties
expense.ExpenseType
object
ExpenseType domain model used by Cupido system. An Expensetype is a type of expense for which an employee may be compensated.
18 properties
ons_administration.list.WorkdayNormSettingsModelList
object
List of WorkdayNormSettingsModels
1 property
list.EmployeeList
object
EmployeeList model (no description)
1 property
ProblemResponse
object
Problem JSON response format, mostly following RFC 9457, but slightly adapted to Nedap's needs.
7 properties
2 required
ProblemResponseReason
object
Reasons for a problem response, lists attributes of the main or nested object sent
3 properties
2 required
ons_administration.list.TimeCompensationFactorModelList
object
List of TimeCompensationFactorModels
1 property
ons_administration.TimeCompensationFactorModel
object
This model gives the time compensation factor (minimum wage divided by hourly wage) for a GHZ employee when time compensation is enabled on the CLA asssignment
5 properties
ons_administration.TimeCompensationFactorStatus
string
Information on the factor computation: COMPENSATIONINTIME, COMPENSATIONINMONEY, COMPENSATIONINTIMEWITHMISSINGHOURLYWAGE, DEFAULTCOMPENSATIONINMONEY, DEFAULTCOM…
ons_administration.list.WorkdayNormPeriodModelList
object
List of WorkdayNormPeriodModels
1 property
ons_administration.WorkdayNormPeriodModel
object
Model for a workday norm period. This model contains the current state of the workday norm for a given employee. This model contains norm, length and already r…
7 properties
ons_administration.list.EmployeeWorkdaysOverviewModelList
object
List of EmployeeWorkdaysOverviewModel
1 property
ons_administration.EmployeeWorkdaysOverviewModel
object
Model for the workday overview for the workday norm clause. Note that this can deviate from workday counts produced bij salary exports or reports, since these…
4 properties
evs.EvsAbility
object
EvsAbility model (no description)
2 properties
expense.list.ExpenseTypeList
object
ExpenseTypeList model (no description)
1 property
expense.list.ExpenseList
object
ExpenseList model (no description)
1 property
list.ExpertiseGroupList
object
ExpertiseGroupList model (no description)
1 property
list.HourTypeList
object
HourTypeList model (no description)
1 property
export.ExportUuid
object
Export Status entry returned from Cupido.
1 property
export.list.ExportPresenceLogList
object
ExportPresenceLogList model (no description)
1 property
export.ExportPresenceLog
object
Export presence log entry returned from Cupido.
10 properties
export.ExportStatus
object
Export Status entry returned from Cupido.
3 properties
export.ExportStatusType
string
ExportStatusType enum (no description)
export.ExportSetting
object
ExportSetting model (no description)
2 properties
finance.list.GroupActivityModelList
object
List of group activity models
1 property
finance.GroupActivityModel
object
A group-level finance activity used by the finance API. Use this model as the request body when creating or updating a group activity and as the response paylo…
4 properties
1 required
finance.NamedItemModel
object
Simple reference model used for small id+name pairs across the finance API. Use NamedItemModel when an API needs to reference another entity by its identifier…
2 properties
2 required
finance.list.GroupActivitySuggestionModelList
object
List of group activity suggestions
1 property
finance.GroupActivitySuggestionModel
object
Request model for proposing or storing a suggestion for a client. Contains the target client, optional chosen activity and zero-or-more surcharge activity ids.
3 properties
2 required
finance.list.CareOrderProductList
object
CareOrderProductList model (no description)
1 property
finance.list.CareOrderList
object
CareOrderList model (no description)
1 property
finance.list.ClientFinancedProductList
object
ClientFinancedProductList model (no description)
1 property
finance.ClientFinancedProduct
object
ClientFinancedProduct model (no description)
3 properties
finance.FinancedProduct
object
FinancedProduct model (no description)
3 properties
finance.list.DeclarationRuleList
object
DeclarationRuleList model (no description)
1 property
BooleanWithReason
object
This class is used to answer a simple true/false question with an optional reason.
2 properties
1 required
DateWrapper
object
DateWrapper can be used to return date's from API calls.
1 property
finance.list.ProductList
object
ProductList model (no description)
1 property
finance.Product
object
Product model (no description)
10 properties
finance.list.InvoiceProviderGroupList
object
InvoiceProviderGroupList model (no description)
1 property
finance.InvoiceProviderGroup
object
An 'InvoiceProviderGroup' models a specific type of 'ExportProfile', i.e., export profiles for which it holds that they have a property set for 'koepel' and ha…
7 properties
finance.list.ParallelCareOrderList
object
ParallelCareOrderList model (no description)
1 property
finance.ParallelCareOrder
object
Model class holding @Author joel.witteveen
8 properties
RegisteredUnit
string
The unit of totalRegisteredAmount and maxRegisteredAmount
payroll.holiday.list.HolidayList
object
HolidayList model (no description)
1 property
payroll.holiday.Holiday
object
Holiday model (no description)
4 properties
list.HourTypeCategoryList
object
HourTypeCategoryList model (no description)
1 property
HourTypeCategory
object
Category for {@link HourType}.
2 properties
list.HourTypeProductAssignmentList
object
HourTypeProductAssignmentList model (no description)
1 property
HourTypeProductAssignment
object
A.K.A. ProductActivityAssignment in IOServer
12 properties
ons_administration.list.WorkdayHourTypeModelList
object
List of WorkdayHourTypeModels
1 property
ons_administration.WorkdayHourTypeModel
object
This model describes when a given hour type (activity) will be counted as a workday according to the workday norm.
2 properties
1 required
payroll.HourlyWage
object
HourlyWage model (no description)
7 properties
payroll.list.HourlyWageList
object
HourlyWageList model (no description)
1 property
list.LocationAssignmentResidenceList
object
LocationAssignmentResidenceList model (no description)
1 property
list.NavigationAvailabilityList
object
List of navigation items with their availability
1 property
NavigationAvailability
object
A navigation item with its availability
2 properties
NavigationAvailabilityKey
string
Item for navigation availability request
NavigationAvailabilityState
string
Item for navigation availability request
dossier.omaha.list.InterventionCategoryList
object
InterventionCategoryList model (no description)
1 property
dossier.omaha.list.InterventionTargetList
object
InterventionTargetList model (no description)
1 property
dossier.omaha.list.ProblemList
object
ProblemList model (no description)
1 property
payroll.PayableHoursAverage
object
PayableHoursAverage model (no description)
6 properties
3 required
payroll.list.PayableHoursAverageList
object
PayableHoursAverageList model (no description)
1 property
list.PersonalRelationTypeList
object
PersonalRelationTypeList model (no description)
1 property
PersonalRelationType
object
PersonalRelationType model (no description)
Practitioner
object
A practitioner is an employee with some extra attributes Those attributes are used to give extra meaning to an employee in a certain context. For instance: In…
4 properties
PractitionerSkjCode
object
An SKJ registration is a registration at Kwaliteitsregister Jeugd
6 properties
list.PractitionerList
object
PractitionerList model (no description)
1 property
list.ReferralList
object
ReferralList model (no description)
1 property
list.ReferrerCategoryList
object
ReferrerCategoryList model (no description)
1 property
ReferrerCategory
object
ReferrerCategory model (no description)
4 properties
ReferrerType
object
ReferrerType model (no description)
2 properties
Skn
object
Skn model (no description)
3 properties
status.ApplicationStatus
object
ApplicationStatus model (no description)
1 property
status.AnonymizeType
string
the {@link com.nedap.healthcare.domain.status.AnonymizeType} to this application status
survey.list.SurveyResultList
object
SurveyResultList model (no description)
1 property
survey.list.AnswerDefinitionGroupList
object
AnswerDefinitionGroupList model (no description)
1 property
survey.list.SurveyList
object
SurveyList model (no description)
1 property
transport.ClientTransport
object
ClientTransport the transport details for a client, financed in the WLZ, on a certain date
10 properties
6 required
TreatmentLocation
object
TreatmentLocation model (no description)
3 properties
3 required
UserStatus
object
UserStatus model (no description)
3 properties
list.UserList
object
UserList model (no description)
1 property
list.WeeksheetProfileList
object
WeeksheetprofileList model (no description)
1 property
payroll.list.WorkHoursBalanceList
object
WorkHoursBalanceList model (no description)
1 property
payroll.WorkHoursBalance
object
WorkHoursBalance model (no description)
6 properties
payroll.WorkLoad
object
WorkLoad model (no description)
4 properties
worksheet.Worksheet
object
Worksheet model (no description)
1 property
1 required
zpm.list.ZpmGbggzProfielList
object
ZpmGbggzProfielList model (no description)
1 property
zpm.ZpmGbggzProfiel
object
Generalistische basis ggz (gb-ggz) patientprofiel.
5 properties
3 required
zpm.list.ZpmSettingList
object
ZpmSettingList model (no description)
1 property
zpm.ZpmSetting
object
Setting (context, environment) in which care is being delivered.
7 properties
4 required
zpm.list.ZpmZorglabelList
object
ZpmZorglabelList model (no description)
1 property
zpm.ZpmZorglabel
object
Indicates extra information linked to activities.
8 properties
5 required
agenda.list.RegistrationStatusList
object
RegistrationStatusList model (no description)
1 property
agenda.RegistrationStatus
object
Ons Agenda - Registrations status domain model used by Cupido system.
4 properties
agenda.ClientAbsenceOccurrence
object
Client absence occurrence domain in Agenda.
21 properties
agenda.ClientAbsenceStatus
string
A status about the absence; can be created/updated/deleted.
agenda.list.ClientAbsenceOccurrenceList
object
ClientAbsenceOccurrenceList model (no description)
1 property
agenda.list.AgendaOccurrenceList
object
AgendaOccurrenceList model (no description)
1 property
agenda.ReservationOccurrenceResponse
object
Response wrapping a list of reservation occurrences.
1 property
agenda.ReservationOccurrence
object
4 properties
agenda.list.LabelList
object
LabelList model (no description)
1 property
herald.AnnouncementCount
object
AnnouncementCount model (no description)
1 property
1 required
toezicht.list.AuditList
object
List of exported audits.
1 property
1 required
toezicht.Audit
object
A single exported audit
8 properties
1 required
toezicht.AuditIdentity
object
Identity linked to an exported Audit
2 properties
toezicht.AuditReferences
object
References linked to an exported Audit
1 property
authorization.provisioning.list.RoleList
object
RoleList model (no description)
1 property
authorization.provisioning.Role
object
Role model (no description)
2 properties
kamino.Error
object
The Kamino API uses HTTP response code to indicate success or failure. When an error occurs, the JSON response can be used to determine what action to take.
3 properties
2 required
kamino.ErrorParam
object
Kamino ErrorParam model (no description)
3 properties
caretech.list.OrderList
object
OrderList model (no description)
1 property
caretech.Order
object
Care technology order
18 properties
7 required
caretech.DeliveryAddress
object
The delivery address of the order
9 properties
6 required
caretech.AddressType
string
The delivery address type, can be CLIENTHOME, CLIENTCAREALLOCATION, MANUAL
caretech.Requester
object
The person who creates the care technology order
6 properties
6 required
caretech.list.ReturnRequestList
object
ReturnRequestList model (no description)
1 property
1 required
caretech.ReturnRequest
object
ReturnRequest model (no description)
17 properties
5 required
caretech.PickupAddress
object
PickupAddress model (no description)
9 properties
6 required
caretech.ReturnMethod
string
The method type of returning the caretechnology device
client_story.ChangeSet
object
ChangeSet model (no description)
4 properties
client_story.Change
object
Change model (no description)
6 properties
ons_client.list.SharedResourceList
object
SharedResourceList model (no description)
1 property
ons_client.SharedResource
object
Cupido resources shared with the client environment.
12 properties
dbc.ggz.fz.list.SubtrajectList
object
SubtrajectList model (no description)
1 property
dbc.ggz.list.ZorgtrajectList
object
ZorgtrajectList model (no description)
1 property
dbc.ggz.list.SubtrajectList
object
SubtrajectList model (no description)
1 property
dbc.ggz.list.ValidationErrorList
object
ValidationErrorList model (no description)
1 property
dbc.ggz.ValidationError
object
ValidationError model (no description)
5 properties
2 required
dbc.ggz.PresenceLogSynchronisationError
object
PresenceLogSynchronisationError: Reflects a log entry in ons-dbc generated when the scheduled PresenceLogSynchronizer job resulted in an error
6 properties
1 required
dbc.ggz.list.PresenceLogSynchronisationErrorList
object
PresenceLogSynchronisationErrorList model (no description)
1 property
ErrorResponse
object
Error response model
1 property
ErrorResponseEntry
object
Error response entry model
3 properties
dossier.ActiveCarePlanMetadata
object
ActiveCarePlanMetadata list model (no description)
2 properties
dossier.CarePlanMetadata
object
CarePlanMetadata model (no description)
3 properties
dossier.CarePlanName
string
Care plan name set by the customer
dossier.admin.alerts.list.TopicList
object
TopicList model (no description)
1 property
dossier.list.LastMedicalMomentList
object
LastMedicalMomentList model (no description)
1 property
dossier.LastMedicalMoment
object
LastMedicalMoment model (no description)
2 properties
dossier.medical.list.PropensityToAdverseReactionList
object
PropensityToAdverseReactionList model (no description)
1 property
dossier.list.ReportWithActionsList
object
List of ReportWithActions
1 property
dossier.ReportWithActions
object
Report model extended with information from other sources (like employee name, client name, etc.)
34 properties
19 required
dossier.ReportStatus
integer
Status of the report, typically used in family communication reports with reactions, where the parent status is updated by the status of the reaction. - 0: ope…
dossier.ReportAuthorType
string
- employee - author is an employee - caren - author is a Caren user - external - author is neither employee nor Caren user
dossier.CombinedReportActionsViewModel
object
List of report action view models
2 properties
2 required
dossier.ReportActionsStatus
string
Status of the report actions. It indicates if there are incomplete actions for my expertise profile or groups. - none : there are no actions for this report -…
dossier.CombinedReportActionViewModel
object
Report action is referencing either expertise group or expertise profile. The type of the expertise is given by the context of the owning object.
5 properties
3 required
dossier.CombinedReportActionReceiverViewModel
object
Report action receiver view model
3 properties
3 required
dossier.CombinedReportActionReceiverType
string
The type of the receiver; expertise profile or group
dossier.ReportAuthorizationsViewModel
object
Expertise profiles and groups that are allowed to view the report. Expertises are applied only if the report is marked as confidential, otherwise the list of e…
2 properties
2 required
dossier.ReportAuthorizationViewModel
object
Authorization is referencing either expertise group or expertise profile. The type of the expertise is given by the context of the owning object.
2 properties
2 required
dossier.SoapViewModel
object
Values for SOAP (SOEP) report. Comments on individual parts are present only in case when the current employee is allowed to see them.
4 properties
4 required
dossier.SoapPartViewModel
object
Individual part of the SOAP report (subjective/objective/assessment/plan)
5 properties
3 required
dossier.MeasurementViewModel
object
Reported value with unit and display format. Some reports have multiple measurements (report entries) - for example BMI report can have up to three values (wei…
5 properties
3 required
dossier.MeasurementViewModelName
string
Technical name of the field, always in English. This can be used if an API consumer needs to know what kind of value they are looking at.
dossier.ReportPhotoViewModel
object
Report photo view models
4 properties
3 required
dossier.ReportGoalViewModel
object
Goal linked to this report
5 properties
5 required
dossier.ReportReactionViewModel
object
Describes a single reaction to the report
10 properties
5 required
dossier.ReportVitalSignList
object
List of vital signs
5 properties
dossier.ReportVitalSign
object
Vital sign from a report
5 properties
dossier.ReportsWithActionsSummary
object
ReportsWithActionsSummary model (no description)
2 properties
dossier.list.ActionEntrySummaryList
object
ActionEntrySummaryList model (no description)
1 property
dossier.ActionEntrySummary
object
Summary of a Zorgplan "actie" entry
7 properties
dossier.list.AlertList
object
List of Alerts
1 property
dossier.CarePlanAgreement
object
CarePlanAgreement model (no description)
4 properties
dossier.CarePlanSignatureRequirement
object
CarePlanSignatureRequirement model (no description)
5 properties
dossier.CarePlanSignatureRequirementDiscussionType
string
The type of discussion with the client/representative. This field should be null when a signature is required (required: true). When required is false, this in…
dossier.list.RestrictiveMeasureRegistrationList
object
RestrictiveMeasureRegistrationList model (no description)
1 property
dossier.list.RestrictiveMeasureCarePlanEntryList
object
RestrictiveMeasureCarePlanEntryList model (no description)
1 property
dossier.medical.advance_directives.list.ContextList
object
ContextList model (no description)
1 property
dossier.medical.dsm.list.ClassificationSeriesList
object
ClassificationSeriesList model (no description)
1 property
dossier.medical.involuntary_care.list.LegalStatusList
object
LegalStatusList model (no description)
1 property
dossier.episodes.list.ActionList
object
ActionList model (no description)
1 property
dossier.episodes.list.EpisodeList
object
EpisodeList model (no description)
1 property
dossier.episodes.list.SubGoalList
object
SubGoalList model (no description)
1 property
dossier.list.InvoluntaryCareExportEntryList
object
InvoluntaryCareExportEntryList model (no description)
1 property
dossier.InvoluntaryCareExportEntry
object
InvoluntaryCareExportEntry model (no description)
17 properties
dossier.medical.dsm.list.ClassificationList
object
ClassificationList model (no description)
1 property
dossier.medical.list.MedicalSummaryList
object
MedicalSummaryList model (no description)
1 property
dossier.medical.MedicalSummary
object
MedicalSummary model (no description)
14 properties
dossier.medical.advance_directives.ResuscitationDecision
integer
The current resuscitation decision for the client Possible values: 0 = NO 1 = YES 2 = UNKNOWN
dossier.medical.MedicalSummaryMetadata
object
Metadata for the medical summary
1 property
finance.list.DebtorGroupList
object
DebtorGroupList model (no description)
1 property
finance.DebtorGroup
object
DebtorGroup model (no description)
4 properties
groupcare.list.OccurrenceList
object
OccurrenceList model (no description)
1 property
groupcare.Occurrence
object
Occurrence model (no description)
12 properties
groupcare.list.GroupList
object
GroupList model (no description)
1 property
onsimport.list.RunList
object
RunList model (no description)
1 property
onsimport.RunReport
object
Contains an Excel report for a run.
2 properties
onsimport.RunStatus
object
Contains status information about a run in Ons Import.
4 properties
onsimport.list.UploadInfoList
object
Contains uploaded files for a run in Ons Import.
1 property
onsimport.UploadInfo
object
Metadata about an uploaded file in Ons Import.
5 properties
onsimport.list.ValidationList
object
ValidationList model (no description)
1 property
onsimport.Validation
object
A validation message describing an error that occurred while importing a record in Ons Import.
8 properties
onsimport.UploadResponse
object
Contains a unique id by which information about an upload can be retrieved.
1 property
harmony.JsonResponseDto
object
harmony.JsonResponseDto model (no description)
2 properties
1 required
portal.EmployeePortalProfile
object
EmployeePortalProfile model (no description)
9 properties
medication.DoubleCheck
object
A DoubleCheck holds all data surrounding a double check which was created for a specific client and medication administration moment.
9 properties
drugstore.AdministrationAgreement
object
Nictic Medicatieproces Based on https://simplifier.net/nictizstu3-zib2017/zibadministrationagreement
6 properties
drugstore.Medication
object
Nictiz Medicatieproces Based on https://simplifier.net/NictizSTU3-Zib2017/ZIB-Product
1 property
CodeableConcept
object
Based on http://hl7.org/fhir/STU3/datatypes.htmlcodeableconcept
2 properties
Coding
object
Based on http://hl7.org/fhir/STU3/datatypes.htmlCoding
3 properties
drugstore.Dosage
object
Nictic Medicatieproces Based on https://simplifier.net/NictizSTU3-Zib2017/ZIB-InstructionsForUse
8 properties
drugstore.ScheduledAdministration
object
ScheduledAdministration model (no description)
2 properties
Quantity
object
A measured or measurable amount Based on http://hl7.org/fhir/STU3/datatypes-examples.htmlQuantity
4 properties
medication.list.MedicationAdministrationList
object
MedicationAdministrationList model (no description)
1 property
medication.MedicationAdministration
object
Describes a medication administration record. Includes internal attributes, but is also shaped somewhat to the MP9 Medicatietoediening ZIB.
15 properties
6 required
medication.InjectionPatchSite
object
Site of the patient’s body where an injection has been administered or where adhesive medical dressing has been applied. Note that the anatomical site may be l…
2 properties
1 required
medication.Dosage
object
Information about the dosage of the medication that was or is to be administered.
2 properties
medication.list.MedicationPlanList
object
MedicationPlanList model (no description)
1 property
medication.MedicationPlan
object
A medication plan holds the document URL required to download a weekly overview of medication information for a given client.
1 property
1 required
milo.Device
object
Device model (no description)
9 properties
milo.App
object
App model (no description)
7 properties
milo.list.DeviceList
object
DeviceList model (no description)
1 property
milo.PasswordVerification
object
PasswordVerification model (no description)
1 property
hermes.CareProviderSettings
object
CareProviderSettings model (no description)
3 properties
hermes.ContactMethod
object
ContactMethod model (no description)
8 properties
hermes.list.NotificationList
object
NotificationList model (no description)
1 property
nexus.list.ClientContactRelationTypeList
object
ClientContactRelationTypeList model (no description)
1 property
nexus.list.ClientEmployeeRelationTypeList
object
ClientEmployeeRelationTypeList model (no description)
1 property
nexus.list.ClientEmployeeRelationList
object
ClientEmployeeRelationList model (no description)
1 property
nexus.list.OrganisationCategoryList
object
OrganisationCategoryList model (no description)
1 property
nexus.OrganisationCategory
object
OrganisationCategory model (no description)
6 properties
nexus.list.PersonalRelationTypeList
object
PersonalRelationTypeList model (no description)
1 property
openehr.list.ArchetypeWrapperList
object
ArchetypeWrapperList model (no description)
1 property
openehr.ArchetypeWrapper
object
ArchetypeWrapper model (no description)
ArchetypeWrapperBase
object
OpenEHR ArchetypeWrapper model. Object to return an ArchetypeWrapper. The wrapper contains the actual archetype as a String and relevant metadata. Based on the…
21 properties
openehr.ArchetypeCategory
object
OpenEHR Archetype Category model. Object to return an ArchetypeCategory. This object includes additional information about Archetype Categories. Created on 30/…
2 properties
ons_ehr.list.NavigationAvailabilityList
object
List of navigation items with their availability
1 property
ons_ehr.NavigationAvailability
object
A navigation item with its availability
2 properties
2 required
ons_ehr.NavigationAvailabilityKey
string
item for navigation availability request
ons_ehr.NavigationAvailabilityState
string
State of the navigation availability
openehr.list.CompositionWrapperList
object
List of wrapper openEHR Compositions.
1 property
openehr.CompositionValidationErrorResponse
object
Returned when a composition could not be created or updated because it failed validation. Contains one entry per validation error found. The property is named…
1 property
openehr.CompositionValidationErrorEntry
object
A single validation error found while creating or updating a composition.
6 properties
openehr.CompositionValidationErrorEntryType
string
The kind of validation error reported by a composition validation error entry. The message of an entry is raw output of the openEHR validator and is not unders…
openehr.list.CompositionVersionWrapperList
object
CompositionVersionWrapperList model (no description)
1 property
openehr.CompositionVersionWrapper
object
CompositionVersionWrapper model (no description)
17 properties
5 required
openehr.list.LinkedReferenceModelObjectWrapperList
object
List of wrapper openEHR LinkedReferenceModelObjects.
1 property
openehr.LinkedReferenceModelObjectWrapper
object
OpenEHR Linked Reference Model Object Wrapper model. Object to return an LinkedReferenceModelObjectWrapper. This object includes additional information about l…
5 properties
openehr.RuleEvaluationResult
object
OpenEHR RuleEvaluationResult model. Object to return an RuleEvaluationResult, which checks the rules of an archetype. Created on 18/06/2018.
3 properties
openehr.list.CompositionValuesForArchetypeList
object
List of the requested archetype ids and the values for the matching compositions. Will contain one entry for each of the requested archetype ids.
1 property
openehr.CompositionValuesForArchetype
object
The requested archetype id and returned composition data including values for requested paths
2 properties
openehr.CompositionValues
object
Values of a specific Composition, including the values for the requested path
16 properties
openehr.CompositionValuesForPath
object
Combination of requested path and its values in this composition
2 properties
openehr.list.EmployeeGroupList
object
EmployeeGroupList model (no description)
1 property
ons_ehr.LastVisitedPlan
object
Last visited plan
2 properties
ons_ehr.LastVisitedPlanType
string
Unique code that identifies the visited plan type
ons_ehr.GgzPlanStatistics
object
GgzPlanStatistics model
3 properties
ons_ehr.GgzPlanStatistic
object
GgzPlanStatistic model
4 properties
ons_ehr.list.SettingList
object
SettingList model (no description)
1 property
ons_ehr.Setting
object
A setting from OnsEhr
2 properties
openehr.list.CarePlanVvtCareProfileLinkList
object
CarePlanVvtCareProfileLinkList model (no description)
1 property
openehr.CarePlanVvtCareProfileLink
object
CarePlanVvtCareProfileLink model (no description)
2 properties
moves.list.ClientPlanningFilterList
object
ClientPlanningFilterList model (no description)
1 property
moves.ClientPlanningFilter
object
Relation between an Client and an Employee.
13 properties
moves.UnitType
string
Type of the unit
moves.list.ClientPlannedSchedulePlannedVisitList
object
The planned schedule for a client
1 property
moves.ClientPlannedSchedulePlannedVisit
object
A single visit in the planned schedule of a client
4 properties
moves.ClientPlannedSchedulePlannedVisitEmployee
object
An employee during a single visit in the planned schedule of a client
2 properties
moves.list.ContainerList
object
A response body that contains a list of containers.
1 property
1 required
moves.Container
object
A slot of time that can be used to plan care into, like a shift or directly to employee
12 properties
8 required
moves.ContainerType
string
The type of container, either a Shift or an Employee.
moves.ContainerTimeBlock
object
A block of time in which plan cards are (not) allowed to be planned in.
4 properties
4 required
moves.ContainerTimeBlockType
string
Whether this availability marks an unavailability in which work cannot be planned, or an availability in which work can be planned.
moves.MovesRatelimitError
object
An error describing a specific rate limit has been reached and that the client should wait to retry the response
3 properties
moves.EmployeeSchedule
object
EmployeeSchedule model (no description)
4 properties
moves.EmployeeScheduleDay
object
EmployeeScheduleDay model (no description)
5 properties
moves.EmployeeScheduleItem
object
An item rostered, planned, or otherwise scheduled for an Employee in Ons Planning.
7 properties
moves.AvailabilityOccurrence
object
AvailabilityOccurrence model (no description)
6 properties
moves.LeaveRequestOccurrence
object
LeaveRequestOccurrence model (no description)
6 properties
moves.PlannedVisit
object
A Visit from an {@Employee} to a {@Client}.
36 properties
moves.PlannedAddress
object
Address where {@link PlannedVisit}s are planned. Moves has it's own Address model, and plancards can be planned tp addresses not known in other systems.
9 properties
moves.Plancard
object
{@link PlannedVisit}s are the aggregation of a list of Plancards.
17 properties
moves.LocationAuthorization
object
LocationAuthorization model (no description)
1 property
moves.RosterSlot
object
A RosterSlot that has been assigned to the Employee, or that the Employee has signed-up for. Note 1: When rosterSlot is set, unavailabilityOccurrence, directly…
22 properties
moves.FlexRequest
object
FlexRequest model (no description)
18 properties
moves.FlexSignup
object
FlexSignup model (no description)
9 properties
moves.UnavailabilityOccurrence
object
An UnavailabilityOccurrence of the Employee. When unavailabilityOccurrence is set, rosterSlot, directlyPlannedVisits, availabilityOccurrence and leaveRequestOc…
10 properties
moves.EmployeeMovesProfile
object
EmployeeMovesProfile describes dynamic properties of an Employee, based on the Memberships of that Employees as known in Moves and on team settings configured…
10 properties
moves.EmployeeHoursReport
object
Describes a report of the worked and leave hours of an employee in the current state and the future.
2 properties
moves.EmployeeHoursReportSegment
object
Describes a segment of the worked and leave hours of an employee. E.g. 'current' or 'future'
3 properties
moves.EmployeeHoursReportCategory
object
Describes a category of the worked and leave hours of an employee. E.g. 'workedhours' or 'compensation'
6 properties
moves.EmployeeHoursReportSubCategory
object
Describes a subcategory to determine sub headings in the widget
2 properties
moves.list.NavigationAvailabilityList
object
List of navigation items with their availability
1 property
moves.NavigationAvailability
object
A navigation item with its availability
2 properties
2 required
moves.NavigationAvailabilityKey
string
item for navigation availability request
moves.NavigationAvailabilityState
string
State of the navigation availability
moves.EmployeePlanning
object
The employee planning
1 property
moves.EmployeePlanningEventGroup
object
Part of the employee planning
5 properties
moves.EmployeePlanningClient
object
Part of the employee planning
5 properties
moves.EmployeePlanningPlanCard
object
Part of the employee planning
3 properties
moves.list.EmployeeRosterDayList
object
Employee roster day list
1 property
moves.EmployeeRosterDay
object
Employee roster
3 properties
moves.EmployeeRosterDayAvailability
object
Employee roster availability
3 properties
moves.EmployeeRosterDayShiftAssignment
object
Employee roster shift assignment
3 properties
moves.list.ShiftAssignmentList
object
ShiftAssignmentList model (no description)
1 property
moves.Absence
object
An absence to be processed as a signal from a remote system
7 properties
4 required
moves.PlanCardOccurrenceResponse
object
The response from a successful plan card planning mutation
2 properties
moves.PlanCardOccurrenceResponseMetadata
object
Metadata about the impact of the plan card occurrence planning
1 property
moves.PlanCardOccurrenceResponseMetadataImpact
object
Metadata about the impact of the plan card occurrence planning
1 property
moves.PlanCardOccurrence
object
A single instance of a recurring plan card as retrieved from the new Plancore.
17 properties
17 required
moves.PlanCardRecurrenceInformation
object
This describes how often this plan card should occur.
moves.Recurrence
object
This describes how often this plan card should occur.
3 properties
3 required
moves.RecurrenceType
string
The type of repetition between occurrences. Weekly means once a week, Incidental means once for this validFrom until validTo period.
moves.PlanCardOccurrenceList
object
A response body that contains a list of plan tasks found for this search
2 properties
2 required
moves.list.PlannedVisitList
object
PlannedVisitList model (no description)
1 property
moves.list.RosterSlotList
object
RosterSlotList model (no description)
1 property
moves.Shift
object
Updated by Jurriën Gosselink on 09-07-18.
30 properties
moves.list.TeamList
object
List of teams ( also named units ) for planning and rostering purposes
1 property
moves.Team
object
A team ( or unit ) used for planning and rostering purposes. This team links to the administrative team through the teamId.
25 properties
moves.FlexSignupVisibility
string
How flex request signups of colleagues are shown to employees
moves.WhoMakesFlexAssignments
string
Which unit assigns employees to flex requests
moves.list.ClientList
object
List of Clients
1 property
moves.Client
object
A Client object in Moves
2 properties
2 required
moves.WorkingEmployeeReport
object
WorkingEmployeeReport model (no description)
1 property
tasque.list.CareTaskGroupStatusList
object
CareTaskGroupStatusList model (no description)
1 property
tasque.CareTaskGroupStatus
object
CareTaskGroupStatus model (no description)
4 properties
tasque.list.CareTaskOccurrenceList
object
CareTaskOccurrenceList model (no description)
1 property
tasque.list.ClientIdBySubTypeList
object
ClientIdBySubTypeList model (no description)
1 property
tasque.ClientIdBySubType
object
ClientIdBySubType model (no description)
3 properties
whismur.CareProviderSetting
object
The speech to text settings for a care provider
4 properties
whismur.Provider
string
The speech to text provider configured for this care organization.
whismur.Recorder
string
Recorder to use for speech to text service.
whismur.RecordingMode
string
Recording mode to use.
moves.list.AvailabilityList
object
AvailabilityList model (no description)
1 property
moves.Availability
object
An availability is a period of time in which an employee or client has 'something'. Some examples of availabilities: - Employee A is sick in a period - Employe…
17 properties
moves.list.AvailabilityTypeList
object
AvailabilityTypeList model (no description)
1 property
moves.AvailabilityType
object
An availability types are for example: Sick, Holiday, Meeting, Training AvailabilityTypes are linked to an employee of client via an Availability
13 properties
list.BankAccountList
object
BankAccountList model (no description)
1 property
list.ClientAddressList
object
ClientAddressList model (no description)
1 property
list.ClientContactRelationAddressList
object
ClientContactRelationAddressList model (no description)
1 property
payroll.list.ContractTypeList
object
ContractTypeList model (no description)
1 property
list.EmployeeAddressList
object
EmployeeAddressList model (no description)
1 property
moves.list.ExpertiseProfileList
object
ExpertiseProfileList model (no description)
1 property
moves.ExpertiseProfile
object
ExpertiseProfile model (no description)
5 properties
finance.list.ExportProfileList
object
ExportProfileList model (no description)
1 property
finance.ExportProfile
object
ExportProfile model (no description)
11 properties
finance.list.FinanceLogList
object
FinanceLogList model (no description)
1 property
finance.FinanceLog
object
Finance log model.
21 properties
finance.list.FinanceTypeList
object
FinanceTypeList model (no description)
1 property
list.FreeFieldAssignmentList
object
FreeFieldAssignmentList model (no description)
1 property
FreeFieldAssignment
object
Table containing the values of linked free fields for clients or employees
6 properties
list.FreeFieldCategoryList
object
FreeFieldCategoryList model (no description)
1 property
FreeFieldCategory
object
Table containing the categories (such as clients and employees) that make use of free fields
3 properties
CarrierType
integer
Specifies the type of the carrier. Possible values: 0 = ACTIVITY, 1 = EMPLOYEE, 2 = CLIENT.
list.FreeFieldDefinitionList
object
FreeFieldDefinitionList model (no description)
1 property
FreeFieldDefinition
object
Table of the possible free fields per category (clients, employees).
8 properties
FreeFieldType
integer
Specifies the type of the free field. Possible values: 0 = STRING, 1 = NUMBER, 2 = BOOLEAN, 3 = DATE, 4 = TIME, 5 = DATETIME.
groepsplanning.list.GroupList
object
List of groups
1 property
groepsplanning.Group
object
A group represents a (recurring) meeting where multiple clients can participate
8 properties
finance.list.InvoiceRowFinanceLogList
object
InvoiceRowFinanceLogList model (no description)
1 property
finance.InvoiceRowFinanceLog
object
Relations between InoviceRow and FinanceLog
2 properties
finance.list.InvoiceRowList
object
InvoiceRowList model (no description)
1 property
finance.InvoiceRow
object
InvoiceRow model (no description)
24 properties
finance.list.InvoiceList
object
InvoiceList model (no description)
1 property
finance.Invoice
object
Invoice model (no description)
20 properties
moves.list.MembershipList
object
MembershipList model (no description)
1 property
moves.Membership
object
Membership model (no description)
8 properties
finance.list.RestitutionList
object
RestitutionList model (no description)
1 property
finance.Restitution
object
Restitution model (no description)
10 properties
moves.list.ShiftList
object
ShiftList model (no description)
1 property
moves.list.UnitList
object
UnitList model (no description)
1 property
moves.Unit
object
Every unit (mostly) corresponds to a team in Ons Administration (however, it is possible to have a unit that is not coupled to a team).
16 properties
finance.list.VecozoInvoiceRelationList
object
VecozoInvoiceRelationList model (no description)
1 property
finance.VecozoInvoiceRelation
object
Model containing relation between vecozo and invoice
5 properties
zorgmail_module.DiagnosticProcedureSearchResult
object
DiagnosticProcedureSearchResult model (no description)
2 properties
zorgmail_module.DiagnosticProcedure
object
DiagnosticProcedure model (no description)
8 properties
zorgmail_module.DiagnosticReport
object
DiagnosticReport model (no description)
4 properties
zorgmail_module.Observation
object
Observation model (no description)
10 properties
carepath.CarePath
object
A 'Zorgpad' of a client
7 properties
5 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Healthcare#Electronic Health Records#FHIR#openEHR#Interoperability
Where this information came from
This is an independent, third-party profile of Nedap Ons API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.