\n POST /t/documents HTTP/1.1\n Accept: application/xml\n Accept-Encoding: gzip, deflate\n Connection: keep-alive\n Content-Type: multipart/form-data; boundary=---------------------------9051914041544843365972754266\n Content-Length: 554\n -----------------------------9051914041544843365972754266\n Content-Disposition: form-data; name=“metadata”\n Content-Type: application/json\n {\"clientObjectId\": 12, \"employeeObjectId\": 10}\n -----------------------------9051914041544843365972754266\n Content-Disposition: form-data; name=“attachment\"; filename=“somefilename\"\n Content-Type: application/octet-stream\n 0010010010101001001000\n -----------------------------9051914041544843365972754266--\n \n\n Curl example\n
\n curl -vv -S\n --cert common-name.pem --key common-name.key\n -X POST https://api-development.ons.io/t/documents?client_id=12\n -H 'Accept: application/xml,application/json'\n -H 'Cache-Control: no-cache'\n -H 'Content-Type: multipart/form-data'\n -F 'metadata={\"clientObjectId\":12, \"employeeObjectId\" : 10};type=application/json'\n -F 'attachment=@temp.txt'\n \n\n When using Postman api client the metadata has to be an xml object", "operationId": "DocumentAPI.create", "parameters": [ { "name": "client_id", "in": "path", "description": "Id of the client object", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-original-parameter": { "in": "query" } } ], "requestBody": { "description": "An object with metadata about the document (clientObjectId and employeeObjectId are required).\n When setting expertise profiles or expertise groups the rightSelection should be set to Group.\n The RightSelection `Education` ignores any supplied expertise profiles and expertise groups and applies the\n currently valid expertise profile of the employee.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "415": { "description": "Unsupported Media Type can be returned when media type is unsupported or if an attachment was not received completely. A retry should normally fix this." } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/documents" ] } }, "/v0/administration/clients/{client_id}/documents/{doc_id}": { "get": { "tags": [ "Document" ], "summary": "Find the document corresponding to the given client and document id's.", "operationId": "DocumentAPI.byClientIdAndDocumentId", "parameters": [ { "name": "client_id", "in": "path", "description": "the id of the client", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-original-parameter": { "in": "query" } }, { "name": "doc_id", "in": "path", "description": "the id of the document", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-original-parameter": { "in": "query" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "405": { "description": "When no doc_id query parameter is provided" } }, "x-replacement-for": [ "/t/documents" ] } }, "/v0/administration/clients/{client_id}/documents/{doc_id}/download": { "get": { "tags": [ "Document" ], "summary": "Returns a stream of bytes representing the document, be sure to close the stream when done.", "operationId": "DocumentAPI.downloadByClientIdAndDocumentId", "parameters": [ { "name": "client_id", "in": "path", "description": "the id of the client", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-original-parameter": { "in": "query" } }, { "name": "doc_id", "in": "path", "description": "the id of the document", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-original-parameter": { "in": "query" } } ], "responses": { "200": { "description": "Download file", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "405": { "description": "When no doc_id query parameter is provided" } }, "x-replacement-for": [ "/t/documents/download" ] } }, "/v0/administration/clients/{client_id}/documents/all": { "get": { "tags": [ "Document" ], "summary": "Find all documents for a client.", "description": "Optionally filter by employee who has access to the files and by creation date.", "operationId": "DocumentAPI.byClientIdAndEmployeeIdAndDate", "parameters": [ { "name": "client_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "employee_id", "in": "query", "description": "an optional filter. Adding an employee id will only return those documents that that employee can access", "schema": { "type": "integer", "format": "int64" } }, { "name": "from", "in": "query", "description": "only return the documents added after this date", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "only return the documents added before this date", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.DocumentList" } } } } }, "x-replacement-for": [ "/t/documents/by_client/{client_id}" ] } }, "/v0/administration/clients/{client_id}/documents/all_archived_included": { "get": { "tags": [ "Document" ], "summary": "Find all active and archived documents.", "description": "Optionally filter by employee who has access to the files and by creation date.", "operationId": "DocumentAPI.documentsByClientInPeriodIncludeArchived", "parameters": [ { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } }, { "name": "client_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "employee_id", "in": "query", "description": "an optional filter. Adding an employee id will only return thosdocuments that that employee can access", "schema": { "type": "integer", "format": "int64" } }, { "name": "from", "in": "query", "description": "only return the documents added after this date", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "only return the documents added before this date", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.DocumentList" } } } }, "404": { "description": "Employee cannot be found" } }, "x-replacement-for": [ "/t/documents/by_client/{client_id}/all_archived_included" ] } }, "/v0/administration/clients/{client_id}/finance_types/{finance_type_id}/coordinating_practitioner": { "get": { "tags": [ "Employee" ], "summary": "Find the coordinating practitioner by client, finance type and date.", "operationId": "EmployeeAPI.coordinatingPractitionerByClientFinanceTypeDate", "parameters": [ { "name": "client_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "finance_type_id", "in": "path", "description": "The finance type of the care order in which the coordinating practitioner is defined.\nFinance types:\n* 14 - GGZ ZPM\n* 15 - FZ ZPM", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "date", "in": "query", "description": "date", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" } } } }, "400": { "description": "Date is required, a valid finance_type_id is required, a valid client_id is required" }, "404": { "description": "No careorder found or no employee found for given parameters" }, "409": { "description": "Two or more coordinating practitioners were found" } }, "x-replacement-for": [ "/t/clients/{client_id}/finance_types/{finance_type_id}/coordinating_practitioner" ] } }, "/v0/administration/clients/{client_id}/insurances": { "get": { "tags": [ "Insurance" ], "summary": "Return the insurances of a Client corresponding to the given id.", "operationId": "InsuranceAPI.byClientId", "parameters": [ { "name": "client_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.InsuranceList" } } } } }, "x-replacement-for": [ "/t/clients/{client_id}/insurances" ] } }, "/v0/administration/clients/{client_id}/locations": { "get": { "tags": [ "LocationAssignment" ], "summary": "Return the location assignments of a Client corresponding to the given id.", "operationId": "LocationAssignmentAPI.byClientId", "parameters": [ { "name": "client_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "valid_from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.LocationAssignmentList" } } } } }, "x-replacement-for": [ "/t/clients/{client_id}/location_assignments" ] } }, "/v0/administration/clients/{client_id}/main_location": { "get": { "tags": [ "Location" ], "description": "Returns the main location of the client", "operationId": "LocationAPI.mainLocationByClientId", "parameters": [ { "name": "client_id", "in": "path", "description": "the id of the client", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "date", "in": "query", "description": "Sample date for selecting the main location. If omitted, the current date is used", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Location" } } } } }, "x-replacement-for": [ "/t/clients/{client_id}/main_location" ] } }, "/v0/administration/clients/{client_id}/main_location_assignment": { "get": { "tags": [ "LocationAssignment" ], "description": "Returns the main location assignment of the client", "operationId": "LocationAssignmentAPI.mainLocationAssignmentByClientId", "parameters": [ { "name": "client_id", "in": "path", "description": "the id of the client", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "date", "in": "query", "description": "Sample date for selecting the main location assignment. If omitted, the current date is used", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAssignment" } } } } }, "x-replacement-for": [ "/t/clients/{client_id}/main_location_assignment" ] } }, "/v0/administration/clients/{client_id}/presence_logs": { "get": { "tags": [ "PresenceLog" ], "summary": "Return the presence logs of a Client corresponding to the given id.", "operationId": "PresenceLogAPI.byClientId", "parameters": [ { "name": "client_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "valid_from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.PresenceLogList" } } } } }, "x-replacement-for": [ "/t/clients/{client_id}/presence_logs" ] } }, "/v0/administration/clients/{client_id}/primary_address": { "get": { "tags": [ "Address" ], "summary": "Return the address where the client currently resides.", "description": "Note: this is not the legal address\nReturns the address where the client currently resides. Not to be used to retrieve the legal address.\nSorts the currently active addresses by type, and returns the first one it finds. It uses the following order: temporary, residence, legal (GBA), correspondence, unknown, other, invoice, key address.", "operationId": "AddressAPI.mainAddressByClientId", "parameters": [ { "name": "client_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Address" } } } } }, "x-replacement-for": [ "/t/clients/{client_id}/main_address" ] } }, "/v0/administration/clients/{client_id}/waiting_list_locations": { "get": { "tags": [ "LocationAssignmentWaitingList" ], "summary": "Return the waiting list location assignments of a Client corresponding to the given id.", "operationId": "LocationAssignmentWaitingListAPI.byClientId", "parameters": [ { "name": "client_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "valid_from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.LocationAssignmentWaitingListList" } } } } }, "x-replacement-for": [ "/t/clients/{client_id}/waiting_list_location_assignments" ] } }, "/v0/administration/clients/{employee_id}/last_visited_clients": { "get": { "tags": [ "Client" ], "summary": "Returns the last visited clients of an employee based on presence logs.", "operationId": "ClientAPI.lastVisitedClients", "parameters": [ { "name": "employee_id", "in": "path", "description": "- employee id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "from_date", "in": "query", "description": "- begin date of period", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "to_date", "in": "query", "description": "- end date of period", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "offset", "in": "query", "description": "- position in the result list to start from", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "limit", "in": "query", "description": "- limit of the result list", "schema": { "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ClientList" } } } } }, "x-replacement-for": [ "/t/clients/{employee_id}/last_visited_clients" ] } }, "/v0/administration/clients/{id}": { "get": { "tags": [ "Client" ], "summary": "Find a client by their primary key", "operationId": "ClientAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Client", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Client" } } } }, "404": { "description": "Client not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/clients/{id}" ] }, "put": { "tags": [ "Client" ], "summary": "Update Client", "operationId": "ClientAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Client", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "Client to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Client" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Client" } } } }, "400": { "description": "Validation or persistence problems, or identification number already exists" }, "404": { "description": "Client not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/clients/{id}" ] } }, "/v0/administration/clients/by_bsn": { "get": { "tags": [ "Client" ], "summary": "Find a client by its BSN number", "operationId": "ClientAPI.byBSN", "parameters": [ { "name": "bsn", "in": "query", "description": "The bsn of the client to find", "schema": { "type": "string" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Client" } } } }, "404": { "description": "Client not found" }, "409": { "description": "If multiple clients are registered with the same BSN" } }, "x-replacement-for": [ "/t/clients/by_bsn" ] } }, "/v0/administration/clients/by_bsn/{bsn}": { "get": { "tags": [ "Client" ], "summary": "Find a client by its BSN number", "description": "Use byBsn ", "operationId": "ClientAPI.byBSNUnsafe", "parameters": [ { "name": "bsn", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Client" } } } }, "404": { "description": "Client not found" }, "409": { "description": "If multiple clients are registered with the same BSN" } }, "deprecated": true, "x-deprecated-since": "29-07-2020", "x-replacement-for": [ "/t/clients/by_bsn/{bsn}" ] } }, "/v0/administration/clients/by_skn": { "get": { "tags": [ "Client" ], "summary": "Find a client by its SKN (strafrechtketennummer).", "operationId": "ClientAPI.bySkn", "parameters": [ { "name": "skn", "in": "query", "description": "the skn of the client to find.", "schema": { "type": "string" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Client" } } } }, "404": { "description": "Client not found" } }, "x-replacement-for": [ "/t/clients/by_skn" ] } }, "/v0/administration/clients/by_uuid/{uuid}": { "get": { "tags": [ "Client" ], "summary": "Find a client by its UUID", "operationId": "ClientAPI.byUUID", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Client" } } } }, "404": { "description": "Client not found" } }, "x-replacement-for": [ "/t/clients/by_uuid/{uuid}" ] } }, "/v0/administration/clients/byIdentificationNumber/{identification_no}": { "get": { "tags": [ "Client" ], "summary": "Find a client based on it's identification number, a logical identifier", "operationId": "ClientAPI.byIdentificationNo", "parameters": [ { "name": "identification_no", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Client" } } } } }, "x-replacement-for": [ "/t/clients/by_identification_no/{identification_no}" ] } }, "/v0/administration/clients/find": { "get": { "tags": [ "Client" ], "summary": "Results returned by this call are not grouped, i.e. This endpoint is deprecated, use: /omnisearch/client/search", "description": "the {@link com.nedap.healthcare.domain.ClientSearchResult#group}\nvalue is {@link com.nedap.healthcare.domain.ClientSearchResultGroup#UNGROUPED} for all results.", "operationId": "ClientAPI.search", "parameters": [ { "name": "query", "in": "query", "description": "The string to search for", "schema": { "type": "string" } }, { "name": "employee", "in": "query", "schema": { "type": "string" }, "x-original-parameter": { "name": "employee_id" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "includewaiting", "in": "query", "schema": { "type": "boolean" }, "x-original-parameter": { "name": "include_waiting" } }, { "name": "includeoutofcare", "in": "query", "schema": { "type": "boolean" }, "x-original-parameter": { "name": "include_outofcare" } }, { "name": "on_date", "in": "query", "description": "The search will be performed for the given date (instead of now)", "schema": { "type": "string", "format": "date" } }, { "name": "location_id", "in": "query", "description": "Limit the scope of search to within this location (only works when also using employee_id with an Employee that is linked to a User account)", "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ClientSearchResultList" } } } }, "404": { "description": "Employee not found" } }, "deprecated": true, "x-deprecated-since": "01-03-2026", "x-replacement-for": [ "/t/clients/searchresult" ] } }, "/v0/administration/clients/find_grouped": { "get": { "tags": [ "Client" ], "summary": "Searches performed through this method are 'grouped' according to the groups defined in\ncom.nedap.healthcare.domain.ClientSearchResultGroup, which value is set on the\ncom.nedap.healthcare.domain.ClientSearchResult#group field. This endpoint is deprecated, use: /omnisearch/client/search", "description": "Searches performed through this method are 'grouped' according to the groups defined in\n{@link com.nedap.healthcare.domain.ClientSearchResultGroup}, which value is set on the\n{@link com.nedap.healthcare.domain.ClientSearchResult#group} field.", "operationId": "ClientAPI.searchGrouped", "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "employee", "in": "query", "schema": { "type": "string" }, "x-original-parameter": { "name": "employee_id" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "includewaiting", "in": "query", "schema": { "type": "boolean" }, "x-original-parameter": { "name": "include_waiting" } }, { "name": "includeoutofcare", "in": "query", "schema": { "type": "boolean" }, "x-original-parameter": { "name": "include_outofcare" } }, { "name": "on_date", "in": "query", "description": "The search will be performed for the given date (instead of now)", "schema": { "type": "string", "format": "date" } }, { "name": "location_id", "in": "query", "description": "Limit the scope of search to within this location (only works when also using employee_id with an Employee that is linked to a User account)", "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ClientSearchResultList" } } } }, "404": { "description": "Employee not found" } }, "deprecated": true, "x-deprecated-since": "01-03-2026", "x-replacement-for": [ "/t/clients/search_grouped" ] } }, "/v0/administration/clients/ids_in_care_in_period": { "get": { "tags": [ "Client" ], "summary": "Find clientObjectIds of all clients in care in a given period", "operationId": "ClientAPI.searchClientIdsInCareInPeriod", "parameters": [ { "name": "valid_from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Succes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ClientObjectIdList" } } } }, "400": { "description": "Bad request" } }, "x-replacement-for": [ "/t/clients/ids_in_care_in_period" ] } }, "/v0/administration/clients/in_care_in_period": { "get": { "tags": [ "Client" ], "summary": "Find all clients in care in a given period", "operationId": "ClientAPI.searchInCareInPeriod", "parameters": [ { "name": "valid_from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ClientList" } } } }, "400": { "description": "Bad request" } }, "x-replacement-for": [ "/t/clients/in_care_in_period" ] } }, "/v0/administration/clients/multiple": { "get": { "tags": [ "Client" ], "summary": "Method used for requesting multiple Client objects using\ntheir ids.", "operationId": "ClientAPI.multiple", "parameters": [ { "name": "id", "in": "query", "description": "array style id's: id=1&id=2&etc", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ClientList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/clients/multiple" ] } }, "/v0/administration/clients/search_by_location": { "get": { "tags": [ "Client" ], "summary": "Find clients by location", "operationId": "ClientAPI.searchByLocationId", "parameters": [ { "name": "location_id", "in": "query", "description": "Location", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-original-parameter": { "in": "path" } }, { "name": "offset", "in": "query", "description": "number of results to skip", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "limit", "in": "query", "description": "number of results for one call", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "valid_from", "in": "query", "description": "starting time", "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "description": "end time", "schema": { "type": "string", "format": "date" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ClientList" } } } }, "404": { "description": "Location not found" } }, "x-replacement-for": [ "/t/clients/search_by/locations/{location_id}" ] } }, "/v0/administration/collective_agreement_assignments": { "post": { "tags": [ "payroll.CollectiveAgreementAssignment" ], "summary": "Create the provided collective agreement assignment and assign it to the employee corresponding to the provided id", "operationId": "payroll.CollectiveAgreementAssignmentAPI.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.CollectiveAgreementAssignment" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.CollectiveAgreementAssignment" } } } }, "400": { "description": "Validation errors" }, "404": { "description": "Not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/payroll/collective_agreement_assignments" ] } }, "/v0/administration/collective_agreement_assignments/{id}": { "get": { "tags": [ "payroll.CollectiveAgreementAssignment" ], "summary": "Returns the collective agreement assignment corresponding to the given id", "operationId": "payroll.CollectiveAgreementAssignmentAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Collective Agreement Assignment", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.CollectiveAgreementAssignment" } } } }, "404": { "description": "Collective agreement assignment not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/payroll/collective_agreement_assignments/{id}" ] }, "put": { "tags": [ "payroll.CollectiveAgreementAssignment" ], "summary": "Update the provided collective agreement assignment", "operationId": "payroll.CollectiveAgreementAssignmentAPI.updateById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.CollectiveAgreementAssignment" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.CollectiveAgreementAssignment" } } } }, "400": { "description": "Validation errors" }, "404": { "description": "Not found" } }, "x-replacement-for": [ "/t/payroll/collective_agreement_assignments/{id}" ] }, "delete": { "tags": [ "payroll.CollectiveAgreementAssignment" ], "summary": "Remove the collective agreement assignment corresponding to the given id", "operationId": "payroll.CollectiveAgreementAssignmentAPI.removeById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "Success" }, "404": { "description": "Collective agreement assignment not found" } }, "x-replacement-for": [ "/t/payroll/collective_agreement_assignments/{id}" ] } }, "/v0/administration/collective_agreement_assignments/by_employee_id/{employee_id}": { "get": { "tags": [ "payroll.CollectiveAgreementAssignment" ], "summary": "Return the collective agreement assignments of an Employee corresponding to the given id.", "operationId": "payroll.CollectiveAgreementAssignmentAPI.byEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.list.CollectiveAgreementAssignmentList" } } } }, "404": { "description": "Employee not found" } }, "x-replacement-for": [ "/t/employees/{employee_id}/collective_agreement_assignments" ] }, "delete": { "tags": [ "payroll.CollectiveAgreementAssignment" ], "summary": "Remove all collective agreement assignments for the employee corresponding to the given id", "operationId": "payroll.CollectiveAgreementAssignmentAPI.removeByEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "Success" }, "404": { "description": "Collective agreement assignment not found" } }, "x-replacement-for": [ "/t/employees/{employee_id}/collective_agreement_assignments" ] } }, "/v0/administration/collective_agreement_rules/{id}": { "get": { "tags": [ "payroll.CollectiveAgreementRule" ], "operationId": "payroll.CollectiveAgreementRuleAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting ColllectiveAgreementRule", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.CollectiveAgreementRule" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/payroll/collective_agreement_rules/{id}" ] } }, "/v0/administration/collective_agreement_rules/by_collective_agreement_id/{collective_agreement_id}": { "get": { "tags": [ "payroll.CollectiveAgreementRule" ], "summary": "Return the CollectiveAgreementRules of an employee corresponding to the given id.", "operationId": "payroll.CollectiveAgreementRuleAPI.byCollectiveAgreementId", "parameters": [ { "name": "collective_agreement_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.list.CollectiveAgreementRuleList" } } } } }, "x-replacement-for": [ "/t/payroll/collective_agreements/{collective_agreement_id}/collective_agreement_rules" ] } }, "/v0/administration/collective_agreements": { "get": { "tags": [ "payroll.CollectiveAgreement" ], "summary": "Returns every CollectiveAgreement available", "operationId": "payroll.CollectiveAgreementAPI.all", "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.list.CollectiveAgreementList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/payroll/collective_agreements" ] } }, "/v0/administration/collective_agreements/{id}": { "get": { "tags": [ "payroll.CollectiveAgreement" ], "operationId": "payroll.CollectiveAgreementAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Collective Agreement", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.CollectiveAgreement" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/payroll/collective_agreements/{id}" ] } }, "/v0/administration/consents/{id}": { "get": { "tags": [ "nuts.Consent" ], "summary": "Return the Consent corresponding to the given id", "operationId": "nuts.ConsentAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Consent", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nuts.Consent" } } } }, "404": { "description": "ClientPrivacySetting not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/nuts/consents/{id}" ] } }, "/v0/administration/contract_types/{id}": { "get": { "tags": [ "payroll.ContractType" ], "summary": "Return the Contract Type corresponding to the given id", "operationId": "payroll.ContractTypeAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting ContractType", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.ContractType" } } } }, "404": { "description": "Contract type not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/payroll/contract_types/{id}" ] } }, "/v0/administration/contracts": { "post": { "tags": [ "payroll.Contract" ], "summary": "Create a new Contract", "operationId": "payroll.ContractAPI.create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.Contract" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.Contract" } } } }, "400": { "description": "Validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/payroll/contracts" ] } }, "/v0/administration/contracts/{id}": { "get": { "tags": [ "payroll.Contract" ], "summary": "Return the Contract corresponding to the given id", "operationId": "payroll.ContractAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Contract", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.Contract" } } } }, "404": { "description": "Contract not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/payroll/contracts/{id}" ] }, "put": { "tags": [ "payroll.Contract" ], "summary": "Update an existing Contract", "operationId": "payroll.ContractAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Contract", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.Contract" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.Contract" } } } }, "400": { "description": "Validation errors" }, "404": { "description": "Contract not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/payroll/contracts/{id}" ] } }, "/v0/administration/cost_centers/costCenterSelectionOptions": { "get": { "tags": [ "CostCenterSelectionOption" ], "summary": "Returns every CostCenterSelectionOption for the selection from the CostCenterSelectionOptionAPI", "operationId": "CostCenterSelectionOptionAPI.costCenterSelectionOptions", "parameters": [ { "name": "date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "employee_id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "client_object_ids", "in": "query", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.CostCenterSelectionOptionList" } } } } }, "x-replacement-for": [ "/t/cost_centers" ] } }, "/v0/administration/dashboard_profiles": { "get": { "tags": [ "DashboardProfile" ], "summary": "Return all dashboard profiles", "operationId": "DashboardProfileAPI.all", "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.DashboardProfileList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dashboard_profiles" ] } }, "/v0/administration/dbc/dbc_sub_trajects/{id}": { "get": { "tags": [ "dbc.DBCSubTraject" ], "summary": "Return the specific dbcsubtraject as specified by the id", "operationId": "dbc.DBCSubTrajectAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting DBCSubTraject", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.DBCSubTraject" } } } }, "404": { "description": "DBCSubtraject not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dbc/dbc_sub_trajects/{id}" ] } }, "/v0/administration/dbc/dbc_sub_trajects/in_period": { "get": { "tags": [ "dbc.DBCSubTraject" ], "summary": "Return all dbc subtrajects that have been active at any time in the requested period", "operationId": "dbc.DBCSubTrajectAPI.byPeriod", "parameters": [ { "name": "valid_from", "in": "query", "description": "begindate of the period (inclusive)", "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "description": "enddate of the period (exclusive)", "schema": { "type": "string", "format": "date" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.list.DBCSubTrajectList" } } } } }, "x-replacement-for": [ "/t/dbc/dbc_sub_trajects/in_period" ] } }, "/v0/administration/dbc/dbc_trajects/{dbc_traject_id}/dbc_sub_trajects": { "get": { "tags": [ "dbc.DBCSubTraject" ], "summary": "Return the DBCSubTrajects of a DBCTraject corresponding to the given id.", "operationId": "dbc.DBCSubTrajectAPI.byDBCTrajectId", "parameters": [ { "name": "dbc_traject_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.list.DBCSubTrajectList" } } } } }, "x-replacement-for": [ "/t/dbc/dbc_trajects/{dbc_traject_id}/dbc_sub_trajects" ] } }, "/v0/administration/dbc/dbc_trajects/{id}": { "get": { "tags": [ "dbc.DBCTraject" ], "summary": "Return the specific dbctraject as specified by the id", "operationId": "dbc.DBCTrajectAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting DBCTraject", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.DBCTraject" } } } }, "404": { "description": "DBCSubtraject not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dbc/dbc_trajects/{id}" ] } }, "/v0/administration/dbc/dbc_trajects/by_client/{client_id}": { "get": { "tags": [ "dbc.DBCTraject" ], "summary": "Return the dbc trajects of a Client corresponding to the given id.", "operationId": "dbc.DBCTrajectAPI.byClientId", "parameters": [ { "name": "client_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.list.DBCTrajectList" } } } } }, "x-replacement-for": [ "/t/clients/{client_id}/dbc_trajects" ] } }, "/v0/administration/debtors": { "get": { "tags": [ "Debtor" ], "summary": "Return a DebtorList containing all Debtors available from the DebtorAPI.", "description": "Filtered by Debtor type if one is provided.", "operationId": "DebtorAPI.all", "parameters": [ { "name": "type", "in": "query", "description": "The type of debtor. Null means no filtering. Possible filtering values:\n
\n ORGANISATIE(0, \"Organisatie\")\n ASIELZOEKERSCENTRUM(1, \"Asielzoekerscentrum\")\n ZORGKANTOOR(2, \"Zorgkantoor\")\n ZORGVERZEKERAAR(3, \"Verzekeraar\")\n GEMEENTE(4, \"Gemeente\")\n ONDERAANNEMER(5, \"Onderaannemer\")\n CLIENT(6, \"Cliënt\")\n CLIENT_EN_ZORGVERZEKERAAR(7, \"Cliënt en verzekeraar\")\n", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.DebtorList" } } } }, "400": { "description": "Invalid debtor type" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/debtors" ] } }, "/v0/administration/debtors/{id}": { "get": { "tags": [ "Debtor" ], "summary": "Return the Debtor corresponding to the given id", "operationId": "DebtorAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Debtor", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Debtor" } } } }, "404": { "description": "Debtor not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/debtors/{id}" ] } }, "/v0/administration/documents/{document_object_id}/status": { "put": { "tags": [ "Document" ], "summary": "Update the status of a document", "description": "WARNING: Documents uploaded without visibility settings (expertise profile or expertise group) may be visible to clients in Caren, depending on how the customer environment is set up.", "operationId": "DocumentAPI.updateStatus", "parameters": [ { "name": "document_object_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "status_code", "in": "query", "description": "The status of the document. Possible values: Stored(2), Deleted(3), Archived(6), Scheduled for purging(7)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } } }, "x-replacement-for": [ "/t/documents/update_status/{document_object_id}" ] } }, "/v0/administration/dossier/action_entries": { "post": { "tags": [ "dossier.ActionEntry" ], "summary": "Create ActionEntry", "operationId": "dossier.ActionEntryAPI.create", "requestBody": { "description": "Creates a new ActionEntry. Important: This endpoint only creates the ActionEntry. The associated Action must be present already and referenced by actionId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.ActionEntry" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.ActionEntry" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/action_entries" ] } }, "/v0/administration/dossier/action_entries/{id}": { "put": { "tags": [ "dossier.ActionEntry" ], "summary": "Updates the given ActionEntry", "operationId": "dossier.ActionEntryAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of ActionEntry to update.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "ActionEntry to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.ActionEntry" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.ActionEntry" } } } }, "400": { "description": "Validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/action_entries/{id}" ] }, "delete": { "tags": [ "dossier.ActionEntry" ], "summary": "Deletes the ActionEntry with given id", "operationId": "dossier.ActionEntryAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of ActionEntry to update.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "204": { "description": "If successfully removed the action entry" }, "400": { "description": "Validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/action_entries/{id}" ] } }, "/v0/administration/dossier/actions": { "post": { "tags": [ "dossier.Action" ], "summary": "Create Action", "operationId": "dossier.ActionAPI.create", "requestBody": { "description": "Action to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Action" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Action" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/actions" ] } }, "/v0/administration/dossier/actions/{id}": { "get": { "tags": [ "dossier.Action" ], "summary": "Get a resource by its ID", "operationId": "dossier.ActionAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Action", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Action" } } } }, "404": { "description": "Action not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/actions/{id}" ] }, "put": { "tags": [ "dossier.Action" ], "summary": "Updates the given Action", "operationId": "dossier.ActionAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Action", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "Action to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Action" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Action" } } } }, "400": { "description": "Validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/actions/{id}" ] }, "delete": { "tags": [ "dossier.Action" ], "summary": "Deletes the Action with given id", "operationId": "dossier.ActionAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Action", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "204": { "description": "If successfully removed the action" }, "400": { "description": "Validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/actions/{id}" ] } }, "/v0/administration/dossier/actions/multiple": { "get": { "tags": [ "dossier.Action" ], "summary": "Method used for requesting multiple Action objects using\ntheir ids.", "operationId": "dossier.ActionAPI.multiple", "parameters": [ { "name": "id", "in": "query", "description": "array style id's: id=1&id=2&etc", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.ActionList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/actions/multiple" ] } }, "/v0/administration/dossier/actions/search": { "get": { "tags": [ "dossier.Action" ], "summary": "Returns the Actions which meet the search criteria.", "operationId": "dossier.ActionAPI.search", "parameters": [ { "name": "keyword", "in": "query", "schema": { "type": "string" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.ActionList" } } } } }, "x-replacement-for": [ "/t/dossier/actions/search" ] } }, "/v0/administration/dossier/care_plan_entries": { "post": { "tags": [ "dossier.CarePlanEntry" ], "summary": "Create CarePlanEntry", "operationId": "dossier.CarePlanEntryAPI.create", "requestBody": { "description": "Creates a new CarePlanEntry. Important: This endpoint only creates the CarePlanEntry. Linked entries (DemandEntry, GoalEntry, ActionEntries) must be created via their respective endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.CarePlanEntry" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.CarePlanEntry" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/care_plan_entries" ] } }, "/v0/administration/dossier/care_plan_entries/{care_plan_entry_id}/action_entries": { "get": { "tags": [ "dossier.ActionEntry" ], "summary": "Return the ActionEntries of a CarePlanEntry corresponding to the given id.", "operationId": "dossier.ActionEntryAPI.byCarePlanEntryId", "parameters": [ { "name": "care_plan_entry_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.ActionEntryList" } } } } }, "x-replacement-for": [ "/t/dossier/care_plan_entries/{care_plan_entry_id}/action_entries" ] } }, "/v0/administration/dossier/care_plan_entries/{id}": { "get": { "tags": [ "dossier.CarePlanEntry" ], "summary": "Get a resource by its ID", "operationId": "dossier.CarePlanEntryAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting CarePlanEntry", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.CarePlanEntry" } } } }, "404": { "description": "Care plan entry not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/care_plan_entries/{id}" ] }, "put": { "tags": [ "dossier.CarePlanEntry" ], "summary": "Updates the given CarePlanEntry", "operationId": "dossier.CarePlanEntryAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting CarePlanEntry", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "CarePlanEntry to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.CarePlanEntry" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.CarePlanEntry" } } } }, "400": { "description": "Invalid care plan entry" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/care_plan_entries/{id}" ] }, "delete": { "tags": [ "dossier.CarePlanEntry" ], "summary": "Deletes the CarePlanEntry with given id", "operationId": "dossier.CarePlanEntryAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting CarePlanEntry", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "204": { "description": "If successfully removed the care plan entry" }, "400": { "description": "Invalid care plan entry" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/care_plan_entries/{id}" ] } }, "/v0/administration/dossier/care_plan_entries/create": { "post": { "tags": [ "dossier.CarePlanEntry" ], "summary": "Create a Care Plan Entry", "operationId": "dossier.CarePlanEntryAPI.createEntry", "parameters": [ { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.CreateCarePlanEntry" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.CarePlanEntry" } } } }, "400": { "description": "Invalid care plan entry" } }, "deprecated": true, "x-deprecated-since": "20-11-2023", "x-replacement-for": [ "/t/dossier/care_plan_entries/create" ] } }, "/v0/administration/dossier/care_plan_report_rights/last_report": { "get": { "tags": [ "dossier.CarePlanReportRight" ], "summary": "Return the care plan report rights of the most recent report created by the given employee and for the given client.", "operationId": "dossier.CarePlanReportRightAPI.getReportRightsForMostRecentReportByClientAndEmployee", "parameters": [ { "name": "client_id", "in": "query", "description": "id of client for whom the report is created", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "employee_id", "in": "query", "description": "id of employee that created the report", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.CarePlanReportRightList" } } } }, "400": { "description": "Client ID and employee ID are required" } }, "x-replacement-for": [ "/t/dossier/care_plan_report_rights/last_report" ] } }, "/v0/administration/dossier/care_plans": { "post": { "tags": [ "dossier.CarePlan" ], "summary": "Create CarePlan", "operationId": "dossier.CarePlanAPI.create", "requestBody": { "description": "Creates a new CarePlan. Important: This endpoint only creates the CarePlan object. Any nested elements such as CarePlanEntries, DemandEntries, GoalEntries, and ActionEntries must be created separately using their respective endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.CarePlan" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.CarePlan" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/care_plans" ] } }, "/v0/administration/dossier/care_plans/{care_plan_id}/entries": { "get": { "tags": [ "dossier.CarePlanEntry" ], "summary": "Return the CarePlanEntries of a CarePlan corresponding to the given id.", "operationId": "dossier.CarePlanEntryAPI.byCarePlanId", "parameters": [ { "name": "care_plan_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.CarePlanEntryList" } } } } }, "x-replacement-for": [ "/t/dossier/care_plans/{care_plan_id}/care_plan_entries" ] } }, "/v0/administration/dossier/care_plans/{id}": { "get": { "tags": [ "dossier.CarePlan" ], "summary": "Get the CarePlan corresponding to the given id", "operationId": "dossier.CarePlanAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting CarePlan", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.CarePlan" } } } }, "404": { "description": "Care plan does not exist" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/care_plans/{id}" ] }, "put": { "tags": [ "dossier.CarePlan" ], "summary": "Updates the given CarePlan", "operationId": "dossier.CarePlanAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting CarePlan", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "CarePlan to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.CarePlan" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.CarePlan" } } } }, "400": { "description": "Cannot update a carepan between statuses" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/care_plans/{id}" ] }, "delete": { "tags": [ "dossier.CarePlan" ], "summary": "Deletes the CarePlan with given id", "operationId": "dossier.CarePlanAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting CarePlan", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "204": { "description": "If successfully removed the care plan" }, "400": { "description": "Validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/care_plans/{id}" ] } }, "/v0/administration/dossier/care_plans/{id}/activate": { "post": { "tags": [ "dossier.CarePlan" ], "summary": "Activate care plan", "operationId": "dossier.CarePlanAPI.activate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.CarePlan" } } } } }, "x-replacement-for": [ "/t/dossier/care_plans/{id}/activate" ] } }, "/v0/administration/dossier/care_plans/{id}/archive": { "post": { "tags": [ "dossier.CarePlan" ], "summary": "Archive care plan", "operationId": "dossier.CarePlanAPI.archive", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.CarePlan" } } } } }, "x-replacement-for": [ "/t/dossier/care_plans/{id}/archive" ] } }, "/v0/administration/dossier/care_plans/by_client/{client_id}": { "get": { "tags": [ "dossier.CarePlan" ], "summary": "Return the care plans of a Client corresponding to the given id.", "operationId": "dossier.CarePlanAPI.byClientId", "parameters": [ { "name": "client_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.CarePlanList" } } } } }, "x-replacement-for": [ "/t/clients/{client_id}/care_plans" ] } }, "/v0/administration/dossier/care_plans/by_client/{client_id}/active": { "get": { "tags": [ "dossier.CarePlan" ], "summary": "Return the active care plan of a client corresponding to the given client id.", "operationId": "dossier.CarePlanAPI.activeCarePlanByClientId", "parameters": [ { "name": "client_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.CarePlan" } } } } }, "x-replacement-for": [ "/t/clients/{client_id}/active_care_plan" ] } }, "/v0/administration/dossier/care_plans/by_client/{client_id}/draft": { "get": { "tags": [ "dossier.CarePlan" ], "summary": "Return the draft care plan of a client corresponding to the given client id.", "operationId": "dossier.CarePlanAPI.draftCarePlanByClientId", "parameters": [ { "name": "client_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.CarePlan" } } } } }, "x-replacement-for": [ "/t/clients/{client_id}/draft_care_plan" ] } }, "/v0/administration/dossier/care_plans/by_client/{client_id}/new": { "post": { "tags": [ "dossier.CarePlan" ], "summary": "Draft new care plan for client", "operationId": "dossier.CarePlanAPI.newDraft", "parameters": [ { "name": "client_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.CarePlan" } } } }, "404": { "description": "Client not found or user not found" } }, "x-replacement-for": [ "/t/dossier/care_plans/by_client/{client_id}/new" ] } }, "/v0/administration/dossier/client_notes": { "get": { "tags": [ "dossier.ClientNote" ], "summary": "Returns every ClientNote available from the ClientNote API", "operationId": "dossier.ClientNoteAPI.all", "parameters": [ { "name": "updatedSince", "in": "query", "schema": { "type": "string", "format": "date" }, "x-original-parameter": { "name": "updated_since" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.ClientNoteList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/client_notes" ] }, "post": { "tags": [ "dossier.ClientNote" ], "summary": "Create ClientNote", "operationId": "dossier.ClientNoteAPI.create", "parameters": [ { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "ClientNote to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.ClientNote" } } }, "required": true }, "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.ClientNote" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/client_notes" ] } }, "/v0/administration/dossier/client_notes/{id}": { "get": { "tags": [ "dossier.ClientNote" ], "operationId": "dossier.ClientNoteAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting ClientNote", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.ClientNote" } } } }, "404": { "description": "ClientNote not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/client_notes/{id}" ] }, "put": { "tags": [ "dossier.ClientNote" ], "summary": "Updates the given ClientNote", "operationId": "dossier.ClientNoteAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting ClientNote", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "ClientNote to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.ClientNote" } } }, "required": true }, "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.ClientNote" } } } }, "400": { "description": "Validation errors" }, "404": { "description": "ClientNote not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/client_notes/{id}" ] }, "delete": { "tags": [ "dossier.ClientNote" ], "summary": "Deletes the ClientNote with given id", "operationId": "dossier.ClientNoteAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting ClientNote", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.ClientNote" } } } }, "404": { "description": "ClientNote not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/client_notes/{id}" ] } }, "/v0/administration/dossier/client_notes/by_client/{client_id}": { "get": { "tags": [ "dossier.ClientNote" ], "summary": "Return the client notes of a Client corresponding to the given id.", "operationId": "dossier.ClientNoteAPI.byClientId", "parameters": [ { "name": "client_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.ClientNoteList" } } } } }, "x-replacement-for": [ "/t/clients/{client_id}/client_notes" ] } }, "/v0/administration/dossier/demand_entries": { "post": { "tags": [ "dossier.DemandEntry" ], "summary": "Create DemandEntry", "operationId": "dossier.DemandEntryAPI.create", "requestBody": { "description": "Creates a new DemandEntry. Important: This endpoint only creates the DemandEntry. The associated Demand object must be present already and referenced by demandId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.DemandEntry" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.DemandEntry" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/demand_entries" ] } }, "/v0/administration/dossier/demand_entries/{id}": { "delete": { "tags": [ "dossier.DemandEntry" ], "summary": "Deletes the DemandEntry with given id", "operationId": "dossier.DemandEntryAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of DemandEntry to delete.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "204": { "description": "If successfully removed the demand entry" }, "400": { "description": "Validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/demand_entries/{id}" ] } }, "/v0/administration/dossier/demands": { "post": { "tags": [ "dossier.Demand" ], "summary": "Create Demand", "operationId": "dossier.DemandAPI.create", "requestBody": { "description": "Demand to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Demand" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Demand" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/demands" ] } }, "/v0/administration/dossier/demands/{demand_id}/goals": { "get": { "tags": [ "dossier.Goal" ], "summary": "Return the Goals of a Demand corresponding to the given id.", "operationId": "dossier.GoalAPI.byDemandId", "parameters": [ { "name": "demand_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.GoalList" } } } } }, "x-replacement-for": [ "/t/dossier/demands/{demand_id}/goals" ] } }, "/v0/administration/dossier/demands/{id}": { "get": { "tags": [ "dossier.Demand" ], "summary": "Get a resource by its ID", "operationId": "dossier.DemandAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Demand", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Demand" } } } }, "404": { "description": "Demand not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/demands/{id}" ] }, "put": { "tags": [ "dossier.Demand" ], "summary": "Updates the given Demand", "operationId": "dossier.DemandAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Demand", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "Demand to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Demand" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Demand" } } } }, "400": { "description": "Validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/demands/{id}" ] }, "delete": { "tags": [ "dossier.Demand" ], "summary": "Deletes the Demand with given id", "operationId": "dossier.DemandAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Demand", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "204": { "description": "If successfully removed the demand" }, "400": { "description": "Validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/demands/{id}" ] } }, "/v0/administration/dossier/demands/multiple": { "get": { "tags": [ "dossier.Demand" ], "summary": "Method used for requesting multiple Demand objects using\ntheir ids.", "operationId": "dossier.DemandAPI.multiple", "parameters": [ { "name": "id", "in": "query", "description": "array style id's: id=1&id=2&etc", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.DemandList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/demands/multiple" ] } }, "/v0/administration/dossier/domains": { "get": { "tags": [ "dossier.Domain" ], "summary": "Returns every Domain available from the DomainAPI", "operationId": "dossier.DomainAPI.all", "parameters": [ { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.DomainList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/domains" ] }, "post": { "tags": [ "dossier.Domain" ], "summary": "Create Domain", "operationId": "dossier.DomainAPI.create", "requestBody": { "description": "Domain to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Domain" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Domain" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/domains" ] } }, "/v0/administration/dossier/domains/{domain_id}/actions": { "get": { "tags": [ "dossier.Action" ], "summary": "Return the Actions of a Domain corresponding to the given id.", "operationId": "dossier.ActionAPI.byDomainId", "parameters": [ { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.ActionList" } } } } }, "x-replacement-for": [ "/t/dossier/domains/{domain_id}/actions" ] } }, "/v0/administration/dossier/domains/{domain_id}/demands": { "get": { "tags": [ "dossier.Demand" ], "summary": "Return the Demands of a Domain corresponding to the given id.", "operationId": "dossier.DemandAPI.byDomainId", "parameters": [ { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.DemandList" } } } } }, "x-replacement-for": [ "/t/dossier/domains/{domain_id}/demands" ] } }, "/v0/administration/dossier/domains/{domain_id}/goals": { "get": { "tags": [ "dossier.Goal" ], "summary": "Return the Goals of a Domain corresponding to the given id.", "operationId": "dossier.GoalAPI.byDomainId", "parameters": [ { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.GoalList" } } } } }, "x-replacement-for": [ "/t/dossier/domains/{domain_id}/goals" ] } }, "/v0/administration/dossier/domains/{id}": { "get": { "tags": [ "dossier.Domain" ], "summary": "Get a resource by its ID", "operationId": "dossier.DomainAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Domain", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Domain" } } } }, "404": { "description": "Domain not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/domains/{id}" ] }, "put": { "tags": [ "dossier.Domain" ], "summary": "Updates the given Domain", "operationId": "dossier.DomainAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Domain", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "Domain to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Domain" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Domain" } } } }, "400": { "description": "Validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/domains/{id}" ] } }, "/v0/administration/dossier/domains/multiple": { "get": { "tags": [ "dossier.Domain" ], "summary": "Method used for requesting multiple Domain objects using\ntheir ids.", "operationId": "dossier.DomainAPI.multiple", "parameters": [ { "name": "id", "in": "query", "description": "array style id's: id=1&id=2&etc", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.DomainList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/domains/multiple" ] } }, "/v0/administration/dossier/goal_entries": { "post": { "tags": [ "dossier.GoalEntry" ], "summary": "Create GoalEntry", "operationId": "dossier.GoalEntryAPI.create", "requestBody": { "description": "Creates a new GoalEntry. Important: This endpoint only creates the GoalEntry.The associated Goal must be present already and referenced by goalId.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.GoalEntry" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.GoalEntry" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/goal_entries" ] } }, "/v0/administration/dossier/goal_entries/{id}": { "get": { "tags": [ "dossier.GoalEntry" ], "summary": "Get a resource by its ID", "operationId": "dossier.GoalEntryAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting GoalEntry", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.GoalEntry" } } } }, "404": { "description": "GoalEntry not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/goal_entries/{id}" ] }, "put": { "tags": [ "dossier.GoalEntry" ], "summary": "Updates the given GoalEntry", "operationId": "dossier.GoalEntryAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting GoalEntry", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "GoalEntry to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.GoalEntry" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.GoalEntry" } } } }, "400": { "description": "Validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/goal_entries/{id}" ] }, "delete": { "tags": [ "dossier.GoalEntry" ], "summary": "Deletes the GoalEntry with given id", "operationId": "dossier.GoalEntryAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting GoalEntry", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "204": { "description": "If successfully removed the goal entry" }, "400": { "description": "Validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/goal_entries/{id}" ] } }, "/v0/administration/dossier/goals": { "post": { "tags": [ "dossier.Goal" ], "summary": "Create Goal", "operationId": "dossier.GoalAPI.create", "requestBody": { "description": "Goal to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Goal" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Goal" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/goals" ] } }, "/v0/administration/dossier/goals/{goal_id}/actions": { "get": { "tags": [ "dossier.Action" ], "summary": "Return the Actions of a Goal corresponding to the given id.", "operationId": "dossier.ActionAPI.byGoalId", "parameters": [ { "name": "goal_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.ActionList" } } } } }, "x-replacement-for": [ "/t/dossier/goals/{goal_id}/actions" ] } }, "/v0/administration/dossier/goals/{id}": { "get": { "tags": [ "dossier.Goal" ], "summary": "Get a resource by its ID", "operationId": "dossier.GoalAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Goal", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Goal" } } } }, "404": { "description": "Goal not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/goals/{id}" ] }, "put": { "tags": [ "dossier.Goal" ], "summary": "Updates the given Goal", "operationId": "dossier.GoalAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Goal", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "Goal to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Goal" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Goal" } } } }, "400": { "description": "Validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/goals/{id}" ] }, "delete": { "tags": [ "dossier.Goal" ], "summary": "Deletes the Goal with given id", "operationId": "dossier.GoalAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Goal", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "204": { "description": "If successfully removed the goal" }, "400": { "description": "Validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/goals/{id}" ] } }, "/v0/administration/dossier/goals/multiple": { "get": { "tags": [ "dossier.Goal" ], "summary": "Method used for requesting multiple Goal objects using\ntheir ids.", "operationId": "dossier.GoalAPI.multiple", "parameters": [ { "name": "id", "in": "query", "description": "array style id's: id=1&id=2&etc", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.GoalList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/goals/multiple" ] } }, "/v0/administration/dossier/goals/search": { "get": { "tags": [ "dossier.Goal" ], "summary": "Returns the Goals which meet the search criteria.", "operationId": "dossier.GoalAPI.search", "parameters": [ { "name": "keyword", "in": "query", "schema": { "type": "string" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.GoalList" } } } } }, "x-replacement-for": [ "/t/dossier/goals/search" ] } }, "/v0/administration/dossier/medical_notes": { "get": { "tags": [ "dossier.MedicalNote" ], "summary": "Returns every MedicalNote available from the MedicalNoteAPI", "operationId": "dossier.MedicalNoteAPI.all", "parameters": [ { "name": "updatedSince", "in": "query", "schema": { "type": "string", "format": "date" }, "x-original-parameter": { "name": "updated_since" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.MedicalNoteList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical_notes" ] }, "post": { "tags": [ "dossier.MedicalNote" ], "summary": "Create MedicalNote", "operationId": "dossier.MedicalNoteAPI.create", "parameters": [ { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "MedicalNote to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.MedicalNote" } } }, "required": true }, "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.MedicalNote" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical_notes" ] } }, "/v0/administration/dossier/medical_notes/{id}": { "get": { "tags": [ "dossier.MedicalNote" ], "operationId": "dossier.MedicalNoteAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting MedicalNote", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.MedicalNote" } } } }, "404": { "description": "MedicalNote not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical_notes/{id}" ] }, "put": { "tags": [ "dossier.MedicalNote" ], "summary": "Updates the given MedicalNote", "operationId": "dossier.MedicalNoteAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting MedicalNote", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "MedicalNote to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.MedicalNote" } } }, "required": true }, "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.MedicalNote" } } } }, "400": { "description": "Validation errors" }, "404": { "description": "MedicalNote not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical_notes/{id}" ] }, "delete": { "tags": [ "dossier.MedicalNote" ], "summary": "Deletes the MedicalNote with given id", "operationId": "dossier.MedicalNoteAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting MedicalNote", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.MedicalNote" } } } }, "404": { "description": "MedicalNote not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical_notes/{id}" ] } }, "/v0/administration/dossier/medical_notes/by_client/{client_id}": { "get": { "tags": [ "dossier.MedicalNote" ], "summary": "Return the active medical notes of a Client corresponding to the given id.", "operationId": "dossier.MedicalNoteAPI.byClientId", "parameters": [ { "name": "client_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.MedicalNoteList" } } } } }, "x-replacement-for": [ "/t/clients/{client_id}/medical_notes" ] } }, "/v0/administration/dossier/medical_notes/unfiltered_by_client/{client_id}": { "get": { "tags": [ "dossier.MedicalNote" ], "summary": "Return all the medical notes (including archived) of a Client corresponding to the given id.", "operationId": "dossier.MedicalNoteAPI.unfilteredByClientId", "parameters": [ { "name": "client_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.MedicalNoteList" } } } } }, "x-replacement-for": [ "/t/clients/{client_id}/unfiltered_medical_notes" ] } }, "/v0/administration/dossier/report_types": { "get": { "tags": [ "dossier.ReportType" ], "summary": "Returns every ReportType available from the ReportTypeAPI", "operationId": "dossier.ReportTypeAPI.all", "parameters": [ { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.ReportTypeList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/report_types" ] } }, "/v0/administration/dossier/report_types/{id}": { "get": { "tags": [ "dossier.ReportType" ], "operationId": "dossier.ReportTypeAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting ReportType", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.ReportType" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/report_types/{id}" ] }, "put": { "tags": [ "dossier.ReportType" ], "summary": "Updates the given ReportType", "operationId": "dossier.ReportTypeAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting ReportType", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "ReportType to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.ReportType" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.ReportType" } } } }, "400": { "description": "Validation errors" }, "404": { "description": "The report type is not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/report_types/{id}" ] } }, "/v0/administration/dossier/reports": { "post": { "tags": [ "dossier.Report" ], "summary": "Create Report", "operationId": "dossier.ReportAPI.create", "parameters": [ { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "Report to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Report" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Report" } } } }, "400": { "description": "Validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/reports" ] } }, "/v0/administration/dossier/reports/{id}": { "get": { "tags": [ "dossier.Report" ], "summary": "Return the Report corresponding to the given id", "operationId": "dossier.ReportAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Report", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Report" } } } }, "404": { "description": "Report not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/reports/{id}" ] }, "put": { "tags": [ "dossier.Report" ], "summary": "Updates the given Report", "operationId": "dossier.ReportAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Report", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "Report to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Report" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Report" } } } }, "400": { "description": "Validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/reports/{id}" ] }, "delete": { "tags": [ "dossier.Report" ], "summary": "Deletes the Report with given id", "operationId": "dossier.ReportAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Report", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Report" } } } }, "204": { "description": "Success" }, "404": { "description": "Report does not exist" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/reports/{id}" ] } }, "/v0/administration/dossier/reports/{report_id}/children": { "get": { "tags": [ "dossier.Report" ], "summary": "Returns all the reactions for a given report", "operationId": "dossier.ReportAPI.childrenByReportId", "parameters": [ { "name": "report_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.ReportList" } } } } }, "x-replacement-for": [ "/t/dossier/reports/{report_id}/children" ] } }, "/v0/administration/dossier/reports/by_care_plan_entry_unescaped/{care_plan_entry_id}": { "get": { "tags": [ "dossier.Report" ], "summary": "Returns all reports filtered by care plan entry without applying HTML esaping.", "operationId": "dossier.ReportAPI.findByCarePlanEntryUnescaped", "parameters": [ { "name": "care_plan_entry_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "report_type", "in": "query", "explode": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "offset", "in": "query", "description": "number of results to skip", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "number of results for one call", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.ReportList" } } } } }, "x-replacement-for": [ "/t/dossier/reports/by_care_plan_entry_unescaped/{care_plan_entry_id}" ] } }, "/v0/administration/dossier/reports/by_care_plan_entry/{care_plan_entry_id}": { "get": { "tags": [ "dossier.Report" ], "summary": "Returns all reports filtered by care plan entry with HTML escaping applied to text fields.", "operationId": "dossier.ReportAPI.findByCarePlanEntry", "parameters": [ { "name": "care_plan_entry_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "report_type", "in": "query", "explode": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "offset", "in": "query", "description": "number of results to skip", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "number of results for one call", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.ReportList" } } } } }, "x-replacement-for": [ "/t/dossier/reports/by_care_plan_entry/{care_plan_entry_id}" ] } }, "/v0/administration/dossier/reports/by_date/{valid_from}...{valid_to}": { "get": { "tags": [ "dossier.Report" ], "summary": "Returns all reports filtered by date.", "description": "valid_from and valid_to are required query parameters", "operationId": "dossier.ReportAPI.findByDate", "parameters": [ { "name": "client_id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "report_type", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "valid_from", "in": "path", "description": "starting time", "required": true, "schema": { "type": "string", "format": "date" }, "x-original-parameter": { "in": "query" } }, { "name": "valid_to", "in": "path", "description": "end time", "required": true, "schema": { "type": "string", "format": "date" }, "x-original-parameter": { "in": "query" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.ReportList" } } } } }, "x-replacement-for": [ "/t/dossier/reports/by_date" ] } }, "/v0/administration/dossier/reports/by_demand/{demand_id}": { "get": { "tags": [ "dossier.Report" ], "summary": "Returns all reports filtered by demand id.", "operationId": "dossier.ReportAPI.findByDemand", "parameters": [ { "name": "demand_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "report_type", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "client_id", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.ReportList" } } } } }, "x-replacement-for": [ "/t/dossier/reports/by_demand/{demand_id}" ] } }, "/v0/administration/dossier/reports/by_episode/{episode_id}": { "get": { "tags": [ "dossier.Report" ], "summary": "Returns all reports filtered by episode id.", "operationId": "dossier.ReportAPI.findByEpisode", "parameters": [ { "name": "episode_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "report_type", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.ReportList" } } } } }, "x-replacement-for": [ "/t/dossier/reports/by_episode/{episode_id}" ] } }, "/v0/administration/dossier/reports/by_report_link/{report_link_id}": { "get": { "tags": [ "dossier.Report" ], "summary": "Returns all reports filtered by report link id.", "operationId": "dossier.ReportAPI.findByReportLink", "parameters": [ { "name": "report_link_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "report_link_type", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/dossier.ReportLinkType" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Report" } } } } }, "x-replacement-for": [ "/t/dossier/reports/by_report_link/{report_link_id}" ] } }, "/v0/administration/dossier/reports/by_restrictive_measure/{restrictive_measure_id}": { "get": { "tags": [ "dossier.Report" ], "summary": "Returns all reports filtered by restrictive measures id.", "operationId": "dossier.ReportAPI.findByRestrictiveMeasure", "parameters": [ { "name": "restrictive_measure_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "report_type", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.ReportList" } } } } }, "x-replacement-for": [ "/t/dossier/reports/by_restrictive_measure/{restrictive_measure_id}" ] } }, "/v0/administration/dossier/reports/by_uuid/{uuid}": { "get": { "tags": [ "dossier.Report" ], "summary": "Return the Report corresponding to the given uuid", "operationId": "dossier.ReportAPI.byUuid", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Report" } } } }, "404": { "description": "Report not found" } }, "x-replacement-for": [ "/t/dossier/reports/by_uuid/{uuid}" ] } }, "/v0/administration/dossier/reports/last_report_authorizations": { "get": { "tags": [ "dossier.Report" ], "summary": "Return the child Reports of a Report corresponding to the given id.", "operationId": "dossier.ReportAPI.lastReportAuthorizationsByClientIdAndEmployeeId", "parameters": [ { "name": "client_id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "employee_id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.ReportAuthorizationList" } } } }, "400": { "description": "Client and employee are required" } }, "x-replacement-for": [ "/t/dossier/reports/last_report_authorizations" ] } }, "/v0/administration/dossier/reports/search_by_client": { "get": { "tags": [ "dossier.Report" ], "summary": "Searches for Reports for the Client (corresponding to the given id)", "operationId": "dossier.ReportAPI.searchByClient", "parameters": [ { "name": "client_id", "in": "query", "description": "which we want to search reports for", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "keyword", "in": "query", "description": "a text search term", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "the type of information to filter on", "schema": { "$ref": "#/components/schemas/dossier.ReportFilter" } }, { "name": "education_id", "in": "query", "description": "filters on reports of which the author has a specific employee", "schema": { "type": "integer", "format": "int64" } }, { "name": "show_hidden", "in": "query", "description": "shows hidden reports only has effect for the author or application managers", "schema": { "type": "boolean" } }, { "name": "report_type", "in": "query", "description": "list of types to filter on", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "valid_from", "in": "query", "description": "start search date", "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "description": "end search date", "schema": { "type": "string", "format": "date" } }, { "name": "demand_id", "in": "query", "description": "filters on reports to include only those related to a specific demand", "schema": { "type": "integer", "format": "int64" } }, { "name": "entry_id", "in": "query", "description": "filters on reports to include only those related to a specific care plan entry", "schema": { "type": "integer", "format": "int64" } }, { "name": "episode_id", "in": "query", "description": "filters on reports to include only those related to a specific episode", "schema": { "type": "integer", "format": "int64" } }, { "name": "restrictive_measure_id", "in": "query", "description": "filters on reports to include only those related to a specific restrictictive measure", "schema": { "type": "integer", "format": "int64" } }, { "name": "report_types_with_comments", "in": "query", "description": "filters on reports that have comments", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "only_own_reports", "in": "query", "description": "filters on reports written by the user", "schema": { "type": "boolean" } }, { "name": "offset", "in": "query", "description": "number of results to skip", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "number of results for one call", "schema": { "type": "integer", "format": "int32" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } }, { "name": "If-Modified-Since", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.ReportList" } } } }, "304": { "description": "The reports have not been modified since the value of the If-Modified-Since header" }, "400": { "description": "No client ID" } }, "x-replacement-for": [ "/t/dossier/reports/search_by_client" ] } }, "/v0/administration/dossier/reports/soap/report": { "post": { "tags": [ "dossier.Report" ], "summary": "Create a SOAP report where each soap-part (optionally) has it's own authorization\nTo make use of the per-soap-part authorization model make sure to fill each of the S-O-A-P parts\nof a SOAP report and put them in the SoapReportEntries nested in the Report.", "description": "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 them in the SoapReportEntries nested in the Report.", "operationId": "dossier.ReportAPI.createSoapReport", "parameters": [ { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "the report to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Report" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Report" } } } }, "400": { "description": "Validation errors" } }, "x-replacement-for": [ "/t/dossier/reports/soap/report" ] } }, "/v0/administration/dossier/reports/soap/report/{id}": { "put": { "tags": [ "dossier.Report" ], "summary": "Updates a SOAP report where each soap-part (optionally) has it's own authorization\nTo make use of the per-soap-part authorization model make sure to fill each of the S-O-A-P parts\nof a SOAP report and put them in the SoapReportEntries nested in the Report.", "description": "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 them in the SoapReportEntries nested in the Report.", "operationId": "dossier.ReportAPI.updateSoapReport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "the report to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Report" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Report" } } } }, "400": { "description": "Validation errors" } }, "x-replacement-for": [ "/t/dossier/reports/soap/report/{id}" ] } }, "/v0/administration/dossier/system_notes": { "get": { "tags": [ "dossier.SystemNote" ], "summary": "Returns every SystemNote available from the SystemNoteAPI", "operationId": "dossier.SystemNoteAPI.all", "parameters": [ { "name": "updatedSince", "in": "query", "schema": { "type": "string", "format": "date" }, "x-original-parameter": { "name": "updated_since" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.SystemNoteList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/system_notes" ] }, "post": { "tags": [ "dossier.SystemNote" ], "summary": "Create SystemNote", "operationId": "dossier.SystemNoteAPI.create", "parameters": [ { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "SystemNote to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.SystemNote" } } }, "required": true }, "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.SystemNote" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/system_notes" ] } }, "/v0/administration/dossier/system_notes/{id}": { "get": { "tags": [ "dossier.SystemNote" ], "operationId": "dossier.SystemNoteAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting SystemNote", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.SystemNote" } } } }, "404": { "description": "SystemNote not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/system_notes/{id}" ] }, "put": { "tags": [ "dossier.SystemNote" ], "summary": "Updates the given SystemNote", "operationId": "dossier.SystemNoteAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting SystemNote", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "SystemNote to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.SystemNote" } } }, "required": true }, "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.SystemNote" } } } }, "400": { "description": "Validation errors" }, "404": { "description": "SystemNote not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/system_notes/{id}" ] }, "delete": { "tags": [ "dossier.SystemNote" ], "summary": "Deletes the SystemNote with given id", "operationId": "dossier.SystemNoteAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting SystemNote", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.SystemNote" } } } }, "404": { "description": "SystemNote not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/system_notes/{id}" ] } }, "/v0/administration/employee_addresses": { "post": { "tags": [ "EmployeeAddress" ], "summary": "Create EmployeeAddress", "operationId": "EmployeeAddressAPI.create", "requestBody": { "description": "EmployeeAddress to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeAddress" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeAddress" } } } }, "400": { "description": "EmployeeAddress must have an employee" }, "404": { "description": "Employee not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/employee_addresses" ] } }, "/v0/administration/employee_addresses/{id}": { "get": { "tags": [ "EmployeeAddress" ], "summary": "Return the Employee Address corresponding to the given", "operationId": "EmployeeAddressAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting EmployeeAddress", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeAddress" } } } }, "404": { "description": "Address or EmployeeAddress not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/employee_addresses/{id}" ] } }, "/v0/administration/employee_workflows/{employee_id}/timesheet_submit_date": { "put": { "tags": [ "EmployeeWorkflow" ], "operationId": "EmployeeWorkflowAPI.setTimesheetSubmitDate", "parameters": [ { "name": "employee_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "submit_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "204": { "description": "Sumitted" } }, "x-replacement-for": [ "/t/employee_workflows/{employee_id}/timesheet_submit_date" ] } }, "/v0/administration/employee_workflows/{employee_id}/timesheet_submit_date_authorized": { "put": { "tags": [ "EmployeeWorkflow" ], "operationId": "EmployeeWorkflowAPI.setTimesheetSubmitDateAuthorized", "parameters": [ { "name": "employee_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "submit_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "204": { "description": "Submitted" } }, "x-replacement-for": [ "/t/employee_workflows/{employee_id}/timesheet_submit_date_authorized" ] } }, "/v0/administration/employees": { "post": { "tags": [ "Employee" ], "summary": "Create Employee", "operationId": "EmployeeAPI.create", "requestBody": { "description": "Employee to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" } } } }, "400": { "description": "Validation errors, or missing identification number when automatic numbering is not enabled" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/employees" ] } }, "/v0/administration/employees/{employee_id}": { "get": { "tags": [ "Employee" ], "summary": "Find employee by employee object id.", "operationId": "EmployeeAPI.byId", "parameters": [ { "name": "employee_id", "in": "path", "description": "The employee object id of the employee to find.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/employees/{employee_id}" ] }, "put": { "tags": [ "Employee" ], "summary": "Updates an employee", "operationId": "EmployeeAPI.update", "parameters": [ { "name": "employee_id", "in": "path", "description": "id of the employee to update", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/employees/{employee_id}" ] } }, "/v0/administration/employees/{employee_id}/addresses": { "get": { "tags": [ "Address" ], "summary": "Return the addresses of an Employee corresponding to the given id.", "operationId": "AddressAPI.byEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.AddressList" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/addresses" ] } }, "/v0/administration/employees/{employee_id}/agb_codes": { "get": { "tags": [ "PractitionerAgbCode" ], "summary": "Return the AGB codes assigned to the employee corresponding to the provided id", "operationId": "PractitionerAgbCodeAPI.byEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.PractitionerAgbCodeList" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/agb_codes" ] }, "post": { "tags": [ "PractitionerAgbCode" ], "summary": "Creates the provided AGB code and assigns it to the employee corresponding to the provided id", "operationId": "PractitionerAgbCodeAPI.createForEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PractitionerAgbCode" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PractitionerAgbCode" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/agb_codes" ] } }, "/v0/administration/employees/{employee_id}/agb_codes/{agb_code_id}": { "get": { "tags": [ "PractitionerAgbCode" ], "summary": "Return the AGB code with the provided id assigned to the employee corresponding to the provided id", "operationId": "PractitionerAgbCodeAPI.byEmployeeIdAndAgbId", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "agb_code_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PractitionerAgbCode" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/agb_codes/{agb_code_id}" ] }, "put": { "tags": [ "PractitionerAgbCode" ], "summary": "Updates the provided AGB code assigned to the employee corresponding to the provided id", "operationId": "PractitionerAgbCodeAPI.updateForEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "agb_code_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PractitionerAgbCode" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PractitionerAgbCode" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/agb_codes/{agb_code_id}" ] }, "delete": { "tags": [ "PractitionerAgbCode" ], "summary": "Deletes the AGB code with the provided id assigned to the employee corresponding to the provided id", "operationId": "PractitionerAgbCodeAPI.deleteForEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "agb_code_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No response was specified" } }, "x-replacement-for": [ "/t/employees/{employee_id}/agb_codes/{agb_code_id}" ] } }, "/v0/administration/employees/{employee_id}/bank_account": { "get": { "tags": [ "Employee" ], "summary": "Return the bank account assigned to the Employee corresponding to the given id", "operationId": "EmployeeAPI.bankAccount", "parameters": [ { "name": "employee_id", "in": "path", "description": "the id of the employee", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccount" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/bank_account" ] } }, "/v0/administration/employees/{employee_id}/big_codes": { "get": { "tags": [ "PractitionerBigCode" ], "summary": "Return the BIG codes assigned to the employee corresponding to the provided id", "operationId": "PractitionerBigCodeAPI.byEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.PractitionerBigCodeList" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/big_codes" ] }, "post": { "tags": [ "PractitionerBigCode" ], "summary": "Creates the provided BIG code and assigns it to the employee corresponding to the provided id", "operationId": "PractitionerBigCodeAPI.createForEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PractitionerBigCode" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PractitionerBigCode" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/big_codes" ] } }, "/v0/administration/employees/{employee_id}/big_codes/{big_code_id}": { "get": { "tags": [ "PractitionerBigCode" ], "summary": "Return the BIG code with the provided id assigned to the employee corresponding to the provided id", "operationId": "PractitionerBigCodeAPI.byEmployeeIdAndBigId", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "big_code_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PractitionerBigCode" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/big_codes/{big_code_id}" ] }, "put": { "tags": [ "PractitionerBigCode" ], "summary": "Updates the provided BIG code assigned to the employee corresponding to the provided id", "operationId": "PractitionerBigCodeAPI.updateForEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "big_code_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PractitionerBigCode" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PractitionerBigCode" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/big_codes/{big_code_id}" ] }, "delete": { "tags": [ "PractitionerBigCode" ], "summary": "Deletes the BIG code with the provided id assigned to the employee corresponding to the provided id", "operationId": "PractitionerBigCodeAPI.deleteForEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "big_code_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No response was specified" } }, "x-replacement-for": [ "/t/employees/{employee_id}/big_codes/{big_code_id}" ] } }, "/v0/administration/employees/{employee_id}/client_employee_relations": { "get": { "tags": [ "ClientEmployeeRelation" ], "summary": "Return the ClientEmployeeRelations corresponding to the given employee id", "operationId": "ClientEmployeeRelationAPI.byEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "description": "id of the Employee", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "valid_from", "in": "query", "description": "Lower bound (inclusive) on the relation's validity period", "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "description": "Upper bound (exclusive) on the relation's validity period", "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "description": "number of results for one call", "schema": { "type": "integer", "format": "int32", "default": 2147483647 } }, { "name": "offset", "in": "query", "description": "number of results to skip", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ClientEmployeeRelationList" } } } } }, "x-replacement-for": [ "/t/administration/employees/{employee_id}/client_employee_relations" ] } }, "/v0/administration/employees/{employee_id}/clipped_teams": { "get": { "tags": [ "Team" ], "summary": "Return the teams of a Employee corresponding to the given id between 2 dates.", "operationId": "TeamAPI.byEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "description": "The identifier of the employee for which to retrieve teams", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "valid_from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.TeamList" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/teams" ] } }, "/v0/administration/employees/{employee_id}/contracts": { "get": { "tags": [ "payroll.Contract" ], "summary": "Return the contracts of an Employee corresponding to the given id.", "operationId": "payroll.ContractAPI.byEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.list.ContractList" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/contracts" ] } }, "/v0/administration/employees/{employee_id}/expertise_profile_assignments": { "get": { "tags": [ "ExpertiseProfileAssignment" ], "summary": "Return the expertise profile assignments of a Employee corresponding to the given id.", "operationId": "ExpertiseProfileAssignmentAPI.byEmployeeIdAndDateRange", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "valid_from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ExpertiseProfileAssignmentList" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/expertise_profile_assignments" ] } }, "/v0/administration/employees/{employee_id}/expertise_profiles": { "get": { "tags": [ "ExpertiseProfile" ], "summary": "Return the expertise profiles of a Employee corresponding to the given id between the given dates.", "operationId": "ExpertiseProfileAPI.byEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "valid_from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ExpertiseProfileList" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/expertise_profiles" ] } }, "/v0/administration/employees/{employee_id}/presence_logs": { "get": { "tags": [ "PresenceLog" ], "summary": "Return the presence logs of a Employee corresponding to the given id.", "description": "Setting extended to true\n calculates the ORT hours on the fly and adds them to the response.", "operationId": "PresenceLogAPI.byEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "valid_from", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "extended", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.PresenceLogList" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/presence_logs" ] } }, "/v0/administration/employees/{employee_id}/primary_address": { "get": { "tags": [ "Address" ], "summary": "Return the currently active main address of the employee corresponding to the given id.", "description": "Returns the currently active main address of the employee corresponding to the given id. The search order corresponds to the order shown when searching for employees.\nThis can be configured in the application - but this can be set by Nedap only. It defaults to the legal address search order.", "operationId": "AddressAPI.mainAddressByEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Address" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/main_address" ] } }, "/v0/administration/employees/{employee_id}/privacy_settings": { "put": { "tags": [ "EmployeePrivacySettings" ], "summary": "Update the employee privacy settings corresponding to the given id.", "operationId": "EmployeePrivacySettingsAPI.updateByEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeePrivacySettings" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeePrivacySettings" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/privacy_settings" ] } }, "/v0/administration/employees/{employee_id}/professions": { "get": { "tags": [ "PractitionerProfession" ], "summary": "Return the professions assigned to the employee corresponding to the provided id", "operationId": "PractitionerProfessionAPI.byEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.PractitionerProfessionList" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/professions" ] }, "post": { "tags": [ "PractitionerProfession" ], "summary": "Creates the provided profession and assigns it to the employee corresponding to the provided id", "operationId": "PractitionerProfessionAPI.createForEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PractitionerProfession" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PractitionerProfession" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/professions" ] } }, "/v0/administration/employees/{employee_id}/professions/{profession_id}": { "get": { "tags": [ "PractitionerProfession" ], "summary": "Return the profession with the provided id assigned to the employee corresponding to the provided id", "operationId": "PractitionerProfessionAPI.byEmployeeIdAndProfessionId", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "profession_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PractitionerProfession" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/professions/{profession_id}" ] }, "put": { "tags": [ "PractitionerProfession" ], "summary": "Updates the provided profession assigned to the employee corresponding to the provided id", "operationId": "PractitionerProfessionAPI.updateForEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "profession_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PractitionerProfession" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PractitionerProfession" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/professions/{profession_id}" ] }, "delete": { "tags": [ "PractitionerProfession" ], "summary": "Deletes the profession with the provided id assigned to the employee corresponding to the provided id", "operationId": "PractitionerProfessionAPI.deleteForEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "profession_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No response was specified" } }, "x-replacement-for": [ "/t/employees/{employee_id}/professions/{profession_id}" ] } }, "/v0/administration/employees/{employee_id}/teams": { "get": { "tags": [ "TeamAssignment" ], "summary": "Return the team assignments of a Employee corresponding to the given id.", "operationId": "TeamAssignmentAPI.byEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "valid_from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.TeamAssignmentList" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/team_assignments" ] }, "post": { "tags": [ "TeamAssignment" ], "summary": "Create the provided team assignment and assign it to the employee corresponding to the provided id.", "operationId": "TeamAssignmentAPI.createForEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamAssignment" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamAssignment" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/team_assignments" ] } }, "/v0/administration/employees/{employee_id}/teams/{team_assignment_id}": { "get": { "tags": [ "TeamAssignment" ], "summary": "Update the team assignment with the provided id assigned to the employee corresponding to the provided id.", "operationId": "TeamAssignmentAPI.byEmployeeIdAndAssignmentId", "parameters": [ { "name": "employee_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "team_assignment_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamAssignment" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/team_assignments/{team_assignment_id}" ] }, "put": { "tags": [ "TeamAssignment" ], "summary": "Update the team assignment with the provided id assigned to the employee corresponding to the provided id.", "operationId": "TeamAssignmentAPI.updateForEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "team_assignment_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamAssignment" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamAssignment" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/team_assignments/{team_assignment_id}" ] }, "delete": { "tags": [ "TeamAssignment" ], "summary": "Remove the team assignment with the provided id assigned to the employee corresponding to the provided id.", "operationId": "TeamAssignmentAPI.removeForEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "team_assignment_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No response was specified" } }, "x-replacement-for": [ "/t/employees/{employee_id}/team_assignments/{team_assignment_id}" ] } }, "/v0/administration/employees/{employee_id}/weeksheet_profile": { "get": { "tags": [ "WeeksheetProfile" ], "summary": "Return the weeksheet profile of a employee corresponding to the given employee id.", "operationId": "WeeksheetProfileAPI.byEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WeeksheetProfile" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/weeksheet_profile" ] }, "delete": { "tags": [ "WeeksheetProfile" ], "summary": "Delete the weeksheet profile of a employee corresponding to the given employee id.", "operationId": "WeeksheetProfileAPI.deleteByEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No content" }, "404": { "description": "Employee not found" } }, "x-replacement-for": [ "/t/employees/{employee_id}/weeksheet_profile" ] } }, "/v0/administration/employees/{employee_id}/weeksheet_profile/{weeksheet_profile_id}": { "put": { "tags": [ "WeeksheetProfile" ], "summary": "Update the weeksheet profile of an employee corresponding to the given employee id and weeksheet profile id", "operationId": "WeeksheetProfileAPI.updateByEmployeeIdAndWeeksheetProfileId", "parameters": [ { "name": "employee_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "weeksheet_profile_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WeeksheetProfile" } } } }, "404": { "description": "Employee or weeksheet profile not found" } }, "x-replacement-for": [ "/t/employees/{employee_id}/weeksheet_profile/{weeksheet_profile_id}" ] } }, "/v0/administration/employees/{employee_id}/weeksheet_profile/direct_profile_activity_assignments": { "get": { "tags": [ "ProfileActivityAssignment" ], "summary": "Return the direct profile activity assignments of an Employee corresponding to the given id.", "operationId": "ProfileActivityAssignmentAPI.directAssignmentsByEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ProfileActivityAssignmentList" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/weeksheet_profile/direct_profile_activity_assignments" ] } }, "/v0/administration/employees/{employee_id}/weeksheet_profile/indirect_duration_profile_activity_assignments": { "get": { "tags": [ "ProfileActivityAssignment" ], "summary": "Return the indirect duration profile activity assignments of an Employee corresponding to the given id.", "operationId": "ProfileActivityAssignmentAPI.indirectDurationAssignmentsByEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ProfileActivityAssignmentList" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/weeksheet_profile/indirect_duration_profile_activity_assignments" ] } }, "/v0/administration/employees/{employee_id}/weeksheet_profile/indirect_profile_activity_assignments": { "get": { "tags": [ "ProfileActivityAssignment" ], "summary": "Return the indirect profile activity assignments of an Employee corresponding to the given id.", "operationId": "ProfileActivityAssignmentAPI.indirectAssignmentsByEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ProfileActivityAssignmentList" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/weeksheet_profile/indirect_profile_activity_assignments" ] } }, "/v0/administration/employees/{employee_object_id}/workday_norms": { "get": { "tags": [ "ons_administration.WorkdayNormSettingsModel" ], "summary": "Returns all workday norms settings for the given employee. Does NOT include any default settings.", "operationId": "ons_administration.WorkdayNormSettingsModelAPI.getForEmployee", "parameters": [ { "name": "employee_object_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ons_administration.list.WorkdayNormSettingsModelList" } } } }, "404": { "description": "Employee not found" } }, "x-replacement-for": [ "/t/employees/{employee_object_id}/workday_norms" ] }, "post": { "tags": [ "ons_administration.WorkdayNormSettingsModel" ], "summary": "Creates a new workday norm settings for the given employee.", "operationId": "ons_administration.WorkdayNormSettingsModelAPI.createWorkdayNorm", "parameters": [ { "name": "employee_object_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ons_administration.WorkdayNormSettingsModel" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ons_administration.WorkdayNormSettingsModel" } } } }, "400": { "description": "Validation errors" }, "404": { "description": "Employee not found" } }, "x-replacement-for": [ "/t/employees/{employee_object_id}/workday_norms" ] } }, "/v0/administration/employees/{employee_object_id}/workday_norms/{settings_object_id}": { "get": { "tags": [ "ons_administration.WorkdayNormSettingsModel" ], "summary": "Returns the specified workday norm settings for the given employee.", "operationId": "ons_administration.WorkdayNormSettingsModelAPI.getWorkdayNorm", "parameters": [ { "name": "employee_object_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "settings_object_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ons_administration.WorkdayNormSettingsModel" } } } }, "404": { "description": "Employee or settings not found" } }, "x-replacement-for": [ "/t/employees/{employee_object_id}/workday_norms/{settings_object_id}" ] }, "put": { "tags": [ "ons_administration.WorkdayNormSettingsModel" ], "summary": "Updates the specified workday norm settings for the given employee.", "operationId": "ons_administration.WorkdayNormSettingsModelAPI.updateWorkdayNorm", "parameters": [ { "name": "employee_object_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "settings_object_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ons_administration.WorkdayNormSettingsModel" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ons_administration.WorkdayNormSettingsModel" } } } }, "400": { "description": "Validation errors" }, "404": { "description": "Employee or settings not found" } }, "x-replacement-for": [ "/t/employees/{employee_object_id}/workday_norms/{settings_object_id}" ] }, "delete": { "tags": [ "ons_administration.WorkdayNormSettingsModel" ], "summary": "Deletes the specified workday norm settings for the given employee.", "operationId": "ons_administration.WorkdayNormSettingsModelAPI.deleteWorkdayNorm", "parameters": [ { "name": "employee_object_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "settings_object_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "Success" }, "400": { "description": "Validation errors" }, "404": { "description": "Employee or settings not found" } }, "x-replacement-for": [ "/t/employees/{employee_object_id}/workday_norms/{settings_object_id}" ] } }, "/v0/administration/employees/by_email": { "get": { "tags": [ "Employee" ], "summary": "Return the employees with the given emailaddress.", "description": "Note that passing an empty email query parameter is technically possible, but will result in finding all employees that have no email address assigned", "operationId": "EmployeeAPI.byEmail", "parameters": [ { "name": "email", "in": "query", "description": "emailaddress", "schema": { "type": "string" } }, { "name": "include_home_email", "in": "query", "description": "if `true` also Employees with the given home emailaddress are included in the result. When omitted, the value is set to `false`", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.EmployeeList" } } } } }, "x-replacement-for": [ "/t/employees/by_email" ] } }, "/v0/administration/employees/by_identification_no/{identification_no}": { "get": { "tags": [ "Employee" ], "summary": "Return the Employee corresponding to the given identification number.", "operationId": "EmployeeAPI.byIdentificationNo", "parameters": [ { "name": "identification_no", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" } } } } }, "x-replacement-for": [ "/t/employees/by_identification_no/{identification_no}" ] } }, "/v0/administration/employees/by_uuid/{uuid}": { "get": { "tags": [ "Employee" ], "summary": "Return the Employee corresponding to the given uuid.", "operationId": "EmployeeAPI.byUuid", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" } } } }, "404": { "description": "Employee not found" } }, "x-replacement-for": [ "/t/employees/by_uuid/{uuid}" ] } }, "/v0/administration/employees/extended/snapshot": { "put": { "tags": [ "ons_administration.ExtendedEmployeeModel" ], "summary": "Create or update an employee snapshot", "description": "Create or update the provided employee. This endpoint expects the complete and current state for the provided employee.\n\n**Notes**\n- The model should contain all relevant data for the employee for the current state. Any missing records compared to the known state will be considered as deleted.\n- Expired state can be omitted if it has a known end date (within the Ons system) in the past.\n - E.g. today is 2026-09-01. Contracts with an end date before today will be considered expired. These do not need to be provided again and the absence of this object will NOT be processed as deleted.\n- New state for time dependent objects that are not allowed to overlap will automatically end previous state with the end date set to the start date of the new state minus 1 day.\n - E.g. today is 2026-09-01. If a new contract starts on 2026-10-01, the end date of the preceding contract will be updated to 2026-09-30 if it currently has no end date.\n", "operationId": "ons_administration.ExtendedEmployeeModelAPI.updateEmployeeSnapshot", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ons_administration.ExtendedEmployeeModel" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ons_administration.ExtendedEmployeeModel" } } } }, "400": { "description": "Validation errors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemResponse" } } } } }, "x-replacement-for": [ "/t/employees/extended/snapshot" ] } }, "/v0/administration/employees/find": { "get": { "tags": [ "Employee" ], "summary": "Search for employees", "operationId": "EmployeeAPI.search", "parameters": [ { "name": "query", "in": "query", "description": "query", "schema": { "type": "string" } }, { "name": "employee", "in": "query", "description": "the employee for which the search action is done", "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "limit the amount of results by", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "offset", "in": "query", "description": "start at the given offset", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "out_of_duty", "in": "query", "description": "including employees out of duty", "schema": { "type": "boolean" } }, { "name": "exclude_first_name", "in": "query", "description": "exclude first name in the search", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.EmployeeList" } } } } }, "x-replacement-for": [ "/t/employees/search" ] } }, "/v0/administration/employees/multiple": { "get": { "tags": [ "Employee" ], "summary": "Method used for requesting multiple Employee objects using\n their ids.", "description": "Method used for requesting multiple Employee objects using\ntheir ids.", "operationId": "EmployeeAPI.multiple", "parameters": [ { "name": "id", "in": "query", "description": "array style id's: id=1&id=2&etc", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.EmployeeList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/employees/multiple" ] } }, "/v0/administration/employees/search_by_team": { "get": { "tags": [ "Employee" ], "summary": "Return the Employees who are a member of team corresponding to the given id.", "operationId": "EmployeeAPI.searchByTeamId", "parameters": [ { "name": "team_id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-original-parameter": { "name": "id", "in": "path" } }, { "name": "offset", "in": "query", "description": "number of results to skip", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "limit", "in": "query", "description": "number of results for one call", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "valid_from", "in": "query", "description": "starting time", "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "description": "end time", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.EmployeeList" } } } } }, "x-replacement-for": [ "/t/employees/search_by/teams/{id}" ] } }, "/v0/administration/employees/time_compensation_factors": { "get": { "tags": [ "ons_administration.TimeCompensationFactorModel" ], "summary": "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 be chosen as time compensation enabled or not. Returns a factor 0.0 when no hourly wage is found and time compensation is enabled, or when time compensation is NOT enabled (compensation in money). The particular cases are indicated by the status field of the return objects.", "operationId": "ons_administration.TimeCompensationFactorModelAPI.forEmployeesInPeriod", "parameters": [ { "name": "id", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "period_start", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "period_end", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ons_administration.list.TimeCompensationFactorModelList" } } } }, "400": { "description": "Validation errors" }, "404": { "description": "One or more employees not found" } }, "x-replacement-for": [ "/t/employees/time_compensation_factors" ] } }, "/v0/administration/employees/workday_norms": { "get": { "tags": [ "ons_administration.WorkdayNormSettingsModel" ], "summary": "Returns the current and future workday norms settings for the given employees. This MAY include default settings when no specific settings exist.", "operationId": "ons_administration.WorkdayNormSettingsModelAPI.getCurrentAndFutureForEmployees", "parameters": [ { "name": "id", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ons_administration.list.WorkdayNormSettingsModelList" } } } }, "400": { "description": "Validation errors" }, "404": { "description": "One or more employees not found" } }, "x-replacement-for": [ "/t/employees/workday_norms" ] } }, "/v0/administration/employees/workday_norms/current": { "get": { "tags": [ "ons_administration.WorkdayNormPeriodModel" ], "summary": "Returns the workday norm periods for the given employees. Includes the default norm agreement.", "operationId": "ons_administration.WorkdayNormPeriodModelAPI.getCurrentPeriodsByEmployee", "parameters": [ { "name": "id", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ons_administration.list.WorkdayNormPeriodModelList" } } } }, "400": { "description": "Validation errors" } }, "x-replacement-for": [ "/t/employees/workday_norms/current" ] } }, "/v0/administration/employees/workday_norms/from": { "get": { "tags": [ "ons_administration.WorkdayNormSettingsModel" ], "summary": "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.", "operationId": "ons_administration.WorkdayNormSettingsModelAPI.getForEmployeesFrom", "parameters": [ { "name": "id", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ons_administration.list.WorkdayNormSettingsModelList" } } } }, "400": { "description": "Validation errors" }, "404": { "description": "One or more employees not found" } }, "x-replacement-for": [ "/t/employees/workday_norms/from" ] } }, "/v0/administration/employees/workday_norms/workdays": { "get": { "tags": [ "ons_administration.EmployeeWorkdaysOverviewModel" ], "summary": "Returns the workdays for the given employees according to the workday norm clause count.", "operationId": "ons_administration.EmployeeWorkdaysOverviewModelAPI.getWorkdaysForEmployees", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "valid_from", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ons_administration.list.EmployeeWorkdaysOverviewModelList" } } } }, "400": { "description": "Validation errors" }, "404": { "description": "One or more employees not found" } }, "x-replacement-for": [ "/t/employees/workday_norms/workdays" ] } }, "/v0/administration/evs/response_message": { "put": { "tags": [ "evs.ResponseMessage" ], "summary": "Send a response of an earlier sent message from FVC back to OA", "operationId": "evs.ResponseMessageAPI.send", "requestBody": { "description": "Responsemessage to be sent to OA", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/evs.ResponseMessage" } } }, "required": true }, "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/evs.ResponseMessage" } } } } }, "x-replacement-for": [ "/t/evs/response_message" ] } }, "/v0/administration/evsabilities/{action}": { "get": { "tags": [ "evs.EvsAbility" ], "operationId": "evs.EvsAbilityAPI.ableTo", "parameters": [ { "name": "action", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "employee_id", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/evs.EvsAbility" } } } } }, "x-replacement-for": [ "/t/evs/evs_abilities/{action}" ] } }, "/v0/administration/expense_types": { "get": { "tags": [ "expense.ExpenseType" ], "summary": "Returns every ExpenseType available from the ExpenseTypeAPI", "operationId": "expense.ExpenseTypeAPI.all", "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expense.list.ExpenseTypeList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/expense/expense_types" ] } }, "/v0/administration/expense_types/{id}": { "get": { "tags": [ "expense.ExpenseType" ], "summary": "Return the Expense Type corresponding to the given id", "operationId": "expense.ExpenseTypeAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting ExpenseType", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expense.ExpenseType" } } } }, "404": { "description": "Expense type not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/expense/expense_types/{id}" ] } }, "/v0/administration/expenses": { "post": { "tags": [ "expense.Expense" ], "summary": "Create Expense", "operationId": "expense.ExpenseAPI.create", "parameters": [ { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "Expense to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expense.Expense" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expense.Expense" } } } }, "400": { "description": "Validation errors, or expense already exists" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/expense/expenses" ] } }, "/v0/administration/expenses/{id}": { "get": { "tags": [ "expense.Expense" ], "summary": "Return the Expense corresponding to the given id", "operationId": "expense.ExpenseAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Expense", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expense.Expense" } } } }, "400": { "description": "Missing ID" }, "404": { "description": "Expense not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/expense/expenses/{id}" ] }, "put": { "tags": [ "expense.Expense" ], "summary": "Updates the given Expense", "operationId": "expense.ExpenseAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Expense", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "Expense to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expense.Expense" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expense.Expense" } } } }, "400": { "description": "Missing ID, or validation errors" }, "404": { "description": "Expense not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/expense/expenses/{id}" ] }, "delete": { "tags": [ "expense.Expense" ], "summary": "Deletes the Expense with given id", "operationId": "expense.ExpenseAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Expense", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expense.Expense" } } } }, "400": { "description": "Missing ID" }, "404": { "description": "Expense not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/expense/expenses/{id}" ] } }, "/v0/administration/expenses/employees/{employee_id}": { "get": { "tags": [ "expense.Expense" ], "summary": "Retrieve all expenses for the employee corresponding to the given employee id.", "description": "At least one of the valid_to and valid_from query parameters need to be set. When neither are provided, they will both default to \"today\". Since valid_to is non-inclusive, this leads to an empty response", "operationId": "expense.ExpenseAPI.searchByEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "description": "The id of the employee to search expenses for", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "valid_from", "in": "query", "description": "starting time", "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "description": "end time", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expense.list.ExpenseList" } } } } }, "x-replacement-for": [ "/t/expense/expenses/search_by/employees/{employee_id}" ] } }, "/v0/administration/expenses/expensedistance/{expense_distance_id}": { "put": { "tags": [ "expense.Expense" ], "summary": "Updates an expense distance position with a new position value", "operationId": "expense.ExpenseAPI.updatePositionForExpenseDistance", "parameters": [ { "name": "expense_distance_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/registration.Position" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expense.Expense" } } } } }, "x-replacement-for": [ "/t/expense/expenses/expensedistance/{expense_distance_id}" ] } }, "/v0/administration/expenses/preview": { "post": { "tags": [ "expense.Expense" ], "summary": "Used to get created Expense Route Without saving the expense ", "operationId": "expense.ExpenseAPI.previewExpense", "parameters": [ { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expense.Expense" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expense.Expense" } } } }, "400": { "description": "Validation errors, or expense already exists" } }, "x-replacement-for": [ "/t/expense/expenses/preview" ] } }, "/v0/administration/expertise_groups": { "get": { "tags": [ "ExpertiseGroup" ], "summary": "Returns every ExpertiseGroup available from the ExpertiseGroupAPI", "operationId": "ExpertiseGroupAPI.all", "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ExpertiseGroupList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/expertise_groups" ] } }, "/v0/administration/expertise_groups/{id}": { "get": { "tags": [ "ExpertiseGroup" ], "summary": "Returns the ExpertiseGroup corresponding to the given id", "operationId": "ExpertiseGroupAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting ExpertiseGroup", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpertiseGroup" } } } }, "404": { "description": "Expertise group not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/expertise_groups/{id}" ] } }, "/v0/administration/expertise_groups/multiple": { "get": { "tags": [ "ExpertiseGroup" ], "summary": "Method used for requesting multiple ExpertiseGroup objects using\ntheir ids.", "operationId": "ExpertiseGroupAPI.multiple", "parameters": [ { "name": "id", "in": "query", "description": "array style id's: id=1&id=2&etc", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ExpertiseGroupList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/expertise_groups/multiple" ] } }, "/v0/administration/expertise_profile_assignments": { "post": { "tags": [ "ExpertiseProfileAssignment" ], "summary": "Create new expertise profile assignment for the Employee corresponding to the given employee_id.", "operationId": "ExpertiseProfileAssignmentAPI.assignExpertiseProfileToEmployee", "parameters": [ { "name": "employee_id", "in": "query", "description": "employee id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpertiseProfileAssignmentUpdateModel" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpertiseProfileAssignment" } } } }, "400": { "description": "Begin date is invalid, there is already an assignment starting at this date for this employee." }, "404": { "description": "Employee or expertise profile not found" } }, "x-replacement-for": [ "/t/expertise_profile_assignments" ] } }, "/v0/administration/expertise_profile_assignments/{id}": { "get": { "tags": [ "ExpertiseProfileAssignment" ], "summary": "Return the expertise profile assignment corresponding to the given id.", "operationId": "ExpertiseProfileAssignmentAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting ExpertiseProfileAssignment", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpertiseProfileAssignment" } } } }, "404": { "description": "Expertise profile assignment not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/expertise_profile_assignments/{id}" ] }, "put": { "tags": [ "ExpertiseProfileAssignment" ], "summary": "Update the expertise profile assignment corresponding to the given id.", "operationId": "ExpertiseProfileAssignmentAPI.updateById", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting ExpertiseProfileAssignment", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpertiseProfileAssignmentUpdateModel" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpertiseProfileAssignment" } } } }, "404": { "description": "Expertise profile assignment or new expertise profile not found" } }, "x-replacement-for": [ "/t/expertise_profile_assignments/{id}" ] }, "delete": { "tags": [ "ExpertiseProfileAssignment" ], "summary": "Deletes the expertise profile assignment corresponding to the given id.", "operationId": "ExpertiseProfileAssignmentAPI.deleteById", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting ExpertiseProfileAssignment", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "Success" }, "404": { "description": "Expertise profile assignment not found" } }, "x-replacement-for": [ "/t/expertise_profile_assignments/{id}" ] } }, "/v0/administration/expertise_profile_assignments/by_employee_ids": { "get": { "tags": [ "ExpertiseProfileAssignment" ], "summary": "Return all the expertise profile assignments for a list of employees.", "operationId": "ExpertiseProfileAssignmentAPI.byEmployeeIds", "parameters": [ { "name": "begin_date", "in": "query", "description": "the begin date, used as a filter to return only expertise profile assignments for the specified period", "schema": { "type": "string", "format": "date" } }, { "name": "end_date", "in": "query", "description": "the end date, used as a filter to return only expertise profile assignments for the specified period", "schema": { "type": "string", "format": "date" } }, { "name": "id", "in": "query", "description": "array style id's: id=1&id=2&etc, contains a list of employee object ids", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ExpertiseProfileAssignmentList" } } } }, "400": { "description": "Incorrect request. The list of employee object ids must contain between 1 and 100 elements" } }, "x-replacement-for": [ "/t/expertise_profile_assignments/by_employee_ids" ] } }, "/v0/administration/expertise_profile_assignments/multiple": { "get": { "tags": [ "ExpertiseProfileAssignment" ], "summary": "Method used for requesting multiple ExpertiseProfileAssignment objects using\ntheir ids.", "operationId": "ExpertiseProfileAssignmentAPI.multiple", "parameters": [ { "name": "id", "in": "query", "description": "array style id's: id=1&id=2&etc", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ExpertiseProfileAssignmentList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/expertise_profile_assignments/multiple" ] } }, "/v0/administration/expertise_profiles": { "get": { "tags": [ "ExpertiseProfile" ], "summary": "Returns every ExpertiseProfile available from the ExpertiseProfileAPI", "operationId": "ExpertiseProfileAPI.all", "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ExpertiseProfileList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/expertise_profiles" ] } }, "/v0/administration/expertise_profiles/{expertise_profiles_id}/hour_types": { "get": { "tags": [ "HourType" ], "summary": "Return the hour type of a ExpertiseProfiles corresponding to the given id.", "operationId": "HourTypeAPI.byExpertiseProfileId", "parameters": [ { "name": "expertise_profiles_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.HourTypeList" } } } } }, "x-replacement-for": [ "/t/expertise_profiles/{expertise_profiles_id}/hour_types" ] } }, "/v0/administration/expertise_profiles/{id}": { "get": { "tags": [ "ExpertiseProfile" ], "summary": "Return the Expertise Profile corresponding to the given id", "operationId": "ExpertiseProfileAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting ExpertiseProfile", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpertiseProfile" } } } }, "404": { "description": "Expertise profile not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/expertise_profiles/{id}" ] } }, "/v0/administration/expertise_profiles/multiple": { "get": { "tags": [ "ExpertiseProfile" ], "summary": "Method used for requesting multiple ExpertiseProfile objects using\ntheir ids.", "operationId": "ExpertiseProfileAPI.multiple", "parameters": [ { "name": "id", "in": "query", "description": "array style id's: id=1&id=2&etc", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ExpertiseProfileList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/expertise_profiles/multiple" ] } }, "/v0/administration/export/export_presence_logs/collect": { "get": { "tags": [ "export.ExportPresenceLog" ], "summary": "Collects the Export Presence Logs", "operationId": "export.ExportPresenceLogAPI.collect", "parameters": [ { "name": "employee_id", "in": "query", "description": "as long", "schema": { "type": "integer", "format": "int64" } }, { "name": "filter_name", "in": "query", "description": "as string", "required": true, "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "as string, yyyy-MM-dd", "required": true, "schema": { "type": "string" } }, { "name": "compression_type", "in": "query", "description": "as integer", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "verified_only", "in": "query", "description": "as boolean", "required": true, "schema": { "type": "boolean" } }, { "name": "prevent_overlap", "in": "query", "description": "as boolean", "schema": { "type": "boolean" } }, { "name": "use_direct_code", "in": "query", "description": "as boolean", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/export.ExportUuid" } } } }, "400": { "description": "An export is already running, or initialization is not possible" }, "404": { "description": "No status information could be found" } }, "x-replacement-for": [ "/t/export/export_presence_logs/collect" ] } }, "/v0/administration/export/export_presence_logs/result/{uuid}": { "get": { "tags": [ "export.ExportPresenceLog" ], "summary": "Return the results of the Export Presence Log corresponding to the given uuid", "operationId": "export.ExportPresenceLogAPI.resultByUuid", "parameters": [ { "name": "uuid", "in": "path", "description": "as string", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/export.list.ExportPresenceLogList" } } } }, "400": { "description": "UUID is required, or no status could be found" } }, "x-replacement-for": [ "/t/export/export_presence_logs/result/{uuid}" ] } }, "/v0/administration/export/export_presence_logs/status/{uuid}": { "get": { "tags": [ "export.ExportPresenceLog" ], "summary": "Return the status of the Export Presence Log corresponding to the given uuid", "operationId": "export.ExportPresenceLogAPI.statusByUuid", "parameters": [ { "name": "uuid", "in": "path", "description": "as string", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/export.ExportStatus" } } } }, "400": { "description": "UUID is required, or no status could be found" } }, "x-replacement-for": [ "/t/export/export_presence_logs/status/{uuid}" ] } }, "/v0/administration/finance/activity_suggestions": { "get": { "tags": [ "finance.GroupActivitySuggestionModel" ], "summary": "Get all group activities", "operationId": "finance.GroupActivitySuggestionModelAPI.getAllGroupActivities", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.list.GroupActivityModelList" } } } } }, "x-replacement-for": [ "/t/finance/activity_suggestions" ] } }, "/v0/administration/finance/activity_suggestions/{group_activity_object_id}": { "get": { "tags": [ "finance.GroupActivitySuggestionModel" ], "summary": "Get activities for a group activity and clients at a given date", "operationId": "finance.GroupActivitySuggestionModelAPI.activityByClientAndGroupActivity", "parameters": [ { "name": "group_activity_object_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "client_ids", "in": "query", "description": "Include clientIds", "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "date", "in": "query", "description": "Date of registration", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.list.GroupActivitySuggestionModelList" } } } }, "400": { "description": "Group activity and client are required" }, "404": { "description": "No suggestion found" } }, "x-replacement-for": [ "/t/finance/activity_suggestions/{group_activity_object_id}" ] } }, "/v0/administration/finance/care_order_products": { "post": { "tags": [ "finance.CareOrderProduct" ], "summary": "Create CareOrderProduct", "operationId": "finance.CareOrderProductAPI.create", "requestBody": { "description": "CareOrderProduct to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.CareOrderProduct" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.CareOrderProduct" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/finance/care_order_products" ] } }, "/v0/administration/finance/care_order_products/{id}": { "get": { "tags": [ "finance.CareOrderProduct" ], "summary": "Return the CareOrderProduct corresponding to the given id", "operationId": "finance.CareOrderProductAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting CareOrderProduct", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.CareOrderProduct" } } } }, "404": { "description": "CareOrderProduct does not exist" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/finance/care_order_products/{id}" ] }, "put": { "tags": [ "finance.CareOrderProduct" ], "summary": "Updates the given CareOrderProduct", "operationId": "finance.CareOrderProductAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting CareOrderProduct", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "CareOrderProduct to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.CareOrderProduct" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.CareOrderProduct" } } } }, "404": { "description": "CareOrderProduct does not exist" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/finance/care_order_products/{id}" ] }, "delete": { "tags": [ "finance.CareOrderProduct" ], "summary": "Deletes the CareOrderProduct with given id", "operationId": "finance.CareOrderProductAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting CareOrderProduct", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "If successfully removed the care order product" }, "400": { "description": "ID not specified, or the care product has finance logs" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/finance/care_order_products/{id}" ] } }, "/v0/administration/finance/care_orders": { "post": { "tags": [ "finance.CareOrder" ], "summary": "Create CareOrder", "operationId": "finance.CareOrderAPI.create", "requestBody": { "description": "CareOrder to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.CareOrder" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.CareOrder" } } } }, "400": { "description": "Validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/finance/care_orders" ] } }, "/v0/administration/finance/care_orders/{care_order_id}/care_order_products": { "get": { "tags": [ "finance.CareOrderProduct" ], "summary": "Return the CareOrderProducts of a CareOrder corresponding to the given id.", "operationId": "finance.CareOrderProductAPI.byCareOrderId", "parameters": [ { "name": "care_order_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.list.CareOrderProductList" } } } } }, "x-replacement-for": [ "/t/finance/care_orders/{care_order_id}/care_order_products" ] } }, "/v0/administration/finance/care_orders/{care_order_id}/presence_logs": { "get": { "tags": [ "PresenceLog" ], "summary": "Return the PresenceLogs of a CareOrder corresponding to the given id.", "operationId": "PresenceLogAPI.byCareOrderId", "parameters": [ { "name": "care_order_id", "in": "path", "description": "Long identifying the CareOrder to search for", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "Integer used to limit the result size", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "description": "Integer used to indicate the index of the page of results (ie. first result is on row = page * limit)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.PresenceLogList" } } } } }, "x-replacement-for": [ "/t/care_orders/{care_order_id}/presence_logs", "/t/care_orders/{care_order_id}/presence_logs_paged" ] } }, "/v0/administration/finance/care_orders/{id}": { "get": { "tags": [ "finance.CareOrder" ], "summary": "Return the CareOrder corresponding to the given id", "operationId": "finance.CareOrderAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting CareOrder", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.CareOrder" } } } }, "404": { "description": "CareOrder does not exist" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/finance/care_orders/{id}" ] }, "put": { "tags": [ "finance.CareOrder" ], "summary": "Updates the given CareOrder", "operationId": "finance.CareOrderAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting CareOrder", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "CareOrder to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.CareOrder" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.CareOrder" } } } }, "400": { "description": "ID of model does not match path" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/finance/care_orders/{id}" ] }, "delete": { "tags": [ "finance.CareOrder" ], "summary": "Deletes the CareOrder with given id", "operationId": "finance.CareOrderAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting CareOrder", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "If successfully removed the care order" }, "400": { "description": "Missing ID, or Careorder is assigned to a client, or the care order has care order products assigned" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/finance/care_orders/{id}" ] } }, "/v0/administration/finance/care_orders/by_client_and_finance_type/{client_object_id}": { "get": { "tags": [ "finance.CareOrder" ], "summary": "If you are looking for 'zorglegitimaties', then you can use the CareOrder API.", "operationId": "finance.CareOrderAPI.byClientAndFinanceType", "parameters": [ { "name": "client_object_id", "in": "path", "description": "ID of the client", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "financetypeObjectId", "in": "query", "description": "ID of the finance type", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.list.CareOrderList" } } } } }, "x-replacement-for": [ "/t/finance/care_orders/by_client_and_finance_type/{client_object_id}" ] } }, "/v0/administration/finance/care_orders/by_client/{client_id}": { "get": { "tags": [ "finance.CareOrder" ], "summary": "If you are looking for 'zorglegitimaties', then you can use the CareOrder API.", "operationId": "finance.CareOrderAPI.byClient", "parameters": [ { "name": "client_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.list.CareOrderList" } } } } }, "x-replacement-for": [ "/t/finance/care_orders/by_client/{client_id}" ] } }, "/v0/administration/finance/care_orders/by_identification_no/{identification_no}": { "get": { "tags": [ "finance.CareOrder" ], "summary": "Finds a CareOrder by its identification number ('legitimatienummer').", "description": "In the returned model the identification number is named \"userIdentifier\".", "operationId": "finance.CareOrderAPI.byIdentificationNo", "parameters": [ { "name": "identification_no", "in": "path", "description": "The identification number (Dutch: legitimatienummer) of the care order to find.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.CareOrder" } } } } }, "x-replacement-for": [ "/t/finance/care_orders/by_identification_no/{identification_no}" ] } }, "/v0/administration/finance/client_financed_products/by_location_and_finance_type_in_period": { "get": { "tags": [ "finance.ClientFinancedProduct" ], "summary": "Retrieve the legally financeable products for all clients on a certain locations for\na certain finance type.", "operationId": "finance.ClientFinancedProductAPI.byLocationAndFinanceTypeInPeriod", "parameters": [ { "name": "unit_id", "in": "query", "description": "the id of the location we want a list of", "schema": { "type": "integer", "format": "int64" } }, { "name": "finance_id", "in": "query", "description": "the financetype we're interested in", "schema": { "type": "integer", "format": "int64" } }, { "name": "start_period", "in": "query", "description": "the start of the period", "schema": { "type": "string", "format": "date" } }, { "name": "end_period", "in": "query", "description": "the end of the period", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.list.ClientFinancedProductList" } } } }, "400": { "description": "The unit, finance type, start date and end date are required, and the end date cannot be after the begin date" } }, "x-replacement-for": [ "/t/finance/client_financed_products/by_location_and_finance_type_in_period" ] } }, "/v0/administration/finance/client_financed_products/by_location_and_finance_types_in_period": { "get": { "tags": [ "finance.ClientFinancedProduct" ], "summary": "Retrieve the legally financeable products for all clients on a certain locations for\na certain finance type.", "operationId": "finance.ClientFinancedProductAPI.byLocationAndFinanceTypesInPeriod", "parameters": [ { "name": "unit_id", "in": "query", "description": "the id of the location we want a list of", "schema": { "type": "integer", "format": "int64" } }, { "name": "finance_ids", "in": "query", "description": "a list of the financetypes we're interested in", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "start_period", "in": "query", "description": "the start of the period", "schema": { "type": "string", "format": "date" } }, { "name": "end_period", "in": "query", "description": "the end of the period", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.list.ClientFinancedProductList" } } } }, "400": { "description": "The unit, finance types, start date and end date are required, and the end date cannot be after the begin date" } }, "x-replacement-for": [ "/t/finance/client_financed_products/by_location_and_finance_types_in_period" ] } }, "/v0/administration/finance/declaration_rules": { "post": { "tags": [ "finance.DeclarationRule" ], "summary": "Create DeclarationRule", "operationId": "finance.DeclarationRuleAPI.create", "requestBody": { "description": "DeclarationRule to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.DeclarationRule" } } }, "required": true }, "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.DeclarationRule" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/finance/declaration_rules" ] } }, "/v0/administration/finance/declaration_rules/{id}": { "get": { "tags": [ "finance.DeclarationRule" ], "operationId": "finance.DeclarationRuleAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting DeclarationRule", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.DeclarationRule" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/finance/declaration_rules/{id}" ] }, "put": { "tags": [ "finance.DeclarationRule" ], "summary": "Updates the given DeclarationRule", "operationId": "finance.DeclarationRuleAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting DeclarationRule", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "DeclarationRule to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.DeclarationRule" } } }, "required": true }, "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.DeclarationRule" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/finance/declaration_rules/{id}" ] }, "delete": { "tags": [ "finance.DeclarationRule" ], "summary": "Deletes the DeclarationRule with given id", "operationId": "finance.DeclarationRuleAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting DeclarationRule", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.DeclarationRule" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/finance/declaration_rules/{id}" ] } }, "/v0/administration/finance/declaration_rules/by_client/{client_id}": { "get": { "tags": [ "finance.DeclarationRule" ], "summary": "Return the Declaration rules belonging to a certain client.", "operationId": "finance.DeclarationRuleAPI.byClient", "parameters": [ { "name": "client_id", "in": "path", "description": "the objectId of the client in question", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "care_order_id", "in": "query", "description": "the objectId of the careorder in question", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.list.DeclarationRuleList" } } } } }, "x-replacement-for": [ "/t/finance/declaration_rules/by_client/{client_id}" ] } }, "/v0/administration/finance/declaration_rules/by_client/{client_id}/is_verified": { "get": { "tags": [ "finance.DeclarationRule" ], "summary": "Returns whether the declaration rules for a given client are (partly) verified within the specified period", "operationId": "finance.DeclarationRuleAPI.isVerifiedInPeriod", "parameters": [ { "name": "client_id", "in": "path", "description": "Long identifying the client", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "from", "in": "query", "description": "LocalDate the start date of the period to check (inclusive)", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "LocalDate the end date of the period to check (inclusive)", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanWithReason" } } } } }, "x-replacement-for": [ "/t/finance/declaration_rules/by_client/{client_id}/is_verified" ] } }, "/v0/administration/finance/declaration_rules/by_client/{client_id}/verified_until": { "get": { "tags": [ "finance.DeclarationRule" ], "operationId": "finance.DeclarationRuleAPI.verifiedUntil", "parameters": [ { "name": "client_id", "in": "path", "description": "Long identifying the client", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DateWrapper" } } } } }, "x-replacement-for": [ "/t/finance/declaration_rules/by_client/{client_id}/verified_until" ] } }, "/v0/administration/finance/finance_types/{finance_type_id}/products": { "get": { "tags": [ "finance.Product" ], "summary": "Return the Products of a FinanceType corresponding to the given id.", "operationId": "finance.ProductAPI.byFinanceTypeId", "parameters": [ { "name": "finance_type_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.list.ProductList" } } } } }, "x-replacement-for": [ "/t/finance/finance_types/{finance_type_id}/products" ] } }, "/v0/administration/finance/finance_types/{id}": { "get": { "tags": [ "finance.FinanceType" ], "summary": "Return the Finance Type corresponding to the given id", "operationId": "finance.FinanceTypeAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting FinanceType", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.FinanceType" } } } }, "404": { "description": "Finance type not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/finance/finance_types/{id}" ] } }, "/v0/administration/finance/forensic_care_orders": { "post": { "tags": [ "finance.ForensicCareOrder" ], "summary": "Create ForensicCareOrder", "operationId": "finance.ForensicCareOrderAPI.create", "parameters": [ { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "ForensicCareOrder to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.ForensicCareOrder" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.ForensicCareOrder" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/finance/forensic_care_orders" ] } }, "/v0/administration/finance/forensic_care_orders/{id}": { "get": { "tags": [ "finance.ForensicCareOrder" ], "summary": "Return the Forensic Care Order corresponding to the given id", "operationId": "finance.ForensicCareOrderAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting ForensicCareOrder", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.ForensicCareOrder" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/finance/forensic_care_orders/{id}" ] }, "put": { "tags": [ "finance.ForensicCareOrder" ], "summary": "Updates the given ForensicCareOrder", "description": "Will create the object at the provided ID if it did not exist previously.", "operationId": "finance.ForensicCareOrderAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting ForensicCareOrder", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "ForensicCareOrder to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.ForensicCareOrder" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.ForensicCareOrder" } } } }, "400": { "description": "The ID in the path does not match the request body" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/finance/forensic_care_orders/{id}" ] }, "delete": { "tags": [ "finance.ForensicCareOrder" ], "summary": "Deletes the ForensicCareOrder with given id", "description": "Deleting a ForensicCareOrder may fail if other objects are still linked to it.", "operationId": "finance.ForensicCareOrderAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting ForensicCareOrder", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.ForensicCareOrder" } } } }, "204": { "description": "Success" }, "400": { "description": "The ID is not specified" }, "404": { "description": "The forensic care order does not exist" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/finance/forensic_care_orders/{id}" ] } }, "/v0/administration/finance/invoiceProviderGroups": { "get": { "tags": [ "finance.InvoiceProviderGroup" ], "summary": "Returns every InvoiceProviderGroup available from the InvoiceProviderGroupAPI", "operationId": "finance.InvoiceProviderGroupAPI.all", "parameters": [ { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.list.InvoiceProviderGroupList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/finance/invoice_provider_groups" ] } }, "/v0/administration/finance/parallel_care_orders/by_employee_and_client_at_date/{employee_object_id}": { "get": { "tags": [ "finance.ParallelCareOrder" ], "operationId": "finance.ParallelCareOrderAPI.byEmployeeAndClientAtDate", "parameters": [ { "name": "employee_object_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "client_id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "source_type", "in": "query", "description": "Is used to determine filtering. Valid values are: 1 (iO Smart), 2 (TouchPro), 3 (Manual), 4 (Timesheet), 5 (A priori), 6 (Planning), 7 (iO Me), 8 (Group care (old)), 9 (Schedule), 10 (Import without overlap), 11 (Import with overlap), 12 (Ons Agenda), 13 (Group care (new)), 14 (Ysis), 15 (Ons DBC) and 16 (Ons Vandaag). Filtering is only performed when values for Ons Agenda, Io Me or Ons Vandaag are provided.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.list.ParallelCareOrderList" } } } } }, "x-replacement-for": [ "/t/finance/parallel_care_orders/by_employee_and_client_at_date/{employee_object_id}" ] } }, "/v0/administration/finance/products/{id}": { "get": { "tags": [ "finance.Product" ], "summary": "Return the Product corresponding to the given id", "operationId": "finance.ProductAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Product", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.Product" } } } }, "404": { "description": "Product not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/finance/products/{id}" ] } }, "/v0/administration/holidays": { "get": { "tags": [ "payroll.holiday.Holiday" ], "summary": "Returns every Holiday available from the HolidayAPI", "operationId": "payroll.holiday.HolidayAPI.all", "parameters": [ { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.holiday.list.HolidayList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/payroll/holiday/holidays" ] } }, "/v0/administration/holidays/between": { "get": { "tags": [ "payroll.holiday.Holiday" ], "summary": "Returns a list with holidays which lay between the given days.", "operationId": "payroll.holiday.HolidayAPI.between", "parameters": [ { "name": "valid_from", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.holiday.list.HolidayList" } } } }, "400": { "description": "The end date must not be before the begin date and the end date cannot be after today." } }, "x-replacement-for": [ "/t/payroll/holiday/holidays/between" ] } }, "/v0/administration/hour_type_categories": { "get": { "tags": [ "HourTypeCategory" ], "summary": "Returns every HourTypeCategory available from the HourTypeCategoryAPI", "operationId": "HourTypeCategoryAPI.all", "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.HourTypeCategoryList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/hour_type_categories" ] } }, "/v0/administration/hour_type_categories/{id}": { "get": { "tags": [ "HourTypeCategory" ], "summary": "Get the Hour Type Category corresponding to the given id", "operationId": "HourTypeCategoryAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting HourTypeCategory", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HourTypeCategory" } } } }, "404": { "description": "Hour type category not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/hour_type_categories/{id}" ] } }, "/v0/administration/hour_type_categories/by_name/{name}": { "get": { "tags": [ "HourTypeCategory" ], "summary": "Return the hour type category corresponding to the given name.", "operationId": "HourTypeCategoryAPI.byName", "parameters": [ { "name": "name", "in": "path", "description": "name of the hour type category", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HourTypeCategory" } } } }, "404": { "description": "Hour type category not found" } }, "x-replacement-for": [ "/t/hour_type_categories/by_name/{name}" ] } }, "/v0/administration/hour_type_product_assignments": { "get": { "tags": [ "HourTypeProductAssignment" ], "summary": "Returns every HourTypeProductAssignment available", "operationId": "HourTypeProductAssignmentAPI.all", "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.HourTypeProductAssignmentList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/hour_type_product_assignments" ] } }, "/v0/administration/hour_type_product_assignments/{id}": { "get": { "tags": [ "HourTypeProductAssignment" ], "summary": "Returns the HourTypeProductAssignment with the provided id", "operationId": "HourTypeProductAssignmentAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting HourTypeProductAssignment", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HourTypeProductAssignment" } } } }, "404": { "description": "HourTypeProductAssignment not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/hour_type_product_assignments/{id}" ] } }, "/v0/administration/hour_types": { "get": { "tags": [ "HourType" ], "summary": "Returns every HourType available from the HourTypeAPI", "operationId": "HourTypeAPI.all", "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.HourTypeList" } } } }, "404": { "description": "Hour type category not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/hour_types" ] } }, "/v0/administration/hour_types/{id}": { "get": { "tags": [ "HourType" ], "summary": "Get the Hour Type corresponding to the given id", "operationId": "HourTypeAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting HourType", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HourType" } } } }, "404": { "description": "Hour type not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/hour_types/{id}" ] } }, "/v0/administration/hour_types/{id}/product_assignments": { "get": { "tags": [ "HourTypeProductAssignment" ], "summary": "Returns the HourTypeProductAssignments assigned to the HourType with the provided id", "operationId": "HourTypeProductAssignmentAPI.byHourTypeId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting HourType for which to get the assignments", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.HourTypeProductAssignmentList" } } } }, "404": { "description": "Hour type not found" } }, "x-replacement-for": [ "/t/hour_types/{id}/product_assignments" ] } }, "/v0/administration/hour_types/multiple": { "get": { "tags": [ "HourType" ], "summary": "Method used for requesting multiple HourType objects using\ntheir ids.", "operationId": "HourTypeAPI.multiple", "parameters": [ { "name": "id", "in": "query", "description": "array style id's: id=1&id=2&etc", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.HourTypeList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/hour_types/multiple" ] } }, "/v0/administration/hour_types/workdays": { "get": { "tags": [ "ons_administration.WorkdayHourTypeModel" ], "summary": "Returns all workday hour types (activities) with their validity periods. During these periods, the corresponding hour type\nis counted as a workday. If the hour type is not present in this list, it is never counted as a workday.\n", "operationId": "ons_administration.WorkdayHourTypeModelAPI.getWorkdayHourTypes", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ons_administration.list.WorkdayHourTypeModelList" } } } }, "500": { "description": "Internal server error" } }, "x-replacement-for": [ "/t/hour_types/workdays" ] } }, "/v0/administration/hourly_wages/{id}": { "get": { "tags": [ "payroll.HourlyWage" ], "summary": "Return the Hourly Wage corresponding to the given id", "operationId": "payroll.HourlyWageAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting HourlyWage", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.HourlyWage" } } } }, "404": { "description": "The hourly wage could not be found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/payroll/hourly_wages/{id}" ] } }, "/v0/administration/hourly_wages/by_employee/{employee_object_id}": { "get": { "tags": [ "payroll.HourlyWage" ], "summary": "Retrieves all the hourly wages of the employee.", "operationId": "payroll.HourlyWageAPI.byEmployee", "parameters": [ { "name": "employee_object_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.list.HourlyWageList" } } } } }, "x-replacement-for": [ "/t/payroll/hourly_wages/by_employee/{employee_object_id}" ] } }, "/v0/administration/insurances": { "post": { "tags": [ "Insurance" ], "summary": "Create an Insurance for a Client.", "operationId": "InsuranceAPI.create", "requestBody": { "description": "the Insurance to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Insurance" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Insurance" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/insurances" ] } }, "/v0/administration/insurances/{id}": { "get": { "tags": [ "Insurance" ], "summary": "Return the Insurance corresponding to the given id", "operationId": "InsuranceAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Insurance", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Insurance" } } } }, "404": { "description": "Insurance not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/insurances/{id}" ] } }, "/v0/administration/jw/zorglegitimaties": { "post": { "tags": [ "jw.JwZorglegitimatie" ], "summary": "Create JwZorglegitimatie", "operationId": "jw.JwZorglegitimatieAPI.create", "requestBody": { "description": "JwZorglegitimatie to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/jw.JwZorglegitimatie" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/jw.JwZorglegitimatie" } } } }, "400": { "description": "Validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/jw/zorglegitimaties" ] } }, "/v0/administration/jw/zorglegitimaties/{id}": { "get": { "tags": [ "jw.JwZorglegitimatie" ], "summary": "Return the JwZorglegitimatie corresponding to the given id", "operationId": "jw.JwZorglegitimatieAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used to find the JwZorglegitimatie", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/jw.JwZorglegitimatie" } } } }, "404": { "description": "Beschikking not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/jw/zorglegitimaties/{id}" ] }, "delete": { "tags": [ "jw.JwZorglegitimatie" ], "summary": "Delete a JwZorglegitimatie", "operationId": "jw.JwZorglegitimatieAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "used to find the JwZorglegitimatie", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/jw.JwZorglegitimatie" } } } }, "400": { "description": "Validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/jw/zorglegitimaties/{id}" ] } }, "/v0/administration/location_assignment_residences": { "post": { "tags": [ "LocationAssignmentResidence" ], "summary": "Create LocationAssignmentResidence", "operationId": "LocationAssignmentResidenceAPI.create", "requestBody": { "description": "LocationAssignmentResidence to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAssignmentResidence" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAssignmentResidence" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/location_assignment_residences" ] } }, "/v0/administration/location_assignment_residences/{id}": { "get": { "tags": [ "LocationAssignmentResidence" ], "summary": "Return the Location Assignment Residence corresponding to the given id", "operationId": "LocationAssignmentResidenceAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting LocationAssignmentResidence", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAssignmentResidence" } } } }, "404": { "description": "Location assignment residence not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/location_assignment_residences/{id}" ] }, "put": { "tags": [ "LocationAssignmentResidence" ], "summary": "Updates the given LocationAssignmentResidence", "operationId": "LocationAssignmentResidenceAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting LocationAssignmentResidence", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "LocationAssignmentResidence to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAssignmentResidence" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAssignmentResidence" } } } }, "404": { "description": "Location assignment residence not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/location_assignment_residences/{id}" ] } }, "/v0/administration/location_assignment_residences/by_careorder/{care_order_object_id}": { "get": { "tags": [ "LocationAssignmentResidence" ], "summary": "Find a list of locationAssignmentResidences based on the careorderobjectid", "operationId": "LocationAssignmentResidenceAPI.byCareOrder", "parameters": [ { "name": "care_order_object_id", "in": "path", "description": "Techincal identifcation of a careorder", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.LocationAssignmentResidenceList" } } } } }, "x-replacement-for": [ "/t/location_assignment_residences/by_careorder/{care_order_object_id}" ] } }, "/v0/administration/location_assignment_waiting_lists": { "post": { "tags": [ "LocationAssignmentWaitingList" ], "summary": "Create LocationAssignmentWaitingList", "operationId": "LocationAssignmentWaitingListAPI.create", "requestBody": { "description": "LocationAssignmentWaitingList to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAssignmentWaitingList" } } }, "required": true }, "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAssignmentWaitingList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/location_assignment_waiting_lists" ] } }, "/v0/administration/location_assignment_waiting_lists/{id}": { "get": { "tags": [ "LocationAssignmentWaitingList" ], "operationId": "LocationAssignmentWaitingListAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting LocationAssignmentWaitingList", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAssignmentWaitingList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/location_assignment_waiting_lists/{id}" ] }, "put": { "tags": [ "LocationAssignmentWaitingList" ], "summary": "Updates the given LocationAssignmentWaitingList", "operationId": "LocationAssignmentWaitingListAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting LocationAssignmentWaitingList", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "LocationAssignmentWaitingList to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAssignmentWaitingList" } } }, "required": true }, "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAssignmentWaitingList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/location_assignment_waiting_lists/{id}" ] } }, "/v0/administration/location_assignments": { "post": { "tags": [ "LocationAssignment" ], "summary": "Create LocationAssignment", "operationId": "LocationAssignmentAPI.create", "requestBody": { "description": "LocationAssignment to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAssignment" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAssignment" } } } }, "400": { "description": "Validation error" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/location_assignments" ] } }, "/v0/administration/location_assignments/{id}": { "get": { "tags": [ "LocationAssignment" ], "summary": "Return the Location Assignment corresponding to the given id", "operationId": "LocationAssignmentAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting LocationAssignment", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAssignment" } } } }, "404": { "description": "Location assignment not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/location_assignments/{id}" ] }, "put": { "tags": [ "LocationAssignment" ], "summary": "Updates the given LocationAssignment", "operationId": "LocationAssignmentAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting LocationAssignment", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "LocationAssignment to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAssignment" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAssignment" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/location_assignments/{id}" ] }, "delete": { "tags": [ "LocationAssignment" ], "summary": "Deletes the LocationAssignment with given id", "operationId": "LocationAssignmentAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting LocationAssignment", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAssignment" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/location_assignments/{id}" ] } }, "/v0/administration/locations": { "get": { "tags": [ "Location" ], "summary": "Returns every Location available from the LocationAPI", "operationId": "LocationAPI.all", "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.LocationList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/locations" ] }, "post": { "tags": [ "Location" ], "summary": "Create Location", "description": "Creating a root location is not allowed", "operationId": "LocationAPI.create", "requestBody": { "description": "Location to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Location" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Location" } } } }, "400": { "description": "Parent object ID is required. Validation errors." }, "404": { "description": "AGB code could not be found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/locations" ] } }, "/v0/administration/locations/{id}": { "get": { "tags": [ "Location" ], "summary": "Return the Location corresponding to the given id", "operationId": "LocationAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Location", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Location" } } } }, "404": { "description": "Location not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/locations/{id}" ] }, "put": { "tags": [ "Location" ], "summary": "Update Location.", "operationId": "LocationAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Location", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Location data to update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Location" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Location" } } } }, "400": { "description": "Validation errors" }, "404": { "description": "Location could not be found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/locations/{id}" ] } }, "/v0/administration/locations/multiple": { "get": { "tags": [ "Location" ], "summary": "Method used for requesting multiple Location objects using\ntheir ids.", "operationId": "LocationAPI.multiple", "parameters": [ { "name": "id", "in": "query", "description": "array style id's: id=1&id=2&etc", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.LocationList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/locations/multiple" ] } }, "/v0/administration/navigation/availabilities": { "get": { "tags": [ "NavigationAvailability" ], "summary": "Get all navigation availabilities for Ons Administration", "operationId": "NavigationAvailabilityAPI.getCupidoNavigationAvailabilities", "parameters": [ { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.NavigationAvailabilityList" } } } } }, "x-replacement-for": [ "/t/navigation/availabilities" ] } }, "/v0/administration/omaha/classifications/{id}": { "get": { "tags": [ "dossier.omaha.OmahaClassification" ], "summary": "Get the OmahaClassification corresponding to the given id", "operationId": "dossier.omaha.OmahaClassificationAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting OmahaClassification", "required": true, "schema": { "type": "string" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.omaha.OmahaClassification" } } } }, "400": { "description": "Invalid classification" }, "404": { "description": "No Cupido careplan found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/omaha/omaha_classifications/{id}" ] }, "put": { "tags": [ "dossier.omaha.OmahaClassification" ], "summary": "Updates the given OmahaClassification", "operationId": "dossier.omaha.OmahaClassificationAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting OmahaClassification", "required": true, "schema": { "type": "string" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "OmahaClassification to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.omaha.OmahaClassification" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.omaha.OmahaClassification" } } } }, "400": { "description": "Invalid classification" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/omaha/omaha_classifications/{id}" ] } }, "/v0/administration/omaha/classifications/by_client/{client_id}/new": { "post": { "tags": [ "dossier.omaha.OmahaClassification" ], "summary": "Create an OmahaClassification for the Client corresponding to the given id", "operationId": "dossier.omaha.OmahaClassificationAPI.newDraft", "parameters": [ { "name": "client_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.omaha.OmahaClassification" } } } }, "400": { "description": "Invalid classification" } }, "x-replacement-for": [ "/t/dossier/omaha/omaha_classifications/by_client/{client_id}/new" ] } }, "/v0/administration/omaha/classifications/by_survey_result/{survey_result_id}": { "get": { "tags": [ "dossier.omaha.OmahaClassification" ], "operationId": "dossier.omaha.OmahaClassificationAPI.bySurveyResult", "parameters": [ { "name": "survey_result_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.omaha.OmahaClassification" } } } } }, "x-replacement-for": [ "/t/dossier/omaha/omaha_classifications/by_survey_result/{survey_result_id}" ] } }, "/v0/administration/omaha/classified_problems": { "post": { "tags": [ "dossier.omaha.ClassifiedProblem" ], "summary": "Create ClassifiedProblem", "operationId": "dossier.omaha.ClassifiedProblemAPI.create", "parameters": [ { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "ClassifiedProblem to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.omaha.ClassifiedProblem" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.omaha.ClassifiedProblem" } } } }, "400": { "description": "Invalid problem" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/omaha/classified_problems" ] } }, "/v0/administration/omaha/classified_problems/{id}": { "get": { "tags": [ "dossier.omaha.ClassifiedProblem" ], "summary": "Return the Omaha Classified Problem corresponding to the given id", "operationId": "dossier.omaha.ClassifiedProblemAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting ClassifiedProblem", "required": true, "schema": { "type": "string" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.omaha.ClassifiedProblem" } } } }, "400": { "description": "Invalid problem" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/omaha/classified_problems/{id}" ] }, "put": { "tags": [ "dossier.omaha.ClassifiedProblem" ], "summary": "Updates the given ClassifiedProblem", "operationId": "dossier.omaha.ClassifiedProblemAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting ClassifiedProblem", "required": true, "schema": { "type": "string" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "ClassifiedProblem to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.omaha.ClassifiedProblem" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.omaha.ClassifiedProblem" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/omaha/classified_problems/{id}" ] }, "delete": { "tags": [ "dossier.omaha.ClassifiedProblem" ], "summary": "Deletes the ClassifiedProblem with given id", "operationId": "dossier.omaha.ClassifiedProblemAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting ClassifiedProblem", "required": true, "schema": { "type": "string" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "204": { "description": "If successfully removed the classified problem" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/omaha/classified_problems/{id}" ] } }, "/v0/administration/omaha/intervention_categories": { "get": { "tags": [ "dossier.omaha.InterventionCategory" ], "summary": "Returns every InterventionCategory available from the InterventionCategoryAPI", "operationId": "dossier.omaha.InterventionCategoryAPI.all", "parameters": [ { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.omaha.list.InterventionCategoryList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/omaha/intervention_categories" ] } }, "/v0/administration/omaha/intervention_targets": { "get": { "tags": [ "dossier.omaha.InterventionTarget" ], "summary": "Returns every InterventionTarget available from the InterventionTargetAPI", "operationId": "dossier.omaha.InterventionTargetAPI.all", "parameters": [ { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.omaha.list.InterventionTargetList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/omaha/intervention_targets" ] } }, "/v0/administration/omaha/problems": { "get": { "tags": [ "dossier.omaha.Problem" ], "summary": "Returns every Problem available from the ProblemAPI", "operationId": "dossier.omaha.ProblemAPI.all", "parameters": [ { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.omaha.list.ProblemList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/omaha/problems" ] } }, "/v0/administration/payable_hours_averages/on_day_of_week_in_period/{employee_id}": { "get": { "tags": [ "payroll.PayableHoursAverage" ], "summary": "Get the average payable hours for a given day of the week, for the specified employee and the requested period (inclusive).", "description": "use {@link #onDaysOfWeekInPeriod(Long, LocalDate, LocalDate, List, List)} instead The default period is last thirteen weeks.\nOnly payable hours are included. Shifts are not automatically payable hours. Only the parts of the shift for which active work was booked.\nWe include payrolling, vacation, sick leave, PLB vacation, LFB, moved shifts, moved shift day off, calls during shifts, and overtime.", "operationId": "payroll.PayableHoursAverageAPI.onDayOfWeekInPeriod", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "valid_from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "day_of_week", "in": "query", "description": "ISO8601 day of week number, where Monday (1) is the first day of the week, and Sunday (7) is the last. {@see java.time.DayOfWeek}", "schema": { "type": "integer", "format": "int32" } }, { "name": "hour_type_id", "in": "query", "description": "array style id's: hour_type_id=1&hour_type_id=2&etc", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.PayableHoursAverage" } } } }, "400": { "description": "Employee is required and must be under contract in the requested period" } }, "deprecated": true, "x-replacement-for": [ "/t/payroll/payable_hours_averages/on_day_of_week_in_period/{employee_id}" ] } }, "/v0/administration/payable_hours_averages/on_days_of_week_in_period/{employee_id}": { "get": { "tags": [ "payroll.PayableHoursAverage" ], "summary": "Get the average payable hours for the given days of the week, for the specified employee and the requested period (inclusive).", "description": "The default period is last thirteen weeks.\nOnly payable hours are included. Shifts are not automatically payable hours. Only the parts of the shift for which active work was booked.\nWe include payrolling, vacation, sick leave, PLB vacation, LFB, moved shifts, moved shift day off, calls during shifts, and overtime.", "operationId": "payroll.PayableHoursAverageAPI.onDaysOfWeekInPeriod", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "valid_from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "day_of_week", "in": "query", "description": "ISO8601 day of week number, where Monday (1) is the first day of the week, and Sunday (7) is the last. {@see java.time.DayOfWeek}", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "hour_type_id", "in": "query", "description": "array style id's: hour_type_id=1&hour_type_id=2&etc", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.list.PayableHoursAverageList" } } } }, "400": { "description": "Employee is required and must be under contract in the requested period" } }, "x-replacement-for": [ "/t/payroll/payable_hours_averages/on_days_of_week_in_period/{employee_id}" ] } }, "/v0/administration/payable_hours_averages/per_day_in_period/{employee_id}": { "get": { "tags": [ "payroll.PayableHoursAverage" ], "summary": "Get the average payable hours per day, for the specified employee and the requested period (inclusive).", "description": "The default period is the last thirteen weeks.\nOnly payable hours are included. Shifts are not automatically payable hours. Only the parts of the shift for which active work was booked.\nWe include payrolling, vacation, sick leave, PLB vacation, LFB, moved shifts, moved shift day off, calls during shifts, and overtime.", "operationId": "payroll.PayableHoursAverageAPI.perDayInPeriod", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "valid_from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "hour_type_id", "in": "query", "description": "array style id's: hour_type_id=1&hour_type_id=2&etc", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.PayableHoursAverage" } } } }, "400": { "description": "Employee is required and must be under contract in the requested period" } }, "x-replacement-for": [ "/t/payroll/payable_hours_averages/per_day_in_period/{employee_id}" ] } }, "/v0/administration/payable_hours_averages/per_week_in_period/{employee_id}": { "get": { "tags": [ "payroll.PayableHoursAverage" ], "summary": "Get the average payable hours per week, for the specified employee and the requested period (inclusive).", "description": "The default period is last thirteen weeks.\nOnly payable hours are included. Shifts are not automatically payable hours. Only the parts of the shift for which active work was booked.\nWe include payrolling, vacation, sick leave, PLB vacation, LFB, moved shifts, moved shift day off, calls during shifts, and overtime.", "operationId": "payroll.PayableHoursAverageAPI.perWeekInPeriod", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "valid_from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "hour_type_id", "in": "query", "description": "array style id's: hour_type_id=1&hour_type_id=2&etc", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.PayableHoursAverage" } } } }, "400": { "description": "Employee is required and must be under contract in the requested period" } }, "x-replacement-for": [ "/t/payroll/payable_hours_averages/per_week_in_period/{employee_id}" ] } }, "/v0/administration/personal_relation_types": { "get": { "tags": [ "PersonalRelationType" ], "summary": "Returns every PersonalRelationType available from the PersonalRelationTypeAPI", "operationId": "PersonalRelationTypeAPI.all", "parameters": [ { "name": "offset", "in": "query", "description": "number of results to skip", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "number of results for one call", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.PersonalRelationTypeList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/administration/personal_relation_types" ] } }, "/v0/administration/personal_relation_types/{id}": { "get": { "tags": [ "PersonalRelationType" ], "summary": "Returns the PersonalRelationType corresponding to the given id", "operationId": "PersonalRelationTypeAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting PersonalRelationType", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonalRelationType" } } } }, "404": { "description": "Personal Relation Type not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/administration/personal_relation_types/{id}" ] } }, "/v0/administration/practitioners/by_agb/{agbcode}": { "get": { "tags": [ "Practitioner" ], "summary": "Return the practitioner based on the given agbcode", "operationId": "PractitionerAPI.byAgb", "parameters": [ { "name": "agbcode", "in": "path", "description": "the (primary) agbcode of an employee", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } }, "x-replacement-for": [ "/t/practitioners/by_agb/{agbcode}" ] } }, "/v0/administration/practitioners/by_employee/{employee_id}": { "get": { "tags": [ "Practitioner" ], "summary": "Return the practitioner based on the given id of an employee", "operationId": "PractitionerAPI.byEmployee", "parameters": [ { "name": "employee_id", "in": "path", "description": "The objectid of the employee", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Practitioner" } } } } }, "x-replacement-for": [ "/t/practitioners/by_employee/{employee_id}" ] } }, "/v0/administration/practitioners/search": { "get": { "tags": [ "Practitioner" ], "summary": "Return the practitioners based on the given search query", "operationId": "PractitionerAPI.search", "parameters": [ { "name": "query", "in": "query", "description": "the searchquery. for instance: the last name of a employee", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "set the max size of the returned list", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "set position in the result list to start from", "schema": { "type": "integer", "format": "int32" } }, { "name": "date", "in": "query", "description": "the date on which the practitioner should have a contract", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.PractitionerList" } } } } }, "x-replacement-for": [ "/t/practitioners/search" ] } }, "/v0/administration/presence/presence_logs/{id}": { "get": { "tags": [ "PresenceLog" ], "summary": "Return Presence Log corresponding to the given id", "operationId": "PresenceLogAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting PresenceLog", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresenceLog" } } } }, "404": { "description": "Presence Log not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/presence_logs/{id}" ] } }, "/v0/administration/presence/presence_logs/with_care_order/{presence_log_object_id}": { "get": { "tags": [ "PresenceLog" ], "operationId": "PresenceLogAPI.withCareOrder", "parameters": [ { "name": "presence_log_object_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresenceLog" } } } } }, "x-replacement-for": [ "/t/presence_logs/with_care_order/{presence_log_object_id}" ] } }, "/v0/administration/referrals": { "post": { "tags": [ "Referral" ], "summary": "Create Referral", "operationId": "ReferralAPI.create", "requestBody": { "description": "Referral to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Referral" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Referral" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/referrals" ] } }, "/v0/administration/referrals/{id}": { "get": { "tags": [ "Referral" ], "summary": "Return the Referral corresponding to the given id", "operationId": "ReferralAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Referral", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Referral" } } } }, "404": { "description": "Referral not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/referrals/{id}" ] } }, "/v0/administration/referrals/by_client/{client_id}": { "get": { "tags": [ "Referral" ], "summary": "Returns the referrals of the client corresponding to the given client id.", "operationId": "ReferralAPI.byClient", "parameters": [ { "name": "client_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ReferralList" } } } } }, "x-replacement-for": [ "/t/referrals/by_client/{client_id}" ] } }, "/v0/administration/referrals/categories": { "get": { "tags": [ "Referral" ], "summary": "Fetch all available ReferrerCategories accompanied by their available referrer types", "operationId": "ReferralAPI.getAllReferrerCategories", "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ReferrerCategoryList" } } } } }, "x-replacement-for": [ "/t/referrals/categories" ] } }, "/v0/administration/skns/{id}": { "get": { "tags": [ "Skn" ], "summary": "Return the Skn corresponding to the given id", "operationId": "SknAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Skn", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Skn" } } } }, "404": { "description": "Skn not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/skns/{id}" ] } }, "/v0/administration/status/application": { "get": { "tags": [ "status.ApplicationStatus" ], "summary": "Retrieves the ApplicationStatus", "operationId": "status.ApplicationStatusAPI.get", "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status.ApplicationStatus" } } } } }, "x-replacement-for": [ "/t/status/application" ] } }, "/v0/administration/survey_answer/{id}": { "delete": { "tags": [ "survey.Answer" ], "summary": "Deletes the Answer with given id", "description": "Answer IDs are found through the endpoint /t/suveys/survey_results/{survey_result_id}", "operationId": "survey.AnswerAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of Answer to delete.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/survey.Answer" } } } }, "204": { "description": "Success" }, "400": { "description": "Validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/survey/answers/{id}" ] } }, "/v0/administration/survey_result": { "post": { "tags": [ "survey.SurveyResult" ], "summary": "Create SurveyResult", "description": "It is not allowed to post surveys without answers. Username must be set.", "operationId": "survey.SurveyResultAPI.create", "parameters": [ { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "SurveyResult to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/survey.SurveyResult" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/survey.SurveyResult" } } } }, "400": { "description": "Survey without answers, or other validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/survey/survey_results" ] } }, "/v0/administration/survey_result/{id}": { "get": { "tags": [ "survey.SurveyResult" ], "operationId": "survey.SurveyResultAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting SurveyResult", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/survey.SurveyResult" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/survey/survey_results/{id}" ] }, "put": { "tags": [ "survey.SurveyResult" ], "summary": "Updates the given SurveyResult", "operationId": "survey.SurveyResultAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of SurveyResult to update.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "SurveyResult to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/survey.SurveyResult" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/survey.SurveyResult" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/survey/survey_results/{id}" ] }, "delete": { "tags": [ "survey.SurveyResult" ], "summary": "Deletes the SurveyResult with given id", "operationId": "survey.SurveyResultAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of SurveyResult to delete.", "required": true, "schema": { "type": "integer", "format": "int64" }, "example": 111 } ], "responses": { "204": { "description": "If successfully removed the survey result" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/survey/survey_results/{id}" ] } }, "/v0/administration/survey_result/{survey_result_id}/duplicate": { "post": { "tags": [ "survey.SurveyResult" ], "summary": "Duplicate a Survey Result", "description": "When used through Ons API, the employee_id for the copied SurveyResult is set to a default user. This employee_id can be changed by using the PUT operation on the newly created SurveyResult.", "operationId": "survey.SurveyResultAPI.duplicate", "parameters": [ { "name": "survey_result_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/survey.SurveyResult" } } } } }, "x-replacement-for": [ "/t/survey/survey_results/{survey_result_id}/duplicate" ] } }, "/v0/administration/survey_result/by_survey/{survey_id}": { "get": { "tags": [ "survey.SurveyResult" ], "summary": "Return the SurveyResults of a Survey corresponding to the given id.", "operationId": "survey.SurveyResultAPI.bySurveyId", "parameters": [ { "name": "survey_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "employee_id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "updatedSince", "in": "query", "schema": { "type": "string", "format": "date" }, "x-original-parameter": { "name": "updated_since" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/survey.list.SurveyResultList" } } } } }, "x-replacement-for": [ "/t/survey/surveys/{survey_id}/survey_results" ] } }, "/v0/administration/survey_result/survey_results_by_client/{client_id}": { "get": { "tags": [ "survey.SurveyResult" ], "summary": "Return the survey results of a Client corresponding to the given id.", "operationId": "survey.SurveyResultAPI.byClientId", "parameters": [ { "name": "client_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "employee_id", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/survey.list.SurveyResultList" } } } } }, "x-replacement-for": [ "/t/clients/{client_id}/survey_results" ] } }, "/v0/administration/survey/answer_definition_groups": { "get": { "tags": [ "survey.AnswerDefinitionGroup" ], "summary": "Returns every AnswerDefinitionGroup available from the AnswerDefinitionGroupAPI", "operationId": "survey.AnswerDefinitionGroupAPI.all", "parameters": [ { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/survey.list.AnswerDefinitionGroupList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/survey/answer_definition_groups" ] }, "post": { "tags": [ "survey.AnswerDefinitionGroup" ], "summary": "Create AnswerDefinitionGroup", "operationId": "survey.AnswerDefinitionGroupAPI.create", "parameters": [ { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "AnswerDefinitionGroup to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/survey.AnswerDefinitionGroup" } } }, "required": true }, "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/survey.AnswerDefinitionGroup" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/survey/answer_definition_groups" ] } }, "/v0/administration/survey/answer_definition_groups/{id}": { "get": { "tags": [ "survey.AnswerDefinitionGroup" ], "operationId": "survey.AnswerDefinitionGroupAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting AnswerDefinitionGroup", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/survey.AnswerDefinitionGroup" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/survey/answer_definition_groups/{id}" ] }, "put": { "tags": [ "survey.AnswerDefinitionGroup" ], "summary": "Updates the given AnswerDefinitionGroup", "operationId": "survey.AnswerDefinitionGroupAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting AnswerDefinitionGroup", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "X-Cupido-User-Name", "in": "header", "schema": { "type": "string" } }, { "name": "X-Cupido-Active-Identity", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "description": "AnswerDefinitionGroup to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/survey.AnswerDefinitionGroup" } } }, "required": true }, "responses": { "200": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/survey.AnswerDefinitionGroup" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/survey/answer_definition_groups/{id}" ] } }, "/v0/administration/survey/group_answers/{id}": { "get": { "tags": [ "survey.GroupAnswer" ], "summary": "Return the Survey Group Answer corresponding to the given id", "operationId": "survey.GroupAnswerAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting GroupAnswer", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/survey.GroupAnswer" } } } }, "404": { "description": "GroupAnswer not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/survey/group_answers/{id}" ] } }, "/v0/administration/survey/surveys": { "get": { "tags": [ "survey.Survey" ], "summary": "Returns every Survey available from the SurveyAPI", "operationId": "survey.SurveyAPI.all", "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/survey.list.SurveyList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/survey/surveys" ] }, "post": { "tags": [ "survey.Survey" ], "summary": "Create Survey", "operationId": "survey.SurveyAPI.create", "requestBody": { "description": "Survey to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/survey.Survey" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/survey.Survey" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/survey/surveys" ] } }, "/v0/administration/survey/surveys/{id}": { "get": { "tags": [ "survey.Survey" ], "operationId": "survey.SurveyAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Survey", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/survey.Survey" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/survey/surveys/{id}" ] }, "put": { "tags": [ "survey.Survey" ], "summary": "Updates the given Survey", "operationId": "survey.SurveyAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of Survey to update.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Survey to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/survey.Survey" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/survey.Survey" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/survey/surveys/{id}" ] }, "delete": { "tags": [ "survey.Survey" ], "summary": "Deletes the Survey with given id", "description": "It's not possible to delete a survey that has results.", "operationId": "survey.SurveyAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of Survey to delete.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "If successfully removed the survey" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/survey/surveys/{id}" ] } }, "/v0/administration/survey/surveys/creatable_surveys_by_employee/{employee_id}": { "get": { "tags": [ "survey.Survey" ], "summary": "Return the creatable Surveys for the Employee corresponding to the given id", "operationId": "survey.SurveyAPI.creatableSurveysByEmployee", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/survey.list.SurveyList" } } } }, "404": { "description": "No surveys found for employee" } }, "x-replacement-for": [ "/t/survey/surveys/creatable_surveys_by_employee/{employee_id}" ] } }, "/v0/administration/team_addresses": { "post": { "tags": [ "TeamAddress" ], "summary": "Create TeamAddress", "operationId": "TeamAddressAPI.create", "requestBody": { "description": "TeamAddress to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamAddress" } } }, "required": true }, "responses": { "200": { "description": "Successfully created TeamAddress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamAddress" } } } }, "400": { "description": "TeamAddress must have a team" }, "404": { "description": "Team not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/team_addresses" ] } }, "/v0/administration/team_addresses/{id}": { "get": { "tags": [ "TeamAddress" ], "summary": "Return the Team Address corresponding to the given id", "operationId": "TeamAddressAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "Selecting TeamAddress", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Successfully retrieved TeamAddress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamAddress" } } } }, "404": { "description": "Address or TeamAddress not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/team_addresses/{id}" ] }, "put": { "tags": [ "TeamAddress" ], "summary": "Updates the given TeamAddress", "operationId": "TeamAddressAPI.updateById", "parameters": [ { "name": "id", "in": "path", "description": "Selecting TeamAddress to update", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "TeamAddress to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamAddress" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamAddress" } } } }, "400": { "description": "Missing id or validation errors" }, "404": { "description": "TeamAddress not found" } }, "x-replacement-for": [ "/t/team_addresses/{id}" ] }, "delete": { "tags": [ "TeamAddress" ], "summary": "Used to delete TeamAddress by a given id", "operationId": "TeamAddressAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "Selecting TeamAddress to delete", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "Successfully deleted" }, "404": { "description": "TeamAddress or team to delete not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/team_addresses/{id}" ] } }, "/v0/administration/team_assignments/{id}": { "get": { "tags": [ "TeamAssignment" ], "summary": "Return the team assignment with the given id.", "operationId": "TeamAssignmentAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "id of the team assignment", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamAssignment" } } } }, "404": { "description": "Team assignment not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/team_assignments/{id}" ] } }, "/v0/administration/teams": { "get": { "tags": [ "Team" ], "summary": "Return all teams", "operationId": "TeamAPI.all", "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.TeamList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/teams" ] } }, "/v0/administration/teams/{id}": { "get": { "tags": [ "Team" ], "summary": "Return the Team corresponding to the given id", "operationId": "TeamAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Team", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Team" } } } }, "404": { "description": "Team not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/teams/{id}" ] } }, "/v0/administration/teams/by_code/{code}": { "get": { "tags": [ "Team" ], "summary": "Return the code of a Team corresponding to the given id.", "operationId": "TeamAPI.byCode", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Team" } } } }, "404": { "description": "Team not found" } }, "x-replacement-for": [ "/t/teams/by_code/{code}" ] } }, "/v0/administration/teams/multiple": { "get": { "tags": [ "Team" ], "summary": "Method used for requesting multiple Team objects using\ntheir ids.", "operationId": "TeamAPI.multiple", "parameters": [ { "name": "id", "in": "query", "description": "array style id's: id=1&id=2&etc", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.TeamList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/teams/multiple" ] } }, "/v0/administration/transport/client_transport/by_client/{client_id}": { "get": { "tags": [ "transport.ClientTransport" ], "summary": "Find the ClientTransport information for a given client on the given date", "operationId": "transport.ClientTransportAPI.byClientIdAtDate", "parameters": [ { "name": "client_id", "in": "path", "description": "id of client for which the ClientTransport should be retrieved", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "date", "in": "query", "description": "date for which the ClientTransport should be retrieved", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transport.ClientTransport" } } } }, "400": { "description": "Client ID and date are required" } }, "x-replacement-for": [ "/t/transport/client_transport/by_client/{client_id}" ] } }, "/v0/administration/treatment_locations/{id}": { "get": { "tags": [ "TreatmentLocation" ], "summary": "Return the treatment location by id", "operationId": "TreatmentLocationAPI.byId", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentLocation" } } } }, "404": { "description": "Treatment Location not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/treatment_locations/{id}" ] } }, "/v0/administration/users": { "post": { "tags": [ "User" ], "summary": "Create User", "operationId": "UserAPI.create", "requestBody": { "description": "User to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/users" ] } }, "/v0/administration/users/{id}": { "get": { "tags": [ "User" ], "summary": "Get user by ID", "operationId": "UserAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting User", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "User not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/users/{id}" ] }, "put": { "tags": [ "User" ], "summary": "Updates the given User", "operationId": "UserAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting User", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "User to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "User not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/users/{id}" ] }, "delete": { "tags": [ "User" ], "summary": "Deletes the User with given id", "operationId": "UserAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting User", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "User not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/users/{id}" ] } }, "/v0/administration/users/{user_id}/last_visited_clients": { "get": { "tags": [ "Client" ], "summary": "Return the last visited Clients of a User corresponding to the given id.", "operationId": "ClientAPI.lastVisitedByUserId", "parameters": [ { "name": "user_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ClientList" } } } } }, "x-replacement-for": [ "/t/users/{user_id}/last_visited_clients" ] } }, "/v0/administration/users/{user_id}/last_visited_clients/{client_id}": { "post": { "tags": [ "Client" ], "summary": "Add or update client in favorite table", "operationId": "ClientAPI.addOrUpdateClientInFavorite", "parameters": [ { "name": "user_id", "in": "path", "description": "User ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "client_id", "in": "path", "description": "Client ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No content" }, "400": { "description": "User or client id is required" }, "403": { "description": "Insufficient rights" }, "404": { "description": "User or client not found" } }, "x-replacement-for": [ "/t/users/{user_id}/last_visited_clients/{client_id}" ] } }, "/v0/administration/users/{user_id}/last_visited_employees": { "get": { "tags": [ "Employee" ], "summary": "Return the last visited Employees of a User corresponding to the given id.", "operationId": "EmployeeAPI.lastVisitedByUserId", "parameters": [ { "name": "user_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.EmployeeList" } } } } }, "x-replacement-for": [ "/t/users/{user_id}/last_visited_employees" ] } }, "/v0/administration/users/{user_id}/last_visited_locations": { "get": { "tags": [ "User" ], "summary": "Return the last visited Locations of a User corresponding to the given id.", "operationId": "UserAPI.lastVisitedLocations", "parameters": [ { "name": "user_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.LocationList" } } } } }, "x-replacement-for": [ "/t/users/{user_id}/last_visited_locations" ] } }, "/v0/administration/users/{user_id}/last_visited_teams": { "get": { "tags": [ "Team" ], "summary": "Return the last visited Teams of a User corresponding to the given id.", "operationId": "TeamAPI.lastVisitedByUserId", "parameters": [ { "name": "user_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.TeamList" } } } } }, "x-replacement-for": [ "/t/users/{user_id}/last_visited_teams" ] } }, "/v0/administration/users/{user_id}/password": { "put": { "tags": [ "User" ], "summary": "Changes the users password", "operationId": "UserAPI.changePassword", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "the new password, must consist of a combination of upper- and lowercase letters, numbers and special characters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordChange" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordChange" } } } } }, "x-replacement-for": [ "/t/users/{user_id}/password" ] } }, "/v0/administration/users/{user_id}/scoped_teams": { "get": { "tags": [ "Team" ], "summary": "Return the scoped Teams of a User corresponding to the given id.", "description": "use Shield. See https://github.com/nedap/shield/issues/3207#issuecomment-635947346 ", "operationId": "TeamAPI.scopedByUserId", "parameters": [ { "name": "user_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.TeamList" } } } } }, "deprecated": true, "x-deprecated-since": "11-11-2019", "x-replacement-for": [ "/t/users/{user_id}/scoped_teams" ] } }, "/v0/administration/users/{user_id}/status": { "get": { "tags": [ "User" ], "summary": "returns the status of the user", "description": "containing a description about if the user is allowed to log into the application", "operationId": "UserAPI.getUserStatus", "parameters": [ { "name": "user_id", "in": "path", "description": "user id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserStatus" } } } } }, "x-replacement-for": [ "/t/users/{user_id}/status" ] } }, "/v0/administration/users/{user_id}/viewable_locations": { "get": { "tags": [ "User" ], "summary": "Return the viewable Locations of a User corresponding to the given id.", "description": "use Shield. See https://github.com/nedap/shield/issues/3207#issuecomment-635947346", "operationId": "UserAPI.viewableLocations", "parameters": [ { "name": "user_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ignore_recursive_locations_enabled", "in": "query", "description": "Only return location user has explicitly access to, ignoring locations beneath those locations", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.LocationList" } } } } }, "deprecated": true, "x-deprecated-since": "11-11-2019", "x-replacement-for": [ "/t/users/{user_id}/viewable_locations" ] } }, "/v0/administration/users/by_employee_id/{employee_id}": { "get": { "tags": [ "User" ], "summary": "Get user by employee ID", "operationId": "UserAPI.byEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "User not found" } }, "x-replacement-for": [ "/t/users/by_employee_id/{employee_id}" ] } }, "/v0/administration/users/by_sso": { "get": { "tags": [ "User" ], "summary": "Return the User with the given SSO id", "operationId": "UserAPI.bySso", "parameters": [ { "name": "sso_id", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sso_provider_id", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.UserList" } } } }, "404": { "description": "User not found" } }, "x-replacement-for": [ "/t/users/by_sso" ] } }, "/v0/administration/users/by_username": { "get": { "tags": [ "User" ], "summary": "Find by user name.", "operationId": "UserAPI.byUserName", "parameters": [ { "name": "username", "in": "query", "description": "The username of the user to find", "schema": { "type": "string" }, "x-original-parameter": { "name": "user_name" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "User not found" } }, "x-replacement-for": [ "/t/users/by_user_name" ] } }, "/v0/administration/users/by_username/{user_name}": { "get": { "tags": [ "User" ], "summary": "Find by user name.", "description": "Use byUserNameSafe", "operationId": "UserAPI.byUserNameUnsafe", "parameters": [ { "name": "user_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "deprecated": true, "x-deprecated-since": "04-07-2020", "x-replacement-for": [ "/t/users/by_user_name/{user_name}" ] } }, "/v0/administration/users/by_uuid/{uuid}": { "get": { "tags": [ "User" ], "summary": "Get user by UUID", "operationId": "UserAPI.byUuid", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "bump_session_expire_time", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "User not found" } }, "x-replacement-for": [ "/t/users/by_uuid/{uuid}" ] } }, "/v0/administration/weeksheet_profiles": { "get": { "tags": [ "WeeksheetProfile" ], "summary": "Return all weeksheet profiles", "operationId": "WeeksheetProfileAPI.getAllWeeksheetProfiles", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.WeeksheetProfileList" } } } } }, "x-replacement-for": [ "/t/weeksheet_profiles" ] } }, "/v0/administration/weeksheet_profiles/{weeksheet_profile_id}/direct_profile_activity_assignments": { "get": { "tags": [ "ProfileActivityAssignment" ], "summary": "Return the direct profile activity assignments of an WeeksheetProfile corresponding to the given id.", "operationId": "ProfileActivityAssignmentAPI.directAssignmentsByWeeksheetProfileId", "parameters": [ { "name": "weeksheet_profile_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ProfileActivityAssignmentList" } } } } }, "x-replacement-for": [ "/t/weeksheet_profiles/{weeksheet_profile_id}/direct_profile_activity_assignments" ] } }, "/v0/administration/weeksheet_profiles/{weeksheet_profile_id}/expense_profile_activity_assignments": { "get": { "tags": [ "ProfileActivityAssignment" ], "summary": "Return the indirect duration profile activity assignments of an WeeksheetProfile corresponding to the given id.", "operationId": "ProfileActivityAssignmentAPI.expenseAssignmentsByWeeksheetProfileId", "parameters": [ { "name": "weeksheet_profile_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ProfileActivityAssignmentList" } } } } }, "x-replacement-for": [ "/t/weeksheet_profiles/{weeksheet_profile_id}/expense_profile_activity_assignments" ] } }, "/v0/administration/weeksheet_profiles/{weeksheet_profile_id}/indirect_duration_profile_activity_assignments": { "get": { "tags": [ "ProfileActivityAssignment" ], "summary": "Return the indirect duration profile activity assignments of an WeeksheetProfile corresponding to the given id.", "operationId": "ProfileActivityAssignmentAPI.indirectDurationAssignmentsByWeeksheetProfileId", "parameters": [ { "name": "weeksheet_profile_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ProfileActivityAssignmentList" } } } } }, "x-replacement-for": [ "/t/weeksheet_profiles/{weeksheet_profile_id}/indirect_duration_profile_activity_assignments" ] } }, "/v0/administration/weeksheet_profiles/{weeksheet_profile_id}/indirect_profile_activity_assignments": { "get": { "tags": [ "ProfileActivityAssignment" ], "summary": "Return the indirect profile activity assignments of an WeeksheetProfile corresponding to the given id.", "operationId": "ProfileActivityAssignmentAPI.indirectAssignmentsByWeeksheetProfileId", "parameters": [ { "name": "weeksheet_profile_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.ProfileActivityAssignmentList" } } } } }, "x-replacement-for": [ "/t/weeksheet_profiles/{weeksheet_profile_id}/indirect_profile_activity_assignments" ] } }, "/v0/administration/wlz/zorglegitimaties": { "post": { "tags": [ "wlz.WlzZorglegitimatie" ], "summary": "Create WlzZorglegitimatie", "operationId": "wlz.WlzZorglegitimatieAPI.create", "requestBody": { "description": "WlzZorglegitimatie to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wlz.WlzZorglegitimatie" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wlz.WlzZorglegitimatie" } } } }, "400": { "description": "Validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/wlz/zorglegitimaties" ] } }, "/v0/administration/wlz/zorglegitimaties/{id}": { "get": { "tags": [ "wlz.WlzZorglegitimatie" ], "summary": "Return the WlzZorgLegitimatie corresponding to the given id", "operationId": "wlz.WlzZorglegitimatieAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used to find the WlzZorglegitimatie", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wlz.WlzZorglegitimatie" } } } }, "404": { "description": "Indicatiebesluit cannot be found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/wlz/zorglegitimaties/{id}" ] }, "delete": { "tags": [ "wlz.WlzZorglegitimatie" ], "summary": "Delete a WlzZorglegitimatie", "operationId": "wlz.WlzZorglegitimatieAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "used to find the WlzZorglegitimatie", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wlz.WlzZorglegitimatie" } } } }, "400": { "description": "Validation errors" }, "404": { "description": "Indicatiebesluit cannot be found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/wlz/zorglegitimaties/{id}" ] } }, "/v0/administration/wmo/zorglegitimaties": { "post": { "tags": [ "wmo.WmoZorglegitimatie" ], "summary": "Create WmoZorglegitimatie", "operationId": "wmo.WmoZorglegitimatieAPI.create", "requestBody": { "description": "WmoZorglegitimatie to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wmo.WmoZorglegitimatie" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wmo.WmoZorglegitimatie" } } } }, "400": { "description": "Validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/wmo/zorglegitimaties" ] } }, "/v0/administration/wmo/zorglegitimaties/{id}": { "get": { "tags": [ "wmo.WmoZorglegitimatie" ], "summary": "Return the WmoZorgLegitimatie corresponding to the given id", "operationId": "wmo.WmoZorglegitimatieAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used to find the WmoZorglegitimatie", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wmo.WmoZorglegitimatie" } } } }, "404": { "description": "WMO Toewijzing Beschikking cannot be found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/wmo/zorglegitimaties/{id}" ] }, "delete": { "tags": [ "wmo.WmoZorglegitimatie" ], "summary": "Delete a WmoZorglegitimatie", "operationId": "wmo.WmoZorglegitimatieAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "used to find the WmoZorglegitimatie", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wmo.WmoZorglegitimatie" } } } }, "400": { "description": "Validation errors" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/wmo/zorglegitimaties/{id}" ] } }, "/v0/administration/work_hours_balances/by_employee_at_date/{employee_object_id}": { "get": { "tags": [ "payroll.WorkHoursBalance" ], "summary": "Retrieves a list with all workhour balances for the given employee and for the given date.", "operationId": "payroll.WorkHoursBalanceAPI.byEmployeeAtDate", "parameters": [ { "name": "employee_object_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.list.WorkHoursBalanceList" } } } } }, "x-replacement-for": [ "/t/payroll/work_hours_balances/by_employee_at_date/{employee_object_id}" ] } }, "/v0/administration/work_hours_balances/by_employee_with_type_at_date/{employee_object_id}": { "get": { "tags": [ "payroll.WorkHoursBalance" ], "summary": "Retrieves a workhour balance for the given employee/accounttype and date.", "operationId": "payroll.WorkHoursBalanceAPI.byEmployeeAndAccountTypeAtDate", "parameters": [ { "name": "employee_object_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "account_type_id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.WorkHoursBalance" } } } } }, "x-replacement-for": [ "/t/payroll/work_hours_balances/by_employee_with_type_at_date/{employee_object_id}" ] } }, "/v0/administration/work_hours_balances/by_employee_with_type/{employee_object_id}": { "get": { "tags": [ "payroll.WorkHoursBalance" ], "summary": "Retrieves a workhour balance for the given employee and account type.", "operationId": "payroll.WorkHoursBalanceAPI.byEmployeeAndAccountType", "parameters": [ { "name": "employee_object_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "account_type_id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.WorkHoursBalance" } } } } }, "x-replacement-for": [ "/t/payroll/work_hours_balances/by_employee_with_type/{employee_object_id}" ] } }, "/v0/administration/work_hours_balances/by_employee/{employee_object_id}": { "get": { "tags": [ "payroll.WorkHoursBalance" ], "summary": "Retrieves a list with all workhour balances for the given employee.", "operationId": "payroll.WorkHoursBalanceAPI.byEmployee", "parameters": [ { "name": "employee_object_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.list.WorkHoursBalanceList" } } } } }, "x-replacement-for": [ "/t/payroll/work_hours_balances/by_employee/{employee_object_id}" ] } }, "/v0/administration/work_load/by_employee_in_year/{employee_object_id}": { "get": { "tags": [ "payroll.WorkLoad" ], "summary": "Retrieves the workload for the given year and employee.", "description": "When the work load is requested for the current year, the result will be given until last Sunday.", "operationId": "payroll.WorkLoadAPI.byEmployeeInYear", "parameters": [ { "name": "employee_object_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "year", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payroll.WorkLoad" } } } } }, "x-replacement-for": [ "/t/payroll/work_load/by_employee_in_year/{employee_object_id}" ] } }, "/v0/administration/worksheets/{employee_id}": { "get": { "tags": [ "worksheet.Worksheet" ], "summary": "Returns worksheet in pdf format", "operationId": "worksheet.WorksheetAPI.generate", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "valid_from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/worksheet.Worksheet" } } } } }, "x-replacement-for": [ "/t/worksheets/{employee_id}" ] } }, "/v0/administration/zpm/care_orders": { "post": { "tags": [ "zpm.CareOrderZpmDetails" ], "summary": "Create ZPM detail records for a given care order.", "operationId": "zpm.CareOrderZpmDetailsAPI.create", "requestBody": { "description": "an object containing all detail records that\n should be created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zpm.CareOrderZpmDetails" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zpm.CareOrderZpmDetails" } } } }, "400": { "description": "Validation or persistence problems" }, "404": { "description": "CareOrder not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/zpm/care_orders" ] } }, "/v0/administration/zpm/care_orders/{care_order_id}": { "get": { "tags": [ "zpm.CareOrderZpmDetails" ], "summary": "Fetches ZPM detail records for a given care order.", "operationId": "zpm.CareOrderZpmDetailsAPI.byCareOrderId", "parameters": [ { "name": "care_order_id", "in": "path", "description": "care order object ID.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zpm.CareOrderZpmDetails" } } } } }, "x-replacement-for": [ "/t/zpm/care_orders/{care_order_id}" ] } }, "/v0/administration/zpm/gbggz_profielen": { "get": { "tags": [ "zpm.ZpmGbggzProfiel" ], "summary": "Returns a list of all ZPM GB-ggz profielen.", "operationId": "zpm.ZpmGbggzProfielAPI.getAll", "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zpm.list.ZpmGbggzProfielList" } } } } }, "x-replacement-for": [ "/t/zpm/gbggz_profielen" ] } }, "/v0/administration/zpm/settings": { "get": { "tags": [ "zpm.ZpmSetting" ], "summary": "Returns a list of all ZPM settings.", "operationId": "zpm.ZpmSettingAPI.getAll", "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zpm.list.ZpmSettingList" } } } } }, "x-replacement-for": [ "/t/zpm/settings" ] } }, "/v0/administration/zpm/zorglabels": { "get": { "tags": [ "zpm.ZpmZorglabel" ], "summary": "Returns a list of all ZPM zorglabels.", "operationId": "zpm.ZpmZorglabelAPI.getAll", "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zpm.list.ZpmZorglabelList" } } } } }, "x-replacement-for": [ "/t/zpm/zorglabels" ] } }, "/v0/agenda/agenda_occurrences/{agenda_occurrence_id}/presence_logs": { "get": { "tags": [ "PresenceLog" ], "summary": "Return the PresenceLogs of a AgendaOccurrence corresponding to the given id.", "operationId": "PresenceLogAPI.byAgendaOccurrenceId", "parameters": [ { "name": "agenda_occurrence_id", "in": "path", "description": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.PresenceLogList" } } } } }, "x-replacement-for": [ "/t/agenda_occurrences/{agenda_occurrence_id}/presence_logs" ] } }, "/v0/agenda/agenda_occurrences/{id}": { "get": { "tags": [ "agenda.AgendaOccurrence" ], "summary": "Get event occurrence", "description": "Get event occurrence", "operationId": "agenda.AgendaOccurrenceAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting AgendaOccurrence", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.AgendaOccurrence" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/agenda_occurrences/{id}" ] } }, "/v0/agenda/agenda_occurrences/{id}/destroy_following": { "delete": { "tags": [ "agenda.AgendaOccurrence" ], "summary": "Removes the given agenda occurrence item and all of the following occurrences of that item", "description": "Removes the given appointment occurrence and all of the following occurrences of that appointment", "operationId": "agenda.AgendaOccurrenceAPI.destroyFollowing", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of AgendaOccurrence to delete.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "AgendaOccurrence to remove", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.AgendaOccurrence" } } }, "required": true }, "responses": { "204": { "description": "If successfully removed the agenda occurrence", "content": {} } }, "x-replacement-for": [ "/t/agenda_occurrences/{id}/destroy_following" ] } }, "/v0/agenda/agenda_occurrences/{id}/destroy_incidentally": { "delete": { "tags": [ "agenda.AgendaOccurrence" ], "summary": "Removes only the given agenda occurrence item", "description": "Removes the given appointment occurrence", "operationId": "agenda.AgendaOccurrenceAPI.destroyIncidentally", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of AgendaOccurrence to delete.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "AgendaOccurrence to remove", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.AgendaOccurrence" } } }, "required": true }, "responses": { "204": { "description": "If successfully removed the agenda occurrence" } }, "x-replacement-for": [ "/t/agenda_occurrences/{id}/destroy_incidentally" ] } }, "/v0/agenda/agenda_occurrences/{id}/update_following": { "put": { "tags": [ "agenda.AgendaOccurrence" ], "summary": "Updates the given AgendaOccurrence item and all of the following\noccurrences of that item.", "description": "NB:\n\ncurrent: When creating of updating an AgendaOccurrence the start_time and end_time fields are used by Ons Agenda.\nThe starts_at and ends_at fields will be ignored.\n\nfuture: When creating of updating an AgendaOccurrence the starts_at and ends_at fields are used by Ons Agenda.\nThe start_time and end_time fields will be ignored and eventually be removed.\n\nWhen you change any property of the Occurrence when updating \"following\",\nthis will break the Series in two. The pre-existing Series is ended (`validTo`)\nat the last occurrence before this one. Then from this occurrence a new\nSeries is created with the updated properties.\n\nThere is one exception to this rule:\n- When updating the first occurrence in a Series, the Series is updated in place.", "operationId": "agenda.AgendaOccurrenceAPI.updateFollowing", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of AgendaOccurrence to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.AgendaOccurrence" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.AgendaOccurrence" } } } } }, "x-replacement-for": [ "/t/agenda_occurrences/{id}/update_following" ] } }, "/v0/agenda/agenda_occurrences/{id}/update_incidentally": { "put": { "tags": [ "agenda.AgendaOccurrence" ], "summary": "Updates only the given AgendaOccurrence.", "description": "NB:\n\ncurrent: When creating of updating an AgendaOccurrence the start_time and end_time fields are used by Ons Agenda.\nThe starts_at and ends_at fields will be ignored.\n\nfuture: When creating of updating an AgendaOccurrence the starts_at and ends_at fields are used by Ons Agenda.\nThe start_time and end_time fields will be ignored and eventually be removed.", "operationId": "agenda.AgendaOccurrenceAPI.updateIncidentally", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of AgendaOccurrence to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.AgendaOccurrence" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.AgendaOccurrence" } } } } }, "x-replacement-for": [ "/t/agenda_occurrences/{id}/update_incidentally" ] } }, "/v0/agenda/agenda_registration_status": { "get": { "tags": [ "agenda.RegistrationStatus" ], "summary": "Return the agenda registrations status of a specific type corresponding to the given id.", "description": "Return the agenda registrations status of a specific type corresponding to the given id.", "operationId": "agenda.RegistrationStatusAPI.byTypeIds", "parameters": [ { "name": "valid_from", "in": "query", "description": "Start date (inclusive) of selection period", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "description": "End date (exclusive) of selection period", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "type", "in": "query", "description": "type of status, can be: employee, client, team, location", "required": true, "schema": { "$ref": "#/components/schemas/agenda.RegistrationStatusType" } }, { "name": "type_ids[]", "in": "query", "description": "List of ids", "required": true, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "x-original-parameter": { "name": "type_ids" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.list.RegistrationStatusList" } } } } }, "x-replacement-for": [ "/t/agenda_registration_status" ] } }, "/v0/agenda/agenda_series": { "post": { "tags": [ "agenda.AgendaSeries" ], "summary": "Create AgendaSeries", "description": "Used to create AgendaSeries", "operationId": "agenda.AgendaSeriesAPI.create", "requestBody": { "description": "AgendaSeries to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.AgendaSeries" } } }, "required": true }, "responses": { "200": { "description": "If successfully created the agenda series", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.AgendaSeries" } } } }, "204": { "description": "No Content" }, "400": { "description": "Bad request" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/agenda_series" ] } }, "/v0/agenda/agenda_series/archive_group": { "post": { "tags": [ "agenda.AgendaSeries" ], "summary": "Archive an AgendaSeries from a Groupcare Group", "description": "Used to archive an AgendaSeries from a Groupcare Group. Deprecated: use Groepsplanning instead.", "operationId": "agenda.AgendaSeriesAPI.archiveGroup", "requestBody": { "description": "AgendaSeries from a Group to archive", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.AgendaSeries" } } }, "required": true }, "responses": { "200": { "description": "If successfully archived the agenda series", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.AgendaSeries" } } } } }, "deprecated": true, "x-deprecated-since": "20-11-2025", "x-replacement-for": [ "/t/agenda_series/archive_group" ] } }, "/v0/agenda/agenda_series/update_group": { "put": { "tags": [ "agenda.AgendaSeries" ], "summary": "Update the Group information for an Agenda series", "description": "Used to update the Group information for an Agenda series. Deprecated: use Groepsplanning instead.", "operationId": "agenda.AgendaSeriesAPI.updateGroup", "requestBody": { "description": "AgendaSeries from a group to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.AgendaSeries" } } }, "required": true }, "responses": { "200": { "description": "If successfully updated the agenda series", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.AgendaSeries" } } } } }, "deprecated": true, "x-deprecated-since": "20-11-2025", "x-replacement-for": [ "/t/agenda_series/update_group" ] } }, "/v0/agenda/client_absence_occurrences/{id}": { "get": { "tags": [ "agenda.ClientAbsenceOccurrence" ], "summary": "Used for selecting a ClientAbsenceOccurrence", "description": "Used for selecting a ClientAbsenceOccurrence", "operationId": "agenda.ClientAbsenceOccurrenceAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting ClientAbsenceOccurrence", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.ClientAbsenceOccurrence" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/agenda/client_absence_occurrences/{id}" ] } }, "/v0/agenda/client_absence_occurrences/by_client_in_period": { "get": { "tags": [ "agenda.ClientAbsenceOccurrence" ], "summary": "Used for selecting ClientAbsenceOccurrences from a client and moment in time.", "description": "Used for selecting ClientAbsenceOccurrences from a client and moment in time.", "operationId": "agenda.ClientAbsenceOccurrenceAPI.byClientInPeriod", "parameters": [ { "name": "client_id", "in": "query", "description": "The ID of the client to get the ClientAbsenceOccurrences from", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "from", "in": "query", "description": "The start date of the ClientAbsenceOccurrences to retrieve", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "The end date of the ClientAbsenceOccurrences to retrieve", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.list.ClientAbsenceOccurrenceList" } } } } }, "x-replacement-for": [ "/t/agenda/client_absence_occurrences/by_client_in_period" ] } }, "/v0/agenda/clients/{client_id}/agenda_occurrences": { "get": { "tags": [ "agenda.AgendaOccurrence" ], "summary": "Return the agenda occurrences of a Client corresponding to the given id.", "description": "List event occurrences for client", "operationId": "agenda.AgendaOccurrenceAPI.byClientId", "parameters": [ { "name": "client_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "from", "in": "query", "description": "Start date (inclusive) of selection period", "required": true, "schema": { "type": "string", "format": "date" }, "x-original-parameter": { "name": "valid_from" } }, { "name": "to", "in": "query", "description": "End date (exclusive) of selection period", "required": true, "schema": { "type": "string", "format": "date" }, "x-original-parameter": { "name": "valid_to" } }, { "name": "require_client_present", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.list.AgendaOccurrenceList" } } } }, "404": { "description": "Not found" } }, "x-replacement-for": [ "/t/clients/{client_id}/agenda_occurrences" ] } }, "/v0/agenda/employees/{employee_id}/agenda_occurrences": { "get": { "tags": [ "agenda.AgendaOccurrence" ], "summary": "Return the agenda occurrences of a Employee corresponding to the given id.", "description": "List event occurrences for employee", "operationId": "agenda.AgendaOccurrenceAPI.byEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "from", "in": "query", "description": "Start date (inclusive) of selection period", "required": true, "schema": { "type": "string", "format": "date" }, "x-original-parameter": { "name": "valid_from" } }, { "name": "to", "in": "query", "description": "End date (exclusive) of selection period", "required": true, "schema": { "type": "string", "format": "date" }, "x-original-parameter": { "name": "valid_to" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.list.AgendaOccurrenceList" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/agenda_occurrences" ] } }, "/v0/agenda/employees/{employee_id}/entries/reservation": { "get": { "tags": [ "agenda.ReservationOccurrence" ], "summary": "Return the reservation occurrences of an Employee in the given period.", "description": "List reservation occurrences for employee. The period may span at most 42 days.", "operationId": "agenda.ReservationOccurrenceAPI.byEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "description": "External id of the employee to retrieve the reservations for.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "from", "in": "query", "description": "Start date (inclusive) of selection period", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "End date (exclusive) of selection period", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Reservation occurrence response. Hash with list of occurrences.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.ReservationOccurrenceResponse" } } } } }, "x-replacement-for": [ "/t/agenda/employees/{employee_id}/entries/reservation" ] } }, "/v0/agenda/entries/reservations": { "post": { "tags": [ "agenda.ReservationCreate" ], "summary": "Creates a reservation for the specified employee", "description": "Creates a reservation for an employee. When a recurrenceRule is supplied a recurring reservation is created, otherwise a single reservation is created.", "operationId": "agenda.ReservationCreateAPI.createReservation", "requestBody": { "description": "Reservation to be created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.ReservationCreate" } } }, "required": true }, "responses": { "204": { "description": "Reservation created" }, "403": { "description": "Insufficient rights" }, "404": { "description": "Employee or label not found" }, "422": { "description": "Request parameters did not validate" } }, "x-replacement-for": [ "/t/agenda/entries/reservations" ] } }, "/v0/agenda/entries/reservations/occurrences/{occurrence_id}": { "delete": { "tags": [ "agenda.ReservationOccurrence" ], "summary": "Delete a single reservation occurrence.", "description": "Removes a single occurrence of a reservation series.", "operationId": "agenda.ReservationOccurrenceAPI.deleteInstance", "parameters": [ { "name": "occurrence_id", "in": "path", "description": "Occurrence id of the reservation occurrence to remove.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Reservation occurrence removed" }, "403": { "description": "Insufficient rights" }, "404": { "description": "Reservation occurrence not found" }, "422": { "description": "Request parameters did not validate" } }, "x-replacement-for": [ "/t/agenda/entries/reservations/occurrences/{occurrence_id}" ] }, "patch": { "tags": [ "agenda.ReservationOccurrence" ], "summary": "Update a single reservation occurrence.", "description": "Updates a single occurrence of a reservation series. Only the supplied fields are changed; omitted fields are left unchanged.", "operationId": "agenda.ReservationOccurrenceAPI.updateInstance", "parameters": [ { "name": "occurrence_id", "in": "path", "description": "Occurrence id of the reservation occurrence to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Fields to update on the reservation occurrence.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.ReservationUpdate" } } }, "required": true }, "responses": { "204": { "description": "Reservation occurrence updated" }, "403": { "description": "Insufficient rights" }, "404": { "description": "Reservation occurrence not found" }, "422": { "description": "Request parameters did not validate" } }, "x-replacement-for": [ "/t/agenda/entries/reservations/occurrences/{occurrence_id}" ] } }, "/v0/agenda/entries/reservations/occurrences/{occurrence_id}/following": { "delete": { "tags": [ "agenda.ReservationOccurrence" ], "summary": "Delete a reservation occurrence and all following occurrences.", "description": "Removes the given reservation occurrence and all of the following occurrences in the series.", "operationId": "agenda.ReservationOccurrenceAPI.deleteFollowing", "parameters": [ { "name": "occurrence_id", "in": "path", "description": "Occurrence id of the reservation occurrence from which to remove this and all following occurrences.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Reservation occurrences removed" }, "403": { "description": "Insufficient rights" }, "404": { "description": "Reservation occurrence not found" }, "422": { "description": "Request parameters did not validate" } }, "x-replacement-for": [ "/t/agenda/entries/reservations/occurrences/{occurrence_id}/following" ] }, "patch": { "tags": [ "agenda.ReservationOccurrence" ], "summary": "Update a reservation occurrence and all following occurrences.", "description": "Updates the given reservation occurrence and all of the following occurrences in the series. Only the supplied fields are changed; omitted fields are left unchanged.", "operationId": "agenda.ReservationOccurrenceAPI.updateFollowing", "parameters": [ { "name": "occurrence_id", "in": "path", "description": "Occurrence id of the reservation occurrence from which to update this and all following occurrences.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Fields to update on the reservation occurrences.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.ReservationUpdate" } } }, "required": true }, "responses": { "204": { "description": "Reservation occurrences updated" }, "403": { "description": "Insufficient rights" }, "404": { "description": "Reservation occurrence not found" }, "422": { "description": "Request parameters did not validate" } }, "x-replacement-for": [ "/t/agenda/entries/reservations/occurrences/{occurrence_id}/following" ] } }, "/v0/agenda/groups/{group_uuid}/agenda_occurrences": { "get": { "tags": [ "agenda.AgendaOccurrence" ], "summary": "Return the agenda occurrences of a group corresponding to the given uuid.", "description": "Return the agenda occurrences of a group corresponding to the given uuid. Deprected: use Groepsplanning instead", "operationId": "agenda.AgendaOccurrenceAPI.byGroupUuid", "parameters": [ { "name": "group_uuid", "in": "path", "description": "uuid", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Start date (inclusive) of selection period", "required": true, "schema": { "type": "string", "format": "date" }, "x-original-parameter": { "name": "valid_from" } }, { "name": "to", "in": "query", "description": "End date (exclusive) of selection period", "required": true, "schema": { "type": "string", "format": "date" }, "x-original-parameter": { "name": "valid_to" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.list.AgendaOccurrenceList" } } } } }, "deprecated": true, "x-deprecated-since": "20-11-2025", "x-replacement-for": [ "/t/agenda_occurrences/by_group/{group_uuid}" ] } }, "/v0/agenda/labels": { "get": { "tags": [ "agenda.Label" ], "summary": "Returns every Label available from the LabelAPI", "description": "List appointment labels currently available", "operationId": "agenda.LabelAPI.all", "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.list.LabelList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/agenda/labels" ] } }, "/v0/agenda/locations/{location_id}/agenda_occurrences": { "get": { "tags": [ "agenda.AgendaOccurrence" ], "summary": "Return the agenda occurrences of a Location corresponding to the given id.", "description": "List event occurrences for location", "operationId": "agenda.AgendaOccurrenceAPI.byLocationId", "parameters": [ { "name": "location_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "from", "in": "query", "description": "Start date (inclusive) of selection period", "required": true, "schema": { "type": "string", "format": "date" }, "x-original-parameter": { "name": "valid_from" } }, { "name": "to", "in": "query", "description": "End date (exclusive) of selection period", "required": true, "schema": { "type": "string", "format": "date" }, "x-original-parameter": { "name": "valid_to" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.list.AgendaOccurrenceList" } } } } }, "x-replacement-for": [ "/t/locations/{location_id}/agenda_occurrences" ] } }, "/v0/agenda/teams": { "get": { "tags": [ "Team" ], "summary": "Check whether agenda is enabled", "description": "Returns all agenda-enabled teams", "operationId": "TeamAPI.agendaEnabled", "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list.TeamList" } } } } }, "x-replacement-for": [ "/t/teams/agenda_enabled" ] } }, "/v0/agenda/unavailabilities": { "post": { "tags": [ "agenda.Unavailability" ], "summary": "Creates an Agenda Unavailability for the specified employee", "description": "Used to create new unavailabilities", "operationId": "agenda.UnavailabilityAPI.create", "requestBody": { "description": "Unavailibality to be created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.Unavailability" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agenda.Unavailability" } } } }, "204": { "description": "No Content" }, "400": { "description": "Bad request" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/agenda/unavailabilities" ] } }, "/v0/announcements/announcement_count": { "get": { "tags": [ "herald.AnnouncementCount" ], "operationId": "herald.AnnouncementCountAPI.byUserId", "parameters": [ { "name": "user_id", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/herald.AnnouncementCount" } } } } }, "x-replacement-for": [ "/t/herald/announcement_count" ] } }, "/v0/auditing/export": { "get": { "tags": [ "toezicht.Audit" ], "summary": "Export audits for a given time period", "description": "Exports audits for a given time period. Returns JSON data.", "operationId": "toezicht.AuditAPI.streamExport", "parameters": [ { "name": "date_from", "in": "query", "description": "Start date of exported audits (included)", "required": true, "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "description": "End date of exported audits (included)", "required": true, "schema": { "type": "string" } }, { "name": "titles[]", "in": "query", "description": "Patterns used to filter audits by title, format: titles=title1&titles=title2&titles=title3", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-original-parameter": { "name": "titles" } }, { "name": "user_uuids[]", "in": "query", "description": "Filter audits by user UUID, format: user_uuids=uuid1&user_uuids=uuid2", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-original-parameter": { "name": "user_uuids" } }, { "name": "client_ids[]", "in": "query", "description": "Filter audits by referenced client id, format: client_ids=1&client_ids=2", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "x-original-parameter": { "name": "client_ids" } }, { "name": "names[]", "in": "query", "description": "Filter audits by exact name, format: names=name1&names=name2", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-original-parameter": { "name": "names" } }, { "name": "applications[]", "in": "query", "description": "Filter audits by originating application, format: applications=app1&applications=app2", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-original-parameter": { "name": "applications" } }, { "name": "system", "in": "query", "description": "Filter on system (background) audits. true = only system, false = exclude system", "schema": { "type": "boolean" } }, { "name": "failed", "in": "query", "description": "Filter on failed audits. true = only failed, false = only successful", "schema": { "type": "boolean" } }, { "name": "with_nonempty_references", "in": "query", "description": "When true, only return audits referencing a client or employee. Only true is accepted", "schema": { "enum": [ true ], "type": "boolean" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/toezicht.list.AuditList" } } } } }, "x-replacement-for": [ "/t/auditing/export" ] } }, "/v0/authorization/provisioning/roles": { "get": { "tags": [ "authorization.provisioning.Role" ], "summary": "Returns every Role available from the RoleAPI", "operationId": "authorization.provisioning.RoleAPI.all", "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization.provisioning.list.RoleList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/authorization/provisioning/roles" ] } }, "/v0/authorization/provisioning/users/{user_uuid}": { "put": { "tags": [ "authorization.provisioning.User" ], "summary": "This endpoint is meant to assign roles with a certain scope (teams/locations) to a user.", "description": "Provide the complete set of all roles that should be assigned (roleUuid, teams and locations) to the user.\n As this API is idempotent, the state provided in the last call is the final state. Any roles previously assigned but not specified in the body will be revoked.\n The connector is only able to control roles which are assigned by the connector itself (identified by the connector_name and connector_source).\n The changes can be seen in the Ons Autorisatie UI if you navigate to the specific user. The added roles are listed in the role overview. All the roles added by a specific connector are marked as such.\n More explanation can be found here: https://ons-api.nl/support/Shield.html", "operationId": "authorization.provisioning.UserAPI.update", "parameters": [ { "name": "user_uuid", "in": "path", "description": "Identifier of User to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "User to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization.provisioning.User" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization.provisioning.User" } } } } }, "deprecated": true, "x-cupido-common-method": true, "x-deprecated-since": "11-11-2025", "x-replacement-for": [ "/t/authorization/provisioning/users/{user_uuid}" ] } }, "/v0/authorization/provisioning/users/{user_uuid}/duties": { "put": { "tags": [ "authorization.provisioning.UserDuties" ], "summary": "This endpoint is meant to assign roles with a certain scope to a user.", "description": "Provide the complete set of all roles that should be assigned to the user. Roles should be provided together with flags to reflect the scoping policy that states what clients and/or employees should be accessible.\n As this API is idempotent, the state provided in the last call is the final state. Any roles previously assigned but not specified in the body will be revoked.\n The connector is only able to control roles which are assigned by the connector itself (identified by the connector_name and connector_source).\n The changes can be seen in the Ons Autorisatie UI if you navigate to the specific user. The added roles are listed in the role overview. All the roles added by a specific connector are marked as such.\n More explanation can be found here: https://ons-api.nl/support/Shield.html.\n This endpoint replaces PUT /users endpoint.", "operationId": "authorization.provisioning.UserDutiesAPI.update", "parameters": [ { "name": "user_uuid", "in": "path", "description": "Identifier of User to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "User to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization.provisioning.UserDuties" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization.provisioning.UserDuties" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/authorization/provisioning/users/{user_uuid}/duties" ] } }, "/v0/authorization/provisioning/users/{user_uuid}/my_locations": { "put": { "tags": [ "authorization.provisioning.MyLocations" ], "summary": "This endpoint is meant to set the list of MyLocations of a user.", "description": "Provide the complete set of all locations that should be assigned to the user.\n As this API is idempotent, the state provided in the last call is the final state. Any locations previously added but not specified in the body will be removed.\n This endpoint together with /my_teams and /scope_settings are replacements for the PUT /users/{user_uuid}/scopes endpoint.", "operationId": "authorization.provisioning.MyLocationsAPI.set", "parameters": [ { "name": "user_uuid", "in": "path", "description": "Identifier of User to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "the new list of MyLocations", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization.provisioning.MyLocations" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization.provisioning.MyLocations" } } } } }, "x-replacement-for": [ "/t/authorization/provisioning/users/{user_uuid}/my_locations" ] } }, "/v0/authorization/provisioning/users/{user_uuid}/my_teams": { "put": { "tags": [ "authorization.provisioning.MyTeams" ], "summary": "This endpoint is meant to set the list of MyTeams of a user.", "description": "Provide the complete set of all teams that should be assigned to the user.\n As this API is idempotent, the state provided in the last call is the final state. Any teams previously added but not specified in the body will be removed.\n This endpoint together with /my_locations and /scope_settings are replacements for the PUT /users/{user_uuid}/scopes endpoint.", "operationId": "authorization.provisioning.MyTeamsAPI.set", "parameters": [ { "name": "user_uuid", "in": "path", "description": "Identifier of User to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "the new list of MyTeams", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization.provisioning.MyTeams" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization.provisioning.MyTeams" } } } } }, "x-replacement-for": [ "/t/authorization/provisioning/users/{user_uuid}/my_teams" ] } }, "/v0/authorization/provisioning/users/{user_uuid}/scope_settings": { "put": { "tags": [ "authorization.provisioning.UserScopeSettings" ], "summary": "Updates scope settings of a user.", "description": "Updates scope settings of a user. Provide the complete set of legacy_auth_scoping_options that should be assigned to the user.\n As this API is idempotent, the state provided in the last call is the final state. Any scopes previously added but not specified in the body will be removed.\n This endpoint together with /my_teams and /my_locations are replacements for the PUT /users/{user_uuid}/scopes endpoint.", "operationId": "authorization.provisioning.UserScopeSettingsAPI.set", "parameters": [ { "name": "user_uuid", "in": "path", "description": "Identifier of User to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "the new set of scope settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization.provisioning.UserScopeSettings" } } }, "required": true }, "responses": { "200": { "description": "User scope settings have been updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization.provisioning.UserScopeSettings" } } } } }, "x-replacement-for": [ "/t/authorization/provisioning/users/{user_uuid}/scope_settings" ] } }, "/v0/authorization/provisioning/users/{user_uuid}/scopes": { "put": { "tags": [ "authorization.provisioning.DefaultScope" ], "summary": "This endpoint is meant to set the default scope of a user.", "description": "Provide the complete set of all the groups that should be assigned (e.g. teams, locations, etc) to the user.\n As this API is idempotent, the state provided in the last call is the final state. Any groups previously added but not specified in the body will be removed.", "operationId": "authorization.provisioning.DefaultScopeAPI.update", "parameters": [ { "name": "user_uuid", "in": "path", "description": "Identifier of User to update.", "required": true, "schema": { "type": "string" } }, { "name": "override_all", "in": "query", "description": "By default only scopes set by the current integrator are replaced.\n For migration purposes this flag allows to replace all scopes when set to 'true', including scopes which are owned by others.\n", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "the new DefaultScope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization.provisioning.DefaultScope" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization.provisioning.DefaultScope" } } } } }, "deprecated": true, "x-cupido-common-method": true, "x-deprecated-since": "11-11-2025", "x-replacement-for": [ "/t/authorization/provisioning/users/{user_uuid}/scopes" ] } }, "/v0/berichten/employees/{employee_id}/setting": { "get": { "tags": [ "kamino.KaminoSetting" ], "summary": "Return the kamino setting of a employee corresponding to the given employee id.", "description": "Return the kamino setting of a employee corresponding to the given employee id.", "operationId": "kamino.KaminoSettingAPI.byEmployeeId", "parameters": [ { "name": "employee_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kamino.KaminoSetting" } } } }, "403": { "description": "Unauthorized without customer header", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kamino.Error" } } } }, "404": { "description": "Employee not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kamino.Error" } } } } }, "x-replacement-for": [ "/t/employees/{employee_id}/kamino_setting" ] }, "patch": { "tags": [ "kamino.KaminoSetting" ], "summary": "Updates the kamino setting of the employee corresponding to the given employee id.", "description": "Updates the kamino setting of the employee corresponding to the given employee id.", "operationId": "kamino.KaminoSettingAPI.update", "parameters": [ { "name": "employee_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kamino.KaminoSetting" } } }, "required": true }, "responses": { "204": { "description": "If successfully patched the setting", "content": {} }, "403": { "description": "Unauthorized without customer header", "content": {} }, "404": { "description": "Employee not found", "content": {} } }, "x-replacement-for": [ "/t/employees/{employee_id}/kamino_setting" ] } }, "/v0/caretech/server/orders": { "get": { "tags": [ "caretech.Order" ], "summary": "Get all care technology orders with optional product codes and statuses", "operationId": "caretech.OrderAPI.getOrdersServerGateway", "parameters": [ { "name": "product_codes", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "statuses", "in": "query", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/caretech.OrderStatus" }, "description": "The status of the orders, can be OPEN, DECLINED, ACCEPTED or COMPLETED" }, "example": [ "OPEN", "DECLINED" ] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/caretech.list.OrderList" } } } } }, "x-replacement-for": [ "/t/caretech/server/orders" ] } }, "/v0/caretech/server/orders/{order_id}": { "get": { "tags": [ "caretech.Order" ], "summary": "Get an care technology order", "operationId": "caretech.OrderAPI.getOrderServerGateway", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/caretech.Order" } } } }, "404": { "description": "Order not found" } }, "x-replacement-for": [ "/t/caretech/server/orders/{order_id}" ] } }, "/v0/caretech/server/orders/{order_id}/status": { "patch": { "tags": [ "caretech.Order" ], "summary": "Update the status of an order", "operationId": "caretech.OrderAPI.updateOrderStatus", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/caretech.OrderStatusUpdate" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "description": "Validation errors" }, "404": { "description": "Order not found" } }, "x-replacement-for": [ "/t/caretech/server/orders/{order_id}/status" ] } }, "/v0/caretech/server/product_allocations": { "post": { "tags": [ "caretech.ProductAllocation" ], "summary": "Create a product allocation, including a new product instance, for a client", "operationId": "caretech.ProductAllocationAPI.createProductAllocationServerGateway", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/caretech.ProductAllocation" } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/caretech.ProductAllocation" } } } }, "400": { "description": "Validation errors" } }, "x-replacement-for": [ "/t/caretech/server/product_allocations" ] } }, "/v0/caretech/server/return_requests": { "get": { "tags": [ "caretech.ReturnRequest" ], "summary": "Get all care technology return requests matching the provided parameters.", "operationId": "caretech.ReturnRequestAPI.getReturnRequests", "parameters": [ { "name": "product_codes", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "N-0001", "N-0002" ] }, { "name": "statuses", "in": "query", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/caretech.ReturnRequestStatus" } }, "example": [ "OPEN", "DECLINED" ] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/caretech.list.ReturnRequestList" } } } }, "400": { "description": "Validation errors" }, "403": { "description": "Connector not authorized" } }, "x-replacement-for": [ "/t/caretech/server/return_requests" ] } }, "/v0/caretech/server/return_requests/{return_request_id}": { "get": { "tags": [ "caretech.ReturnRequest" ], "summary": "Get a care technology return request", "operationId": "caretech.ReturnRequestAPI.getReturnRequest", "parameters": [ { "name": "return_request_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/caretech.ReturnRequest" } } } }, "404": { "description": "Return request not found" } }, "x-replacement-for": [ "/t/caretech/server/return_requests/{return_request_id}" ] } }, "/v0/caretech/server/return_requests/{return_request_id}/status": { "patch": { "tags": [ "caretech.ReturnRequest" ], "summary": "Update the status of a return request", "operationId": "caretech.ReturnRequestAPI.updateReturnRequest", "parameters": [ { "name": "return_request_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/caretech.ReturnRequestUpdate" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "description": "Validation errors" }, "404": { "description": "Return request not found" } }, "x-replacement-for": [ "/t/caretech/server/return_requests/{return_request_id}/status" ] } }, "/v0/client_story/authorized/clients/{client_id}/client_story/images": { "get": { "tags": [ "client_story.Story" ], "summary": "Authorized api\nReturn a base64 encoded string of the image that is identified by the given reference", "operationId": "client_story.StoryAPI.authorizedImageByClientIdAndReference", "parameters": [ { "name": "client_id", "in": "path", "description": "The client the image belongs to", "required": true, "schema": { "type": "string" }, "x-original-parameter": { "in": "query" } }, { "name": "reference", "in": "query", "description": "The reference of the image", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "x-replacement-for": [ "/t/client_story/authorized/images/by_client_id_and_reference" ] } }, "/v0/client_story/authorized/stories/full_by_client/{client_id}": { "get": { "tags": [ "client_story.Story" ], "summary": "Return the full client story for the given client id.", "description": "Checks the ClientStoryOverview right and generates an audit.", "operationId": "client_story.StoryAPI.authorizedFullByClient", "parameters": [ { "name": "client_id", "in": "path", "description": "The ID of the client", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_story.Story" } } } } }, "x-replacement-for": [ "/t/client_story/authorized_stories/full_by_client/{client_id}" ] } }, "/v0/client_story/care_relations/request_for_client/{client_id}": { "post": { "tags": [ "client_story.Story" ], "summary": "Get permission for the current careprovider to view the client story", "operationId": "client_story.StoryAPI.createPermission", "parameters": [ { "name": "client_id", "in": "path", "description": "The ID of the client", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "x-replacement-for": [ "/t/client_story/care_relations/request_for_client/{client_id}" ] } }, "/v0/client_story/change_sets/most_recent_by_client/{client_id}": { "get": { "tags": [ "client_story.ChangeSet" ], "summary": "Returns the most recent change set for the client", "operationId": "client_story.ChangeSetAPI.mostRecentByClient", "parameters": [ { "name": "client_id", "in": "path", "description": "The ID of the client", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_story.ChangeSet" } } } } }, "x-replacement-for": [ "/t/client_story/change_sets/most_recent_by_client/{client_id}" ] } }, "/v0/client_story/clients/{client_id}/client_story/images": { "get": { "tags": [ "client_story.Story" ], "summary": "Return a base64 encoded string of the image that is identified by the given reference", "operationId": "client_story.StoryAPI.imageByClientIdAndReference", "parameters": [ { "name": "client_id", "in": "path", "description": "The client the image belongs to", "required": true, "schema": { "type": "string" }, "x-original-parameter": { "in": "query" } }, { "name": "reference", "in": "query", "description": "The reference of the image", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "x-replacement-for": [ "/t/client_story/images/by_client_id_and_reference" ] } }, "/v0/client_story/stories/by_client/{client_id}": { "put": { "tags": [ "client_story.Story" ], "summary": "Save updates to the story of the client incrementally", "operationId": "client_story.StoryAPI.saveAnswer", "parameters": [ { "name": "client_id", "in": "path", "description": "The ID of the client", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "The story of the client", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_story.Story" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_story.Story" } } } } }, "x-replacement-for": [ "/t/client_story/stories/by_client/{client_id}" ] } }, "/v0/client_story/stories/full_by_client/{client_id}": { "get": { "tags": [ "client_story.Story" ], "summary": "Return the full client story for the given client id", "operationId": "client_story.StoryAPI.fullByClient", "parameters": [ { "name": "client_id", "in": "path", "description": "The ID of the client", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_story.Story" } } } } }, "x-replacement-for": [ "/t/client_story/stories/full_by_client/{client_id}" ] } }, "/v0/client_story/stories/single_answer_full_by_client/{client_id}": { "get": { "tags": [ "client_story.Story" ], "summary": "Return the full client story for the given client id\nCollapses the full json schema and form data to a single answer", "operationId": "client_story.StoryAPI.singleAnswerFullByClient", "parameters": [ { "name": "client_id", "in": "path", "description": "The ID of the client", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_story.Story" } } } } }, "x-replacement-for": [ "/t/client_story/stories/single_answer_full_by_client/{client_id}" ] } }, "/v0/client/shared_resources": { "get": { "tags": [ "ons_client.SharedResource" ], "summary": "Retrieve all shared resources", "operationId": "ons_client.SharedResourceAPI.byClientIdAndResource", "parameters": [ { "name": "client_id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "resource_name", "in": "query", "schema": { "type": "string" } }, { "name": "resource_id", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ons_client.list.SharedResourceList" } } } } }, "x-replacement-for": [ "/t/ons_client/shared_resources" ] } }, "/v0/dbc/fz/subtraject": { "get": { "tags": [ "dbc.ggz.fz.Subtraject" ], "summary": "Fetches a number ('limit') of subtrajects that lay within the given time period.", "operationId": "dbc.ggz.fz.SubtrajectAPI.all", "parameters": [ { "name": "valid_from", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "include_all_registrations", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "include_all_grouper_results", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "only_afleidbare_registraties", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.fz.list.SubtrajectList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dbc/ggz/fz/subtrajecten" ] } }, "/v0/dbc/fz/subtraject/{id}/history": { "get": { "tags": [ "dbc.ggz.fz.Subtraject" ], "summary": "Return the (financial) value for a dbbc in a given moment in time", "operationId": "dbc.ggz.fz.SubtrajectAPI.getValueAt", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "reference_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.fz.Subtraject" } } } } }, "x-replacement-for": [ "/t/dbc/ggz/fz/subtrajecten/{id}/history" ] } }, "/v0/dbc/fz/subtraject/gesloten": { "get": { "tags": [ "dbc.ggz.fz.Subtraject" ], "summary": "Returns all the subtrajects that where closed within the given period.", "operationId": "dbc.ggz.fz.SubtrajectAPI.geslotenTrajectenV2", "parameters": [ { "name": "valid_from", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "include_all_registrations", "in": "query", "schema": { "type": "boolean" } }, { "name": "include_all_grouper_results", "in": "query", "schema": { "type": "boolean" } }, { "name": "only_afleidbare_registraties", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.fz.list.SubtrajectList" } } } } }, "x-replacement-for": [ "/t/dbc/ggz/fz/subtrajecten/gesloten" ] } }, "/v0/dbc/ggz/client/{client_id}/zorgtrajecten": { "get": { "tags": [ "dbc.ggz.Zorgtraject" ], "operationId": "dbc.ggz.ZorgtrajectAPI.byClient", "parameters": [ { "name": "client_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.list.ZorgtrajectList" } } } } }, "x-replacement-for": [ "/t/dbc/ggz/zorgtrajecten/by_client/{client_id}" ] } }, "/v0/dbc/ggz/jw/subtraject/gesloten": { "get": { "tags": [ "dbc.ggz.Subtraject" ], "summary": "Returns all the youth subtrajects that where closed within the given period.", "operationId": "dbc.ggz.SubtrajectAPI.geslotenJeugdTrajecten", "parameters": [ { "name": "valid_from", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.list.SubtrajectList" } } } } }, "x-replacement-for": [ "/t/dbc/ggz/jw/subtrajecten/gesloten" ] } }, "/v0/dbc/ggz/subtraject": { "get": { "tags": [ "dbc.ggz.Subtraject" ], "summary": "Fetches a number ('limit') of subtrajects that lay within the given time period.", "operationId": "dbc.ggz.SubtrajectAPI.all", "parameters": [ { "name": "valid_from", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "include_all_registrations", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "include_all_grouper_results", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "only_afleidbare_registraties", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.list.SubtrajectList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dbc/ggz/subtrajecten" ] } }, "/v0/dbc/ggz/subtraject/{id}": { "get": { "tags": [ "dbc.ggz.Subtraject" ], "summary": "Fetch a subtraject", "operationId": "dbc.ggz.SubtrajectAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Subtraject", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.Subtraject" } } } }, "404": { "description": "Subtraject not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.Subtraject" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dbc/ggz/subtrajecten/{id}" ] } }, "/v0/dbc/ggz/subtraject/{id}/history": { "get": { "tags": [ "dbc.ggz.Subtraject" ], "summary": "Return the (financial) value for a dbc in a given moment in time", "operationId": "dbc.ggz.SubtrajectAPI.getValueAt", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "reference_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.Subtraject" } } } }, "400": { "description": "Missing reference date", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.Subtraject" } } } } }, "x-replacement-for": [ "/t/dbc/ggz/subtrajecten/{id}/history" ] } }, "/v0/dbc/ggz/subtraject/{subtraject_id}/validation_errors": { "get": { "tags": [ "dbc.ggz.ValidationError" ], "summary": "Retrieve validation errors by subtrajectId.", "operationId": "dbc.ggz.ValidationErrorAPI.bySubtraject", "parameters": [ { "name": "subtraject_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.list.ValidationErrorList" } } } } }, "x-replacement-for": [ "/t/dbc/ggz/validation_errors/by_subtraject/{subtraject_id}" ] } }, "/v0/dbc/ggz/subtraject/gesloten": { "get": { "tags": [ "dbc.ggz.Subtraject" ], "summary": "Returns all the subtrajects that where closed within the given period.", "operationId": "dbc.ggz.SubtrajectAPI.geslotenTrajectenV2", "parameters": [ { "name": "valid_from", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "include_all_registrations", "in": "query", "schema": { "type": "boolean" } }, { "name": "include_all_grouper_results", "in": "query", "schema": { "type": "boolean" } }, { "name": "only_afleidbare_registraties", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.list.SubtrajectList" } } } } }, "x-replacement-for": [ "/t/dbc/ggz/subtrajecten/gesloten" ] } }, "/v0/dbc/ggz/subtraject/validation_errors": { "get": { "tags": [ "dbc.ggz.ValidationError" ], "summary": "Requires subtrajectIds.join('&').length < 2000\n\nRetrieve validation errors by multiple subtrajectIds.", "description": "Requires {@code subtrajectIds.join('&').length < 2000}\n\nRetrieve validation errors by multiple subtrajectIds.", "operationId": "dbc.ggz.ValidationErrorAPI.bySubtrajects", "parameters": [ { "name": "subtraject_ids", "in": "query", "required": false, "explode": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.list.ValidationErrorList" } } } } }, "x-replacement-for": [ "/t/dbc/ggz/validation_errors/by_subtrajects" ] } }, "/v0/dbc/ggz/zorgtraject": { "post": { "tags": [ "dbc.ggz.Zorgtraject" ], "summary": "Create Zorgtraject", "operationId": "dbc.ggz.ZorgtrajectAPI.create", "requestBody": { "description": "Zorgtraject to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.Zorgtraject" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.Zorgtraject" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dbc/ggz/zorgtrajecten" ] } }, "/v0/dbc/ggz/zorgtraject/{id}": { "get": { "tags": [ "dbc.ggz.Zorgtraject" ], "summary": "Fetch a zorgtraject", "operationId": "dbc.ggz.ZorgtrajectAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Zorgtraject", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.Zorgtraject" } } } }, "404": { "description": "Zorgtraject not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.Zorgtraject" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dbc/ggz/zorgtrajecten/{id}" ] } }, "/v0/dbc/ggz/zorgtraject/{zorgtraject_id}/diagnose_toekenningen": { "post": { "tags": [ "dbc.ggz.DiagnoseToekenning" ], "operationId": "dbc.ggz.DiagnoseToekenningAPI.createDiagnoseToekenningen", "parameters": [ { "name": "zorgtraject_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.list.DiagnoseToekenningList" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.list.DiagnoseToekenningList" } } } } }, "x-replacement-for": [ "/t/dbc/ggz/zorgtrajecten/{zorgtraject_id}/diagnose_toekenningen" ] }, "delete": { "tags": [ "dbc.ggz.DiagnoseToekenning" ], "summary": "Deletes diagnosis with a given externalid that belong to a given zorgtraject", "operationId": "dbc.ggz.DiagnoseToekenningAPI.deleteDiagnoseToekenningen", "parameters": [ { "name": "zorgtraject_id", "in": "path", "description": "the technical id of the zorgtraject where the diagnosis belongs to", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "external_id", "in": "query", "description": "the external id of the diagnosis to delete", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.list.DiagnoseToekenningList" } } } } }, "x-replacement-for": [ "/t/dbc/ggz/zorgtrajecten/{zorgtraject_id}/diagnose_toekenningen" ] } }, "/v0/dbc/presencelog_sync_error/{id}": { "get": { "tags": [ "dbc.ggz.PresenceLogSynchronisationError" ], "summary": "Fetch a synchronization error", "operationId": "dbc.ggz.PresenceLogSynchronisationErrorAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting PresenceLogSynchronisationError", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.PresenceLogSynchronisationError" } } } }, "404": { "description": "Error not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.PresenceLogSynchronisationError" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dbc/ggz/presencelog_sync_error/{id}" ] } }, "/v0/dbc/presencelog_sync_error/in_period": { "get": { "tags": [ "dbc.ggz.PresenceLogSynchronisationError" ], "summary": "Fetches a number ('limit') of presencelog syncrhonisation errors from ons-dbc having the creation date\nbetween validFrom and validTo and updatedAt set to within the last hour (to only fetch errors that are still relevant)", "operationId": "dbc.ggz.PresenceLogSynchronisationErrorAPI.byPeriod", "parameters": [ { "name": "valid_from", "in": "query", "description": "createdAt >= validFrom (start of day)", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "valid_to", "in": "query", "description": "createdAt <= validTo (end of day)", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "description": "number of results to return", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "offset", "in": "query", "description": "index of first result returned", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.list.PresenceLogSynchronisationErrorList" } } } } }, "x-replacement-for": [ "/t/dbc/ggz/presencelog_sync_error/in_period" ] } }, "/v0/dienst_verwijzen_module/cupido/fhir/r3/bundle_wrapper": { "post": { "tags": [ "dienst_verwijzen_module.BundleWrapper" ], "summary": "Create a new item using a FHIR R3 bundle wrapped in a json object", "description": "The bundle contains a single field `data` that contains serialized JSON. The success response has no body.", "operationId": "dienst_verwijzen_module.BundleWrapperAPI.createByWrapper", "requestBody": { "description": "BundleWrapper to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dienst_verwijzen_module.BundleWrapper" } } }, "required": true }, "responses": { "202": { "description": "Accepted" }, "400": { "description": "Missing bundle data, missing identifiers, or other validation errors that prevent the Bundle from being processed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Persistence conflict while storing the Bundle backup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "412": { "description": "Bundle processing precondition failed, for example when the customer code does not resolve to a tenant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "FHIR Bundle parse error or missing required FHIR Bundle element", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-replacement-for": [ "/t/dienst_verwijzen_module/cupido/fhir/r3/bundle_wrapper" ] } }, "/v0/dossier/back_channel/authorized/active_care_plan_metadata": { "get": { "tags": [ "dossier.ActiveCarePlanMetadata" ], "summary": "Returns active care plan metadata given the client ids.", "operationId": "dossier.ActiveCarePlanMetadataAPI.byClientIds", "parameters": [ { "name": "client_ids[]", "in": "query", "description": "The ids of the clients (client_ids[]=1&client_ids[]=2...)", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "x-original-parameter": { "name": "client_ids" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.ActiveCarePlanMetadata" } } } } }, "x-replacement-for": [ "/t/active_care_plan_metadata" ] } }, "/v0/dossier/back_channel/authorized/admin/alerts/topics": { "get": { "tags": [ "dossier.admin.alerts.Topic" ], "summary": "Get every topic", "operationId": "dossier.admin.alerts.TopicAPI.all", "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.admin.alerts.list.TopicList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/admin/alerts/topics" ] }, "post": { "tags": [ "dossier.admin.alerts.Topic" ], "summary": "Create an alert topic", "operationId": "dossier.admin.alerts.TopicAPI.create", "requestBody": { "description": "Topic to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.admin.alerts.Topic" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.admin.alerts.Topic" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/admin/alerts/topics" ] } }, "/v0/dossier/back_channel/authorized/admin/alerts/topics/{id}": { "get": { "tags": [ "dossier.admin.alerts.Topic" ], "summary": "Get a specific topic", "operationId": "dossier.admin.alerts.TopicAPI.byId", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.admin.alerts.Topic" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/admin/alerts/topics/{id}" ] }, "put": { "tags": [ "dossier.admin.alerts.Topic" ], "summary": "Update the given Topic", "operationId": "dossier.admin.alerts.TopicAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of Topic to update.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Topic to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.admin.alerts.Topic" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.admin.alerts.Topic" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/admin/alerts/topics/{id}" ] }, "delete": { "tags": [ "dossier.admin.alerts.Topic" ], "summary": "Deletes the Topic with given id", "operationId": "dossier.admin.alerts.TopicAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of Topic to delete.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "If successfully removed the problem" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/admin/alerts/topics/{id}" ] } }, "/v0/dossier/back_channel/authorized/alerts": { "post": { "tags": [ "dossier.Alert" ], "summary": "Create an alert", "operationId": "dossier.AlertAPI.create", "requestBody": { "description": "Alert to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Alert" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Alert" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/alerts" ] } }, "/v0/dossier/back_channel/authorized/alerts/{id}": { "get": { "tags": [ "dossier.Alert" ], "summary": "Get a specific Alert", "operationId": "dossier.AlertAPI.byId", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Alert" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/alerts/{id}" ] }, "put": { "tags": [ "dossier.Alert" ], "summary": "Update the given Alert", "operationId": "dossier.AlertAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of Alert to update.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Alert to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Alert" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Alert" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/alerts/{id}" ] } }, "/v0/dossier/back_channel/authorized/clients/{client_id}/last_medical_moments": { "get": { "tags": [ "dossier.LastMedicalMoment" ], "summary": "Returns LastMedicalMoment timestamps by client", "operationId": "dossier.LastMedicalMomentAPI.byClientId", "parameters": [ { "name": "client_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.LastMedicalMomentList" } } } } }, "x-replacement-for": [ "/t/dossier/clients/{client_id}/last_medical_moments" ] } }, "/v0/dossier/back_channel/authorized/clients/{client_id}/medical/propensities_to_adverse_reaction": { "get": { "tags": [ "dossier.medical.PropensityToAdverseReaction" ], "summary": "Returns allergies of the given client corresponding to the given id.", "operationId": "dossier.medical.PropensityToAdverseReactionAPI.byClientId", "parameters": [ { "name": "client_id", "in": "path", "description": "client_id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.list.PropensityToAdverseReactionList" } } } } }, "x-replacement-for": [ "/t/clients/{client_id}/medical/propensities_to_adverse_reaction" ] } }, "/v0/dossier/back_channel/authorized/clients/{client_id}/reports": { "post": { "tags": [ "dossier.Report" ], "summary": "Create Report.\nAuthorization is done in dossier controller this points to.", "operationId": "dossier.ReportAPI.authorizedCreate", "parameters": [ { "name": "client_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Report" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Report" } } } } }, "x-replacement-for": [ "/t/dossier/authorized/clients/{client_id}/reports" ] } }, "/v0/dossier/back_channel/authorized/clients/{client_id}/reports_with_actions": { "get": { "tags": [ "dossier.ReportWithActions" ], "summary": "Returns ReportsWithActions that have actions created by user or for user's expertise", "operationId": "dossier.ReportWithActionsAPI.reportsWithActions", "parameters": [ { "name": "client_id", "in": "path", "description": "The client id for which to get the registrations", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "created_by_user", "in": "query", "description": "True for the user's created reports, false for actions for my expertise", "required": true, "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "description": "Limit", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "Offset", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.ReportWithActionsList" } } } } }, "x-replacement-for": [ "/t/dossier/authorized/clients/{client_id}/reports_with_actions" ] } }, "/v0/dossier/back_channel/authorized/clients/{client_id}/reports/{report_id}": { "put": { "tags": [ "dossier.Report" ], "summary": "Update Report.\nAuthorization is done in dossier controller this points to.", "operationId": "dossier.ReportAPI.authorizedUpdate", "parameters": [ { "name": "client_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "report_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Report" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Report" } } } } }, "x-replacement-for": [ "/t/dossier/authorized/clients/{client_id}/reports/{report_id}" ] } }, "/v0/dossier/back_channel/authorized/clients/{client_id}/reports/search_by_client": { "get": { "tags": [ "dossier.Report" ], "summary": "Return Reports, filtered by params\nAuthorization is done in dossier controller this points to.", "operationId": "dossier.ReportAPI.authorizedSearchByClient", "parameters": [ { "name": "client_id", "in": "path", "description": "which we want to search reports for", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "keyword", "in": "query", "description": "a text search term", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "the type of information to filter on", "schema": { "$ref": "#/components/schemas/dossier.ReportFilter" } }, { "name": "education_id", "in": "query", "description": "filters on reports of which the author has a specific employee", "schema": { "type": "integer", "format": "int64" } }, { "name": "show_hidden", "in": "query", "description": "shows hidden reports only has effect for the author or application managers", "schema": { "type": "boolean" } }, { "name": "report_type", "in": "query", "description": "list of types to filter on", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "valid_from", "in": "query", "description": "start search date", "schema": { "type": "string" } }, { "name": "valid_to", "in": "query", "description": "end search date", "schema": { "type": "string" } }, { "name": "demand_id", "in": "query", "description": "filters on reports to include only those related to a specific demand", "schema": { "type": "integer", "format": "int64" } }, { "name": "entry_id", "in": "query", "description": "filters on reports to include only those related to a specific care plan entry", "schema": { "type": "integer", "format": "int64" } }, { "name": "episode_id", "in": "query", "description": "filters on reports to include only those related to a specific episode", "schema": { "type": "integer", "format": "int64" } }, { "name": "restrictive_measure_id", "in": "query", "description": "filters on reports to include only those related to a specific restrictictive measure", "schema": { "type": "integer", "format": "int64" } }, { "name": "report_types_with_comments", "in": "query", "description": "filters on reports that have comments", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "only_own_reports", "in": "query", "description": "filters on reports written by the user", "schema": { "type": "boolean" } }, { "name": "offset", "in": "query", "description": "number of results to skip", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "number of results for one call", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.ReportList" } } } } }, "x-replacement-for": [ "/t/dossier/authorized/clients/{client_id}/reports/search_by_client" ] } }, "/v0/dossier/back_channel/authorized/clients/{client_id}/reports/search_by_client_with_updated_since": { "get": { "tags": [ "dossier.Report" ], "summary": "Return Reports with updated since option, filtered by params\nAuthorization is done in dossier controller this points to.", "operationId": "dossier.ReportAPI.authorizedSearchByClientWithUpdatedSince", "parameters": [ { "name": "client_id", "in": "path", "description": "which we want to search reports for", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "keyword", "in": "query", "description": "a text search term", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "the type of information to filter on", "schema": { "$ref": "#/components/schemas/dossier.ReportFilter" } }, { "name": "education_id", "in": "query", "description": "filters on reports of which the author has a specific employee", "schema": { "type": "integer", "format": "int64" } }, { "name": "show_hidden", "in": "query", "description": "shows hidden reports only has effect for the author or application managers", "schema": { "type": "boolean" } }, { "name": "report_type", "in": "query", "description": "list of types to filter on", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "valid_from", "in": "query", "description": "start search date", "schema": { "type": "string" } }, { "name": "valid_to", "in": "query", "description": "end search date", "schema": { "type": "string" } }, { "name": "updated_since", "in": "query", "description": "filters reports by updatedat", "schema": { "type": "string" } }, { "name": "demand_id", "in": "query", "description": "filters on reports to include only those related to a specific demand", "schema": { "type": "integer", "format": "int64" } }, { "name": "entry_id", "in": "query", "description": "filters on reports to include only those related to a specific care plan entry", "schema": { "type": "integer", "format": "int64" } }, { "name": "episode_id", "in": "query", "description": "filters on reports to include only those related to a specific episode", "schema": { "type": "integer", "format": "int64" } }, { "name": "restrictive_measure_id", "in": "query", "description": "filters on reports to include only those related to a specific restrictictive measure", "schema": { "type": "integer", "format": "int64" } }, { "name": "report_types_with_comments", "in": "query", "description": "filters on reports that have comments", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "only_own_reports", "in": "query", "description": "filters on reports written by the user", "schema": { "type": "boolean" } }, { "name": "offset", "in": "query", "description": "number of results to skip", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "number of results for one call", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.ReportList" } } } } }, "x-replacement-for": [ "/t/dossier/authorized/clients/{client_id}/reports/search_by_client_with_updated_since" ] } }, "/v0/dossier/back_channel/authorized/clients/{client_id}/reports/vital_signs_reports": { "get": { "tags": [ "dossier.Report" ], "summary": "Lists vital signs from reports", "description": "Lists systolic, diastolic, pulse, saturation and temperature values from reports and It requires `DossierReportsModify` rights for the given client.", "operationId": "dossier.ReportAPI.vitalSignsReports", "parameters": [ { "name": "client_id", "in": "path", "description": "Client identifier", "required": true, "schema": { "type": "integer", "format": "int64" }, "example": "25" } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.ReportVitalSignList" } } } } }, "x-replacement-for": [ "/t/dossier/clients/{client_id}/reports/vital_signs_reports" ] } }, "/v0/dossier/back_channel/authorized/medical/propensities_to_adverse_reaction": { "post": { "tags": [ "dossier.medical.PropensityToAdverseReaction" ], "summary": "Creates allergy or propensity to adverse reaction of the given client", "operationId": "dossier.medical.PropensityToAdverseReactionAPI.create", "requestBody": { "description": "Allergy or propensity to adverse reaction to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.PropensityToAdverseReaction" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.PropensityToAdverseReaction" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/propensities_to_adverse_reaction" ] } }, "/v0/dossier/back_channel/authorized/medical/propensities_to_adverse_reaction/{id}": { "get": { "tags": [ "dossier.medical.PropensityToAdverseReaction" ], "summary": "Returns allergy of the given client corresponding to the given id.", "operationId": "dossier.medical.PropensityToAdverseReactionAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.PropensityToAdverseReaction" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/propensities_to_adverse_reaction/{id}" ] }, "put": { "tags": [ "dossier.medical.PropensityToAdverseReaction" ], "summary": "Updates allergy or propensity to adverse reaction of the given client", "operationId": "dossier.medical.PropensityToAdverseReactionAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Allergy or propensity to adverse reaction to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.PropensityToAdverseReaction" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.PropensityToAdverseReaction" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/propensities_to_adverse_reaction/{id}" ] }, "delete": { "tags": [ "dossier.medical.PropensityToAdverseReaction" ], "summary": "Deletes allergy of the given client corresponding to the given id.", "operationId": "dossier.medical.PropensityToAdverseReactionAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "If successfully removed the survey result" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/propensities_to_adverse_reaction/{id}" ] } }, "/v0/dossier/back_channel/authorized/reports/with_actions": { "get": { "tags": [ "dossier.Report" ], "summary": "Return reports that have actions created by user or for user's expertise", "operationId": "dossier.ReportAPI.withActions", "parameters": [ { "name": "my_actions", "in": "query", "description": "true for my created reports, false for actions for my expertise", "required": true, "schema": { "type": "boolean" } }, { "name": "location_id", "in": "query", "description": "optional filter by location", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "location_ids[]", "in": "query", "description": "optional filter by multiple locations", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "x-original-parameter": { "name": "location_ids" } }, { "name": "with_sub_locations", "in": "query", "description": "If true, includes the sub locations of the given locations. If false, does not include the sub locations. If nil: includes sublocations if location_id is given, excludes sublocations if location_ids are given (for backwards compatibility purposes)", "required": false, "schema": { "type": "boolean", "nullable": true } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.ReportList" } } } } }, "x-replacement-for": [ "/t/dossier/authorized/reports/with_actions" ] } }, "/v0/dossier/back_channel/authorized/reports/with_actions_summary": { "get": { "tags": [ "dossier.Report" ], "summary": "Return a count of reports that have actions created by user or for user's expertise", "operationId": "dossier.ReportAPI.withActionsSummary", "parameters": [ { "name": "location_id", "in": "query", "description": "optional filter by location", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "location_ids[]", "in": "query", "description": "optional filter by multiple locations", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "x-original-parameter": { "name": "location_ids" } }, { "name": "with_sub_locations", "in": "query", "description": "If true, includes the sub locations of the given locations. If false, does not include the sub locations. If nil: includes sublocations if location_id is given, excludes sublocations if location_ids are given (for backwards compatibility purposes)", "required": false, "schema": { "type": "boolean", "nullable": true } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.ReportsWithActionsSummary" } } } } }, "x-replacement-for": [ "/t/dossier/authorized/reports/with_actions_summary" ] } }, "/v0/dossier/back_channel/unauthorized/action_entry_summaries/last_by_persistent_ids": { "get": { "tags": [ "dossier.ActionEntrySummary" ], "summary": "Return the latest ActionEntrySummaries corresponding to the given persistentIds.", "description": "Return the latest action entry summaries by the given persistent ids.", "operationId": "dossier.ActionEntrySummaryAPI.lastByPersistentIds", "parameters": [ { "name": "persistent_ids[]", "in": "query", "description": "List of ids", "required": true, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "x-original-parameter": { "name": "persistent_ids" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.ActionEntrySummaryList" } } } }, "404": { "description": "No action entry summaries found for persistent ids", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-replacement-for": [ "/t/dossier/action_entry_summaries/last_by_persistent_ids" ] } }, "/v0/dossier/back_channel/unauthorized/alerts/{id}": { "get": { "tags": [ "dossier.Alert" ], "summary": "Get a specific Alert", "operationId": "dossier.AlertAPI.unauthorizedById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Alert" } } } } }, "x-replacement-for": [ "/t/dossier/unauthorized/alerts/{id}" ] } }, "/v0/dossier/back_channel/unauthorized/alerts/by_client_ids": { "get": { "tags": [ "dossier.Alert" ], "summary": "Get a specific Alert", "operationId": "dossier.AlertAPI.unauthorizedByClientIds", "parameters": [ { "name": "ids[]", "in": "query", "description": "The ids of the clients (ids[]=1&ids[]=2&ids[]=3...)", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "x-original-parameter": { "name": "ids" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.AlertList" } } } } }, "x-replacement-for": [ "/t/dossier/unauthorized/alerts/by_client_ids" ] } }, "/v0/dossier/back_channel/unauthorized/care_plan/{id}/agreement": { "get": { "tags": [ "dossier.CarePlanAgreement" ], "summary": "Find care plan agreement by id", "description": "Find care plan agreement by id", "operationId": "dossier.CarePlanAgreementAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting CarePlanAgreement", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.CarePlanAgreement" } } } }, "404": { "description": "Care plan agreement not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/care_plan_agreements/{id}" ] } }, "/v0/dossier/back_channel/unauthorized/care_plan/{id}/signature_requirement": { "get": { "tags": [ "dossier.CarePlanSignatureRequirement" ], "summary": "Find signature requirement by id", "description": "Find care plan signature requirement by id", "operationId": "dossier.CarePlanSignatureRequirementAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting CarePlanSignatureRequirement", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.CarePlanSignatureRequirement" } } } }, "404": { "description": "Care plan signature requirement not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/care_plan_signature_requirements/{id}" ] } }, "/v0/dossier/back_channel/unauthorized/care_plan/restrictive_measure_registrations": { "post": { "tags": [ "dossier.RestrictiveMeasureRegistration" ], "summary": "Create RestrictiveMeasureRegistration", "description": "Create restrictive measure registration", "operationId": "dossier.RestrictiveMeasureRegistrationAPI.create", "requestBody": { "description": "RestrictiveMeasureRegistration to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.RestrictiveMeasureRegistration" } } }, "required": true }, "responses": { "201": { "description": "Returns created restrictive measure registration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.RestrictiveMeasureRegistration" } } } }, "400": { "description": "Restrictive measure registration failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/restrictive_measure_registrations" ] } }, "/v0/dossier/back_channel/unauthorized/care_plan/restrictive_measure_registrations/{id}": { "put": { "tags": [ "dossier.RestrictiveMeasureRegistration" ], "summary": "Update RestrictiveMeasureRegistration", "description": "Update restrictive measure registration", "operationId": "dossier.RestrictiveMeasureRegistrationAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for updating RestrictiveMeasureRegistration", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "RestrictiveMeasureRegistration to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.RestrictiveMeasureRegistration" } } }, "required": true }, "responses": { "201": { "description": "Returns updated restrictive measure registration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.RestrictiveMeasureRegistration" } } } }, "400": { "description": "Restrictive measure registration failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/restrictive_measure_registrations/{id}" ] } }, "/v0/dossier/back_channel/unauthorized/care_plan/restrictive_measures": { "post": { "tags": [ "dossier.RestrictiveMeasureCarePlanEntry" ], "summary": "Create RestrictiveMeasureCarePlanEntry", "description": "Creates restrictive measure care plan entry. Client external id cannot be blank. Returns 500 for invalid date with xml and sets invalid date to nil for json.", "operationId": "dossier.RestrictiveMeasureCarePlanEntryAPI.create", "requestBody": { "description": "RestrictiveMeasureCarePlanEntry to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.RestrictiveMeasureCarePlanEntry" } } }, "required": true }, "responses": { "201": { "description": "Returns created restrictive measure care plan entry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.RestrictiveMeasureCarePlanEntry" } } } }, "400": { "description": "Client external id cannot be blank", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/restrictive_measure_care_plan_entries" ] } }, "/v0/dossier/back_channel/unauthorized/care_plan/restrictive_measures/{id}": { "get": { "tags": [ "dossier.RestrictiveMeasureCarePlanEntry" ], "summary": "Find restrictive measure care plan entry", "description": "Find restrictive measure care plan entry", "operationId": "dossier.RestrictiveMeasureCarePlanEntryAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting RestrictiveMeasureCarePlanEntry", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.RestrictiveMeasureCarePlanEntry" } } } }, "404": { "description": "Restrictive measure care plan entry not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/restrictive_measure_care_plan_entries/{id}" ] }, "put": { "tags": [ "dossier.RestrictiveMeasureCarePlanEntry" ], "summary": "Updates the given RestrictiveMeasureCarePlanEntry", "description": "Update restrictive measure care plan entry", "operationId": "dossier.RestrictiveMeasureCarePlanEntryAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting RestrictiveMeasureCarePlanEntry", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "RestrictiveMeasureCarePlanEntry to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.RestrictiveMeasureCarePlanEntry" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.RestrictiveMeasureCarePlanEntry" } } } }, "404": { "description": "Restrictive measure care plan entry not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/restrictive_measure_care_plan_entries/{id}" ] }, "delete": { "tags": [ "dossier.RestrictiveMeasureCarePlanEntry" ], "summary": "Deletes restrictive measure care plan entry by ID.", "description": "Deletes the restrictive measure care plan entry for the given ID.
\nNOTE: This operation permanently removes the restrictive measure care plan entry and all associated data including registrations, entries, evaluations and expertise documents.\nThis data is part of the export for the IGJ inspection. Deleting restrictive measure care plan entries before they have been properly exported may result in incomplete inspection data and potential compliance issues. Ensure all required exports have been completed before proceeding with deletion.\nUse with caution as this action cannot be undone.
", "operationId": "dossier.RestrictiveMeasureCarePlanEntryAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of RestrictiveMeasureCarePlanEntry to delete.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "Successfully removed the restrictive measure care plan entry" }, "404": { "description": "Restrictive measure care plan entry not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/restrictive_measure_care_plan_entries/{id}" ] }, "patch": { "tags": [ "dossier.RestrictiveMeasureCarePlanEntry" ], "summary": "Patches RestrictiveMeasureCarePlanEntry with given id", "operationId": "dossier.RestrictiveMeasureCarePlanEntryAPI.patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.RestrictiveMeasureCarePlanEntry" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.RestrictiveMeasureCarePlanEntry" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/restrictive_measure_care_plan_entries/{id}" ] } }, "/v0/dossier/back_channel/unauthorized/clients/{client_id}/care_plan/restrictive_measure_registrations": { "get": { "tags": [ "dossier.RestrictiveMeasureRegistration" ], "summary": "Get the registrations by client", "description": "Find restrictive measure registrations by client id. When the client is not found this will return an empty list.", "operationId": "dossier.RestrictiveMeasureRegistrationAPI.byClientId", "parameters": [ { "name": "client_id", "in": "path", "description": "The client id for which to get the registrations", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.RestrictiveMeasureRegistrationList" } } } } }, "x-replacement-for": [ "/t/dossier/clients/{client_id}/care_plan/restrictive_measure_registrations" ] } }, "/v0/dossier/back_channel/unauthorized/clients/{client_id}/care_plan/restrictive_measures": { "get": { "tags": [ "dossier.RestrictiveMeasureCarePlanEntry" ], "summary": "Return the restrictive measure care plan entries of a Client corresponding to the given id.", "description": "Finds the restrictive measure care plan entries of a client by the client id. Returns an empty array when client is not found.", "operationId": "dossier.RestrictiveMeasureCarePlanEntryAPI.byClientId", "parameters": [ { "name": "client_id", "in": "path", "description": "Client id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.RestrictiveMeasureCarePlanEntryList" } } } } }, "x-replacement-for": [ "/t/dossier/clients/{client_id}/care_plan/restrictive_measure_care_plan_entries" ] } }, "/v0/dossier/back_channel/unauthorized/clients/{client_id}/medical/advance_directives/contexts": { "get": { "tags": [ "dossier.medical.advance_directives.Context" ], "summary": "Return the contexts of a Client corresponding to the given id.", "operationId": "dossier.medical.advance_directives.ContextAPI.byClientId", "parameters": [ { "name": "client_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.advance_directives.list.ContextList" } } } } }, "x-replacement-for": [ "/t/clients/{client_id}/medical/advance_directives/contexts" ] } }, "/v0/dossier/back_channel/unauthorized/clients/{client_id}/medical/dsm/classification_series": { "get": { "tags": [ "dossier.medical.dsm.ClassificationSeries" ], "summary": "Gets the DSM classification series for the given client, optionally filtered by the care order that is linked to the series", "operationId": "dossier.medical.dsm.ClassificationSeriesAPI.byClientAndCareOrder", "parameters": [ { "name": "client_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "x-original-parameter": { "in": "query" } }, { "name": "care_order_id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "only_current", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.dsm.list.ClassificationSeriesList" } } } } }, "x-replacement-for": [ "/t/dossier/medical/dsm/classification_series" ] } }, "/v0/dossier/back_channel/unauthorized/clients/{client_id}/medical/involuntary_care/legal_statuses": { "get": { "tags": [ "dossier.medical.involuntary_care.LegalStatus" ], "summary": "Return the legal statuses of a Client corresponding to the given id.", "operationId": "dossier.medical.involuntary_care.LegalStatusAPI.byClientId", "parameters": [ { "name": "client_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.involuntary_care.list.LegalStatusList" } } } } }, "x-replacement-for": [ "/t/clients/{client_id}/medical/involuntary_care/legal_statuses" ] } }, "/v0/dossier/back_channel/unauthorized/clients/{client_id}/reports/unfiltered_search_by_client": { "get": { "tags": [ "dossier.Report" ], "summary": "Return Reports Unfiltered, filtered by params\nAuthorization is done in dossier controller this points to.", "operationId": "dossier.ReportAPI.authorizedUnfilteredSearchByClient", "parameters": [ { "name": "client_id", "in": "path", "description": "which we want to search reports for", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "keyword", "in": "query", "description": "a text search term", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "the type of information to filter on", "schema": { "$ref": "#/components/schemas/dossier.ReportFilter" } }, { "name": "education_id", "in": "query", "description": "filters on reports of which the author has a specific employee", "schema": { "type": "integer", "format": "int64" } }, { "name": "show_hidden", "in": "query", "description": "shows hidden reports only has effect for the author or application managers", "schema": { "type": "boolean" } }, { "name": "report_type", "in": "query", "description": "list of types to filter on", "required": true, "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "valid_from", "in": "query", "description": "start search date", "schema": { "type": "string" } }, { "name": "valid_to", "in": "query", "description": "end search date", "schema": { "type": "string" } }, { "name": "demand_id", "in": "query", "description": "filters on reports to include only those related to a specific demand", "schema": { "type": "integer", "format": "int64" } }, { "name": "entry_id", "in": "query", "description": "filters on reports to include only those related to a specific care plan entry", "schema": { "type": "integer", "format": "int64" } }, { "name": "episode_id", "in": "query", "description": "filters on reports to include only those related to a specific episode", "schema": { "type": "integer", "format": "int64" } }, { "name": "restrictive_measure_id", "in": "query", "description": "filters on reports to include only those related to a specific restrictictive measure", "schema": { "type": "integer", "format": "int64" } }, { "name": "report_types_with_comments", "in": "query", "description": "filters on reports that have comments", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "only_own_reports", "in": "query", "description": "filters on reports written by the user", "schema": { "type": "boolean" } }, { "name": "offset", "in": "query", "description": "number of results to skip", "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "number of results for one call", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.ReportList" } } } } }, "x-replacement-for": [ "/t/dossier/authorized/clients/{client_id}/reports/unfiltered_search_by_client" ] } }, "/v0/dossier/back_channel/unauthorized/episodes": { "post": { "tags": [ "dossier.episodes.Episode" ], "summary": "Create Episode", "operationId": "dossier.episodes.EpisodeAPI.create", "requestBody": { "description": "Episode to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.episodes.Episode" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.episodes.Episode" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/episodes/episodes" ] } }, "/v0/dossier/back_channel/unauthorized/episodes/{id}": { "get": { "tags": [ "dossier.episodes.Episode" ], "summary": "Gets the episode with the specified ID", "operationId": "dossier.episodes.EpisodeAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Episode", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.episodes.Episode" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/episodes/episodes/{id}" ] }, "put": { "tags": [ "dossier.episodes.Episode" ], "summary": "Updates the given Episode", "operationId": "dossier.episodes.EpisodeAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of Episode to update.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Episode to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.episodes.Episode" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.episodes.Episode" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/episodes/episodes/{id}" ] }, "patch": { "tags": [ "dossier.episodes.Episode" ], "summary": "Patches Episode with given id", "operationId": "dossier.episodes.EpisodeAPI.patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.episodes.Episode" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.episodes.Episode" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/episodes/episodes/{id}" ] } }, "/v0/dossier/back_channel/unauthorized/episodes/actions": { "post": { "tags": [ "dossier.episodes.Action" ], "summary": "Create Action", "operationId": "dossier.episodes.ActionAPI.create", "requestBody": { "description": "Action to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.episodes.Action" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.episodes.Action" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/episodes/actions" ] } }, "/v0/dossier/back_channel/unauthorized/episodes/actions/{id}": { "put": { "tags": [ "dossier.episodes.Action" ], "summary": "Updates the given Action", "operationId": "dossier.episodes.ActionAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of Action to update.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Action to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.episodes.Action" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.episodes.Action" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/episodes/actions/{id}" ] }, "patch": { "tags": [ "dossier.episodes.Action" ], "summary": "Patches Action with given id", "operationId": "dossier.episodes.ActionAPI.patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.episodes.Action" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.episodes.Action" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/episodes/actions/{id}" ] } }, "/v0/dossier/back_channel/unauthorized/episodes/actions/by_episode_id/{episode_id}": { "get": { "tags": [ "dossier.episodes.Action" ], "summary": "Gets all the actions for the specified episode ID", "operationId": "dossier.episodes.ActionAPI.byEpisodeId", "parameters": [ { "name": "episode_id", "in": "path", "description": "The ID of the episode for which to fetch actions", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.episodes.list.ActionList" } } } } }, "x-replacement-for": [ "/t/dossier/episodes/actions/by_episode_id/{episode_id}" ] } }, "/v0/dossier/back_channel/unauthorized/episodes/actions/by_sub_goal_id/{sub_goal_id}": { "get": { "tags": [ "dossier.episodes.Action" ], "summary": "Gets alls the actions for the specified episode sub goal ID", "operationId": "dossier.episodes.ActionAPI.bySubGoalId", "parameters": [ { "name": "sub_goal_id", "in": "path", "description": "The ID of the subgoal for which to fetch actions", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.episodes.list.ActionList" } } } } }, "x-replacement-for": [ "/t/dossier/episodes/actions/by_sub_goal_id/{sub_goal_id}" ] } }, "/v0/dossier/back_channel/unauthorized/episodes/by_client_id/{client_id}": { "get": { "tags": [ "dossier.episodes.Episode" ], "summary": "Gets all the episodes for the specified client ID", "operationId": "dossier.episodes.EpisodeAPI.byClientId", "parameters": [ { "name": "client_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.episodes.list.EpisodeList" } } } } }, "x-replacement-for": [ "/t/dossier/episodes/by_client_id/{client_id}" ] } }, "/v0/dossier/back_channel/unauthorized/episodes/sub_goals": { "post": { "tags": [ "dossier.episodes.SubGoal" ], "summary": "Create SubGoal", "operationId": "dossier.episodes.SubGoalAPI.create", "requestBody": { "description": "SubGoal to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.episodes.SubGoal" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.episodes.SubGoal" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/episodes/sub_goals" ] } }, "/v0/dossier/back_channel/unauthorized/episodes/sub_goals/{id}": { "put": { "tags": [ "dossier.episodes.SubGoal" ], "summary": "Updates the given SubGoal", "operationId": "dossier.episodes.SubGoalAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of SubGoal to update.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "SubGoal to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.episodes.SubGoal" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.episodes.SubGoal" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/episodes/sub_goals/{id}" ] }, "patch": { "tags": [ "dossier.episodes.SubGoal" ], "summary": "Patches SubGoal with given id", "operationId": "dossier.episodes.SubGoalAPI.patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.episodes.SubGoal" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.episodes.SubGoal" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/episodes/sub_goals/{id}" ] } }, "/v0/dossier/back_channel/unauthorized/episodes/sub_goals/by_episode_id/{episode_id}": { "get": { "tags": [ "dossier.episodes.SubGoal" ], "summary": "Gets all the sub goals for the specified episode ID", "operationId": "dossier.episodes.SubGoalAPI.byEpisodeId", "parameters": [ { "name": "episode_id", "in": "path", "description": "The ID of the episode for which to fetch SubGoals", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.episodes.list.SubGoalList" } } } } }, "x-replacement-for": [ "/t/dossier/episodes/sub_goals/by_episode_id/{episode_id}" ] } }, "/v0/dossier/back_channel/unauthorized/involuntary_care_export/entries": { "get": { "tags": [ "dossier.InvoluntaryCareExportEntry" ], "summary": "Get the involuntary care export entries for given parameters.", "operationId": "dossier.InvoluntaryCareExportEntryAPI.entries", "parameters": [ { "name": "law", "in": "query", "description": "the law for which to get the involuntary care entries: 1 (Wzd), 2 (Wvggz) or 3 (Jz plus)", "schema": { "type": "integer", "format": "int32" } }, { "name": "start", "in": "query", "description": "the start date of the export", "schema": { "type": "string", "format": "date" } }, { "name": "end", "in": "query", "description": "the end date of the export", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.list.InvoluntaryCareExportEntryList" } } } } }, "x-replacement-for": [ "/t/dossier/involuntary_care_export/entries" ] } }, "/v0/dossier/back_channel/unauthorized/medical/advance_directives/contexts": { "post": { "tags": [ "dossier.medical.advance_directives.Context" ], "summary": "Create Context", "operationId": "dossier.medical.advance_directives.ContextAPI.create", "requestBody": { "description": "Context to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.advance_directives.Context" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.advance_directives.Context" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/advance_directives/contexts" ] } }, "/v0/dossier/back_channel/unauthorized/medical/advance_directives/contexts/{id}": { "put": { "tags": [ "dossier.medical.advance_directives.Context" ], "summary": "Updates the given Context", "operationId": "dossier.medical.advance_directives.ContextAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of Context to update.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Context to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.advance_directives.Context" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.advance_directives.Context" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/advance_directives/contexts/{id}" ] }, "delete": { "tags": [ "dossier.medical.advance_directives.Context" ], "summary": "Deletes the Context with given id", "operationId": "dossier.medical.advance_directives.ContextAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of Context to delete.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "If successfully removed the context" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/advance_directives/contexts/{id}" ] }, "patch": { "tags": [ "dossier.medical.advance_directives.Context" ], "summary": "Patches Context with given id", "operationId": "dossier.medical.advance_directives.ContextAPI.patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.advance_directives.Context" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.advance_directives.Context" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/advance_directives/contexts/{id}" ] } }, "/v0/dossier/back_channel/unauthorized/medical/dsm/classification_series": { "post": { "tags": [ "dossier.medical.dsm.ClassificationSeries" ], "summary": "Create ClassificationSeries", "operationId": "dossier.medical.dsm.ClassificationSeriesAPI.create", "requestBody": { "description": "ClassificationSeries to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.dsm.ClassificationSeries" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.dsm.ClassificationSeries" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/dsm/classification_series" ] } }, "/v0/dossier/back_channel/unauthorized/medical/dsm/classification_series/{classification_series_id}/diagnosis_assignments": { "get": { "tags": [ "dossier.medical.dsm.ClassificationSeries" ], "summary": "Gets all the diagnosis assignments for the specified DSM classification series ID", "operationId": "dossier.medical.dsm.ClassificationSeriesAPI.diagnosisAssignments", "parameters": [ { "name": "classification_series_id", "in": "path", "description": "The ID of the DSM classification series to get diagnosis assignments for", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dbc.ggz.list.DiagnoseToekenningList" } } } } }, "x-replacement-for": [ "/t/dossier/medical/dsm/classification_series/{classification_series_id}/diagnosis_assignments" ] } }, "/v0/dossier/back_channel/unauthorized/medical/dsm/classification_series/{id}": { "get": { "tags": [ "dossier.medical.dsm.ClassificationSeries" ], "summary": "Gets the DSM classification series for the specified ID", "operationId": "dossier.medical.dsm.ClassificationSeriesAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting ClassificationSeries", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.dsm.ClassificationSeries" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/dsm/classification_series/{id}" ] } }, "/v0/dossier/back_channel/unauthorized/medical/dsm/classifications": { "get": { "tags": [ "dossier.medical.dsm.Classification" ], "summary": "Returns every Classification available from the ClassificationAPI", "operationId": "dossier.medical.dsm.ClassificationAPI.all", "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.dsm.list.ClassificationList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/dsm/classifications" ] } }, "/v0/dossier/back_channel/unauthorized/medical/dsm/classifications/{id}": { "get": { "tags": [ "dossier.medical.dsm.Classification" ], "summary": "Gets the DSM classification for the specified ID", "operationId": "dossier.medical.dsm.ClassificationAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting Classification", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.dsm.Classification" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/dsm/classifications/{id}" ] } }, "/v0/dossier/back_channel/unauthorized/medical/involuntary_care/incompetences": { "post": { "tags": [ "dossier.medical.involuntary_care.Incompetence" ], "summary": "Create Incompetence", "operationId": "dossier.medical.involuntary_care.IncompetenceAPI.create", "requestBody": { "description": "Incompetence to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.involuntary_care.Incompetence" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.involuntary_care.Incompetence" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/involuntary_care/incompetences" ] } }, "/v0/dossier/back_channel/unauthorized/medical/involuntary_care/incompetences/{id}": { "get": { "tags": [ "dossier.medical.involuntary_care.Incompetence" ], "summary": "Gets a Incompetence by specified identifier", "operationId": "dossier.medical.involuntary_care.IncompetenceAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of Incompetence to update.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.involuntary_care.Incompetence" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/involuntary_care/incompetences/{id}" ] }, "put": { "tags": [ "dossier.medical.involuntary_care.Incompetence" ], "summary": "Updates the given Incompetence", "operationId": "dossier.medical.involuntary_care.IncompetenceAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of Incompetence to update.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Incompetence to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.involuntary_care.Incompetence" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.involuntary_care.Incompetence" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/involuntary_care/incompetences/{id}" ] }, "delete": { "tags": [ "dossier.medical.involuntary_care.Incompetence" ], "summary": "Deletes the Incompetence with given id", "operationId": "dossier.medical.involuntary_care.IncompetenceAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of Incompetence to delete.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.involuntary_care.Incompetence" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/involuntary_care/incompetences/{id}" ] }, "patch": { "tags": [ "dossier.medical.involuntary_care.Incompetence" ], "summary": "Patches Incompetence with given id", "operationId": "dossier.medical.involuntary_care.IncompetenceAPI.patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.involuntary_care.Incompetence" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.involuntary_care.Incompetence" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/involuntary_care/incompetences/{id}" ] } }, "/v0/dossier/back_channel/unauthorized/medical/involuntary_care/legal_statuses": { "post": { "tags": [ "dossier.medical.involuntary_care.LegalStatus" ], "summary": "Create LegalStatus", "operationId": "dossier.medical.involuntary_care.LegalStatusAPI.create", "requestBody": { "description": "LegalStatus to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.involuntary_care.LegalStatus" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.involuntary_care.LegalStatus" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/involuntary_care/legal_statuses" ] } }, "/v0/dossier/back_channel/unauthorized/medical/involuntary_care/legal_statuses/{id}": { "get": { "tags": [ "dossier.medical.involuntary_care.LegalStatus" ], "summary": "Gets the legal status for the specified ID", "operationId": "dossier.medical.involuntary_care.LegalStatusAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "the id of the legal status", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.involuntary_care.LegalStatus" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/involuntary_care/legal_statuses/{id}" ] }, "put": { "tags": [ "dossier.medical.involuntary_care.LegalStatus" ], "summary": "Updates the given LegalStatus", "operationId": "dossier.medical.involuntary_care.LegalStatusAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of LegalStatus to update.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "LegalStatus to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.involuntary_care.LegalStatus" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.involuntary_care.LegalStatus" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/involuntary_care/legal_statuses/{id}" ] }, "delete": { "tags": [ "dossier.medical.involuntary_care.LegalStatus" ], "summary": "Deletes the legal status by ID.", "description": "Deletes the legal status for the given ID.\nNOTE: This operation permanently removes the legal status and all associated data including grounds, suspensions and documents.\nThis data is part of the export for the IGJ inspection. Deleting legal statuses before they have been properly exported may result in incomplete inspection data and potential compliance issues. Ensure all required exports have been completed before proceeding with deletion.\nUse with caution as this action cannot be undone.
", "operationId": "dossier.medical.involuntary_care.LegalStatusAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of LegalStatus to delete.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "Successfully removed the legal status" }, "404": { "description": "Legal status not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/involuntary_care/legal_statuses/{id}" ] }, "patch": { "tags": [ "dossier.medical.involuntary_care.LegalStatus" ], "summary": "Patches LegalStatus with given id", "operationId": "dossier.medical.involuntary_care.LegalStatusAPI.patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.involuntary_care.LegalStatus" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.involuntary_care.LegalStatus" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/involuntary_care/legal_statuses/{id}" ] } }, "/v0/dossier/back_channel/unauthorized/medical/medical_summaries/by_client_ids": { "get": { "tags": [ "dossier.medical.MedicalSummary" ], "summary": "Gets the medical summaries for the specified clients. The parameters determine what data should be included in the summary", "operationId": "dossier.medical.MedicalSummaryAPI.filteredByClientIds", "parameters": [ { "name": "problems", "in": "query", "schema": { "type": "boolean" } }, { "name": "incompetences", "in": "query", "schema": { "type": "boolean" } }, { "name": "allergies_and_adverse_reactions", "in": "query", "schema": { "type": "boolean" } }, { "name": "simplified_adverse_reactions", "in": "query", "schema": { "type": "boolean" } }, { "name": "medical_policy", "in": "query", "schema": { "type": "boolean" } }, { "name": "legal_status", "in": "query", "schema": { "type": "boolean" } }, { "name": "episodes", "in": "query", "schema": { "type": "boolean" } }, { "name": "resuscitation_decision", "in": "query", "schema": { "type": "boolean" } }, { "name": "alerts", "in": "query", "schema": { "type": "boolean" } }, { "name": "medical_notes", "in": "query", "schema": { "type": "boolean" } }, { "name": "id[]", "in": "query", "explode": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "x-original-parameter": { "name": "id" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.list.MedicalSummaryList" } } } } }, "x-replacement-for": [ "/t/dossier/medical/medical_summaries/by_client_ids" ] } }, "/v0/dossier/back_channel/unauthorized/medical/problems": { "post": { "tags": [ "dossier.medical.Problem" ], "summary": "Create Problem", "operationId": "dossier.medical.ProblemAPI.create", "requestBody": { "description": "Problem to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.Problem" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.Problem" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/problems" ] } }, "/v0/dossier/back_channel/unauthorized/medical/problems/{id}": { "get": { "tags": [ "dossier.medical.Problem" ], "summary": "Get a specific topic", "operationId": "dossier.medical.ProblemAPI.byId", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.Problem" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/problems/{id}" ] }, "put": { "tags": [ "dossier.medical.Problem" ], "summary": "Updates the given Problem", "operationId": "dossier.medical.ProblemAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of Problem to update.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Problem to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.Problem" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.Problem" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/problems/{id}" ] }, "delete": { "tags": [ "dossier.medical.Problem" ], "summary": "Deletes the Problem with given id", "operationId": "dossier.medical.ProblemAPI.delete", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of Problem to delete.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "If successfully removed the problem" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/problems/{id}" ] }, "patch": { "tags": [ "dossier.medical.Problem" ], "summary": "Patches Problem with given id", "operationId": "dossier.medical.ProblemAPI.patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.Problem" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.Problem" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/problems/{id}" ] } }, "/v0/dossier/back_channel/unauthorized/medical/simplified/propensities_to_adverse_reaction": { "put": { "tags": [ "dossier.medical.SimplifiedPropensityToAdverseReaction" ], "summary": "Updates the given SimplifiedPropensityToAdverseReaction", "operationId": "dossier.medical.SimplifiedPropensityToAdverseReactionAPI.update", "requestBody": { "description": "SimplifiedPropensityToAdverseReaction to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.SimplifiedPropensityToAdverseReaction" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.SimplifiedPropensityToAdverseReaction" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/simplified_propensity_to_adverse_reaction" ] }, "post": { "tags": [ "dossier.medical.SimplifiedPropensityToAdverseReaction" ], "summary": "Create SimplifiedPropensityToAdverseReaction", "operationId": "dossier.medical.SimplifiedPropensityToAdverseReactionAPI.create", "requestBody": { "description": "SimplifiedPropensityToAdverseReaction to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.SimplifiedPropensityToAdverseReaction" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.medical.SimplifiedPropensityToAdverseReaction" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/dossier/medical/simplified_propensity_to_adverse_reaction" ] } }, "/v0/dossier/back_channel/unauthorized/reports/by_next_dossier_report_link/{report_link_id}": { "get": { "tags": [ "dossier.Report" ], "summary": "Returns report by next dossier report link", "operationId": "dossier.ReportAPI.findByNextDossierReportLink", "parameters": [ { "name": "report_link_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dossier.Report" } } } } }, "x-replacement-for": [ "/t/dossier/reports/by_next_dossier_report_link/{report_link_id}" ] } }, "/v0/farmed_visie/message": { "post": { "tags": [ "fvc.FvcMessage" ], "summary": "Send a message to FVC", "operationId": "fvc.FvcMessageAPI.send", "requestBody": { "description": "Message to be sent to FVC", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fvc.FvcMessage" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fvc.FvcMessage" } } } }, "400": { "description": "Message could not be processed" } }, "x-replacement-for": [ "/t/fvc/message" ] } }, "/v0/finance/debtorGroups": { "get": { "tags": [ "finance.DebtorGroup" ], "summary": "Returns every DebtorGroup available from the DebtorGroupAPI", "description": "Returns every DebtorGroup available from the DebtorGroupAPI", "operationId": "finance.DebtorGroupAPI.all", "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.list.DebtorGroupList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/finance/debtor_groups" ] } }, "/v0/finance/debtorGroups/{id}": { "get": { "tags": [ "finance.DebtorGroup" ], "summary": "Retrieve debtor group by id", "description": "Retrieve debtor group by id", "operationId": "finance.DebtorGroupAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "used for selecting DebtorGroup", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.DebtorGroup" } } } }, "404": { "description": "Not found" } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/finance/debtor_groups/{id}" ] } }, "/v0/finance/debtorGroups/byDebtorId/{debtor_id}": { "get": { "tags": [ "finance.DebtorGroup" ], "summary": "Return a DebtorGroupsList for which holds that every DebtorGroup contains debtorId", "operationId": "finance.DebtorGroupAPI.byDebtorId", "parameters": [ { "name": "debtor_id", "in": "path", "description": "the debtorId that should fall in the returned debtor groups", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/finance.list.DebtorGroupList" } } } } }, "x-replacement-for": [ "/t/finance/debtor_groups/by_debtor_id/{debtor_id}" ] } }, "/v0/groupcare/clients/{client_id}/occurrences": { "get": { "tags": [ "groupcare.Occurrence" ], "summary": "Return the groupcare agenda occurrences of a Client corresponding to the given id.", "operationId": "groupcare.OccurrenceAPI.byClientId", "parameters": [ { "name": "client_id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "start_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "end_date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/groupcare.list.OccurrenceList" } } } } }, "x-replacement-for": [ "/t/clients/{client_id}/groupcare_agenda_occurrences" ] } }, "/v0/groupcare/groups": { "get": { "tags": [ "groupcare.Group" ], "summary": "Retrieves all groups that are not expired on the given date.", "description": "When the date query parameter is missing it returns\nthe groups that are active today.", "operationId": "groupcare.GroupAPI.all", "parameters": [ { "name": "date", "in": "query", "description": "date for which we want to query active groups", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/groupcare.list.GroupList" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/groupcare/groups" ] }, "post": { "tags": [ "groupcare.Group" ], "summary": "Create Groupcare Group", "operationId": "groupcare.GroupAPI.create", "requestBody": { "description": "to create in Groupcare", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/groupcare.Group" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/groupcare.Group" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/groupcare/groups" ] } }, "/v0/groupcare/groups/{id}": { "get": { "tags": [ "groupcare.Group" ], "summary": "Get GroupCare group by its identifier", "operationId": "groupcare.GroupAPI.byId", "parameters": [ { "name": "id", "in": "path", "description": "identifier of GroupCare Group to be found.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/groupcare.Group" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/groupcare/groups/{id}" ] }, "put": { "tags": [ "groupcare.Group" ], "summary": "Updates the given Groupcare Group", "operationId": "groupcare.GroupAPI.update", "parameters": [ { "name": "id", "in": "path", "description": "Identifier of Groupcare Group to update.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "to update in Groupcare", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/groupcare.Group" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/groupcare.Group" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/groupcare/groups/{id}" ] } }, "/v0/import/run": { "get": { "tags": [ "onsimport.Run" ], "summary": "Returns a list of all runs.", "operationId": "onsimport.RunAPI.getAll", "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onsimport.list.RunList" } } } } }, "x-replacement-for": [ "/t/onsimport/runs" ] }, "post": { "tags": [ "onsimport.Run" ], "summary": "Creates a new run.", "operationId": "onsimport.RunAPI.create", "requestBody": { "description": "contains information about the new run.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onsimport.Run" } } }, "required": true }, "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onsimport.Run" } } } } }, "x-cupido-common-method": true, "x-replacement-for": [ "/t/onsimport/runs" ] } }, "/v0/import/run/{run_id}": { "delete": { "tags": [ "onsimport.Run" ], "summary": "Deletes a run and any corresponding records, lookups, files and\nvalidations.", "description": "A run can only be deleted if no records have been\nsuccessfully imported (status = SUCCESS).", "operationId": "onsimport.RunAPI.delete", "parameters": [ { "name": "run_id", "in": "path", "description": "the id of the run to be deleted.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onsimport.Run" } } } } }, "x-replacement-for": [ "/t/onsimport/runs/{run_id}" ] } }, "/v0/import/run/{run_id}/idlist": { "get": { "tags": [ "onsimport.Run" ], "summary": "Requests generating an ID list for a run.", "description": "As the ID list will be generated asynchronously, this call will return a RunReport containing a reportId. Use the reportId to download the report in a separate call.", "operationId": "onsimport.RunAPI.getIdList", "parameters": [ { "name": "run_id", "in": "path", "description": "a run id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onsimport.RunReport" } } } } }, "x-replacement-for": [ "/t/onsimport/runs/{run_id}/idlist" ] } }, "/v0/import/run/{run_id}/report": { "get": { "tags": [ "onsimport.Run" ], "summary": "Requests generating a report for a run.", "description": "As the report will be generated\nasynchronously, this call will return a RunReport containing a reportId.\nUse the reportId to download the report in a separate call.", "operationId": "onsimport.RunAPI.getReport", "parameters": [ { "name": "run_id", "in": "path", "description": "a run id.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "No response was specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onsimport.RunReport" } } } } }, "x-replacement-for": [ "/t/onsimport/runs/{run_id}/report" ] } }, "/v0/import/run/{run_id}/report/{report_id}": { "get": { "tags": [ "onsimport.Run" ], "summary": "Returns a report for a run.", "description": "If the report is ready, it will be returned\nin the RunReport. Otherwise, the report field will benull;\nwait and try again. Reports will be available for a limited time\n(2 hours) after generating.",
"operationId": "onsimport.RunAPI.getGeneratedReport",
"parameters": [
{
"name": "run_id",
"in": "path",
"description": "a run id.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "report_id",
"in": "path",
"description": "a reportId that was obtained earlier.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/onsimport.RunReport"
}
}
}
}
},
"x-replacement-for": [
"/t/onsimport/runs/{run_id}/report/{report_id}"
]
}
},
"/v0/import/run/{run_id}/status": {
"get": {
"tags": [
"onsimport.Run"
],
"summary": "Returns status information about a run.",
"operationId": "onsimport.RunAPI.getStatus",
"parameters": [
{
"name": "run_id",
"in": "path",
"description": "a run id.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/onsimport.RunStatus"
}
}
}
}
},
"x-replacement-for": [
"/t/onsimport/runs/{run_id}/status"
]
}
},
"/v0/import/run/{run_id}/status/{upload_id}": {
"get": {
"tags": [
"onsimport.Run"
],
"summary": "Returns status information about a run, including any file validation\nmessages resulting from the file upload identified by uploadId.",
"operationId": "onsimport.RunAPI.getStatusForUpload",
"parameters": [
{
"name": "run_id",
"in": "path",
"description": "a run id.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "upload_id",
"in": "path",
"description": "an uploadId that was obtained earlier by uploading xml\n or a binary file.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/onsimport.RunStatus"
}
}
}
}
},
"x-replacement-for": [
"/t/onsimport/runs/{run_id}/status/{upload_id}"
]
}
},
"/v0/import/run/{run_id}/uploads": {
"get": {
"tags": [
"onsimport.Run"
],
"summary": "Returns uploaded files for the specified run.",
"operationId": "onsimport.RunAPI.getUploads",
"parameters": [
{
"name": "run_id",
"in": "path",
"description": "a run id.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/onsimport.list.UploadInfoList"
}
}
}
}
},
"x-replacement-for": [
"/t/onsimport/runs/{run_id}/uploads"
]
}
},
"/v0/import/run/{run_id}/validations": {
"get": {
"tags": [
"onsimport.Run"
],
"summary": "Returns all validation messages for the specified run.",
"operationId": "onsimport.RunAPI.getValidations",
"parameters": [
{
"name": "run_id",
"in": "path",
"description": "a run id.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "offset",
"in": "query",
"description": "number of results to skip",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "limit",
"in": "query",
"description": "number of results for one call",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/onsimport.list.ValidationList"
}
}
}
}
},
"x-replacement-for": [
"/t/onsimport/runs/{run_id}/validations"
]
}
},
"/v0/import/run/binary": {
"post": {
"tags": [
"onsimport.Run"
],
"summary": "Uploads a binary file to be processed by Ons Import.",
"description": "Refer to the\nOns Import documentation on how to incorporate these files into an\nimport. The upload will be processed asynchronously, so an\nuploadId is returned that can be used to poll for the status.",
"operationId": "onsimport.RunAPI.uploadBinaryFile",
"requestBody": {
"description": "a request object containing the run id and\n the binary file to be imported.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/onsimport.BinaryFileRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/onsimport.UploadResponse"
}
}
}
},
"404": {
"description": "Run not found"
}
},
"x-replacement-for": [
"/t/onsimport/runs/binary"
]
}
},
"/v0/import/run/xml": {
"post": {
"tags": [
"onsimport.Run"
],
"summary": "Uploads xml content to be processed by Ons Import.",
"description": "Documentation for\nthe xml format as well as an XSD can be obtained in the Ons Import\napplication. The upload will be processed asynchronously, so an\nuploadId is returned that can be used to poll for the status.",
"operationId": "onsimport.RunAPI.uploadXml",
"requestBody": {
"description": "a request object containing the run id and\n the xml to be imported.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/onsimport.RecordsXmlRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/onsimport.UploadResponse"
}
}
}
},
"404": {
"description": "Run not found"
}
},
"x-replacement-for": [
"/t/onsimport/runs/xml"
]
}
},
"/v0/ketenverkeer/fhir/r3/bundle_wrapper": {
"post": {
"tags": [
"harmony.ZorgdomeinFhirConnector"
],
"summary": "Create BundleWrapper",
"description": "The bundle contains a single field `data` that contains serialized JSON. The response is an empty JSON object.",
"operationId": "harmony.ZorgdomeinFhirConnectorAPI.create",
"requestBody": {
"description": "BundleWrapper to create",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/harmony.BundleWrapper"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/harmony.BundleWrapper"
}
}
}
},
"409": {
"description": "Validation errors or Bundle parse errors that prevent the Bundle to be processed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/harmony.JsonResponseDto"
}
}
}
},
"412": {
"description": "Bundle processing precondition failed (eg. wrong customer code as preferred identifier)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/harmony.BundleWrapper"
}
}
}
},
"422": {
"description": "Bundle parse error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/harmony.BundleWrapper"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/harmony.BundleWrapper"
}
}
}
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/harmony/zorgdomein/fhir/connector/bundle_wrapper"
]
}
},
"/v0/medewerkerportaal/employees/{employee_id}/employee_portal_profile": {
"get": {
"tags": [
"portal.EmployeePortalProfile"
],
"summary": "Return the employee portal profile of a employee corresponding to the given employee id.",
"operationId": "portal.EmployeePortalProfileAPI.byEmployeeId",
"parameters": [
{
"name": "employee_id",
"in": "path",
"description": "id",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/portal.EmployeePortalProfile"
}
}
}
}
},
"x-replacement-for": [
"/t/employees/{employee_id}/employee_portal_profile"
]
}
},
"/v0/medicatie_legacy/double_check_changes": {
"post": {
"tags": [
"medication.DoubleCheckChange"
],
"summary": "Create DoubleCheckChange",
"operationId": "medication.DoubleCheckChangeAPI.create",
"requestBody": {
"description": "DoubleCheckChange to create",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/medication.DoubleCheckChange"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/medication.DoubleCheckChange"
}
}
}
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/medication/double_check_changes"
]
}
},
"/v0/medicatie_legacy/double_checks/{uuid}": {
"get": {
"tags": [
"medication.DoubleCheck"
],
"operationId": "medication.DoubleCheckAPI.byId",
"parameters": [
{
"name": "uuid",
"in": "path",
"description": "used for selecting DoubleCheck",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/medication.DoubleCheck"
}
}
}
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/medication/double_checks/{uuid}"
]
}
},
"/v0/medicatie_legacy/medication_administrations": {
"get": {
"tags": [
"medication.MedicationAdministration"
],
"summary": "Fetch medication administrations for a client.",
"description": "Returns an array of medication administration records shaped somewhat according to the Medicatietoediening ZIB.\n\nIf no `status` parameter is provided, only medication administrations with a recorded status are included. Except if the medication administration was exempt or scheduled during client absence, in which case it is included regardless of its status.\n\nMedication administrations can only be fetched for today or past dates.",
"operationId": "medication.MedicationAdministrationAPI.getMedicationAdministrations",
"parameters": [
{
"name": "client_id",
"in": "query",
"description": "The technical id (IoServer objectId) of the client.",
"required": true,
"schema": {
"type": "integer",
"format": "int64",
"example": 940690340
}
},
{
"name": "status[]",
"in": "query",
"description": "Filters the results to only include medication administrations that have the provided status. Supports providing multiple options.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/medication.MedicationAdministrationStatus"
}
},
"example": [
"administered",
"handed"
]
},
{
"name": "date",
"in": "query",
"description": "Filters the results to only include medication administrations that are on the medication chart of the provided date.",
"required": true,
"schema": {
"type": "string",
"format": "date",
"example": "2026-05-21"
}
}
],
"responses": {
"200": {
"description": "A list of medication administrations matching the given parameters.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/medication.list.MedicationAdministrationList"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Unspecified internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-replacement-for": [
"/t/medication/medication_administrations"
]
}
},
"/v0/medicatie_legacy/medication_administrations/{id}": {
"get": {
"tags": [
"medication.MedicationAdministration"
],
"summary": "Fetch a medication administration.",
"description": "Returns a single medication administration.\n\nOnly medication administrations on the medication chart for today or past dates can be fetched.\n\nAn administration scheduled for a future date results in a `404 Not Found` response, even if the administration exists.\n\nA medication administration might be 'superseded'. This happens when a newer medication chart for the client on the day of the medication administration was received. If this is the case it is advised to use the `getMedicationAdministrations` operation to fetch a client’s actual medication administrations on a certain date.",
"operationId": "medication.MedicationAdministrationAPI.getMedicationAdministration",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the medication administration.",
"required": true,
"schema": {
"type": "integer",
"format": "int64",
"example": 2837
}
}
],
"responses": {
"200": {
"description": "A medication administration matching the given ID.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/medication.MedicationAdministration"
}
}
}
},
"404": {
"description": "Not Found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Unspecified internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-replacement-for": [
"/t/medication/medication_administrations/{id}"
]
}
},
"/v0/medicatie_legacy/medication_plan_overviews/current_week": {
"get": {
"tags": [
"medication.MedicationPlan"
],
"summary": "Returns information about current medication plans",
"description": "Returns all available `MedicationPlan`s for the current week.\nAs this is potentially a large list, cursor-based pagination is used.\nWhen the `Link` header is part of the response, continue fetching the next set of results using the provided URI in the header, until the response does not include the `Link` header anymore.",
"operationId": "medication.MedicationPlanAPI.currentWeekOverview",
"parameters": [
{
"name": "after",
"in": "query",
"description": "When no value is supplied, pagination starts from the beginning. Specifies the `client_id` from the last medication plan in the previous response for pagination.",
"required": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "List of medication plans was determined.",
"headers": {
"Link": {
"description": "Supports cursor-based pagination. Includes a link to use to fetch the next set of available medication plans.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/medication.list.MedicationPlanList"
}
}
}
},
"500": {
"description": "Unspecified internal error"
}
},
"x-replacement-for": [
"/t/medication/medication_plans/weeks/current"
]
}
},
"/v0/medicatie_legacy/medication_plan_overviews/next_week": {
"get": {
"tags": [
"medication.MedicationPlan"
],
"summary": "Returns information about upcoming medication plans",
"description": "Returns all available `MedicationPlan`s for the next week.\nAs this is potentially a large list, cursor-based pagination is used.\nWhen the `Link` header is part of the response, continue fetching the next set of results using the provided URI in the header, until the response does not include the `Link` header anymore.",
"operationId": "medication.MedicationPlanAPI.nextWeekOverview",
"parameters": [
{
"name": "after",
"in": "query",
"description": "When no value is supplied, pagination starts from the beginning. Specifies the `client_id` from the last medication plan in the previous response for pagination.",
"required": false,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "List of medication plans was determined.",
"headers": {
"Link": {
"description": "Supports cursor-based pagination. Includes a link to use to fetch the next set of available medication plans.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/medication.list.MedicationPlanList"
}
}
}
},
"500": {
"description": "Unspecified internal error"
}
},
"x-replacement-for": [
"/t/medication/medication_plans/weeks/next"
]
}
},
"/v0/medicatie_legacy/medication_plans/clients/{client_id}/weeks/{week}": {
"get": {
"tags": [
"medication.MedicationPlan"
],
"summary": "Fetch a medication plan",
"description": "Returns a PDF version of a medication plan for a specific client and week.\nThe `ETag` header is included in each response to save bandwidth. The next request using the same URI should include the value of the `ETag` header in the request header `If-None-Match`. The `ETag` (sent with `If-None-Match`) will be compared to the `ETag` of the current version of the medication plan and if both values match, a 304 `Not Modified` status, without a body, will be returned, meaning the cached version of the response is still good to use (fresh).",
"operationId": "medication.MedicationPlanAPI.getMedicationPlan",
"parameters": [
{
"name": "client_id",
"in": "path",
"description": "IoServer objectId of the client",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "week",
"in": "path",
"description": "The week for which the medication plan will be served",
"required": true,
"schema": {
"pattern": "^([0-9]{4})-W(5[0-3]|[1-4][0-9]|0[1-9])$",
"type": "string"
},
"example": "2023-W12"
},
{
"name": "If-None-Match",
"in": "header",
"description": "The unique identifier for the current version of the resource",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successfully served a medication plan",
"headers": {
"Etag": {
"description": "The version of this medication plan.",
"schema": {
"type": "string"
},
"example": "W/\"64f48878e1d02d32\""
},
"Download-path": {
"description": "Contains a suggested path to store the resource.\n First part is the name of the main location assigned to the client, or care provider name if main locations are disabled.\n Second part consists out of the client name and client id. ",
"schema": {
"type": "string"
},
"example": "goudbloem_de/janssen_hrja_mvr_239282"
},
"Digest-Sha1": {
"description": "Provides the SHA-1 hash of the message body for integrity verification.",
"schema": {
"type": "string"
},
"example": "fb47832c7ddec5db"
},
"Content-Disposition": {
"description": "Suggests the disposition of the content, including filename",
"schema": {
"type": "string"
},
"example": "attachment; filename=\"2023-W12.pdf\""
}
},
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"304": {
"description": "The medication plan was found but not modified.",
"headers": {
"ETag": {
"description": "The version of this list of medication plans.",
"schema": {
"type": "string"
},
"example": "W/\"64f48878e1d02d32\""
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"410": {
"description": "Given week is in the past",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Unspecified internal error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-replacement-for": [
"/t/medication/medication_plans/clients/{client_id}/weeks/{week}"
]
}
},
"/v0/mobile_backend/devices/by_device_code/{device_code}": {
"get": {
"tags": [
"milo.Device"
],
"summary": "Return the device based on device_code.",
"operationId": "milo.DeviceAPI.byDeviceCode",
"parameters": [
{
"name": "device_code",
"in": "path",
"description": "The device code of the device",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/milo.Device"
}
}
}
},
"404": {
"description": "Care provider or device not found"
}
},
"x-replacement-for": [
"/t/milo/devices/by_device_code/{device_code}"
]
}
},
"/v0/mobile_backend/devices/by_employee/{employee_id}": {
"get": {
"tags": [
"milo.Device"
],
"summary": "Return the devices of an Employee corresponding to the given id.",
"operationId": "milo.DeviceAPI.byEmployeeId",
"parameters": [
{
"name": "employee_id",
"in": "path",
"description": "id",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/milo.list.DeviceList"
}
}
}
}
},
"x-replacement-for": [
"/t/employees/{employee_id}/devices"
]
}
},
"/v0/mobile_backend/totp/by_employee/{employee_id}/request_totp": {
"get": {
"tags": [
"milo.Device"
],
"summary": "Request a one time password by employee.",
"description": "Request will be send to totp app(s) owned by employee to inform mobile to fetch a totp code.",
"operationId": "milo.DeviceAPI.requestOneTimePasswordByEmployee",
"parameters": [
{
"name": "employee_id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No content on GET method"
},
"400": {
"description": "Care provider not active, employee does not have a valid contract or no totp app."
},
"404": {
"description": "Employee not found"
}
},
"x-replacement-for": [
"/t/milo/totp/by_employee/{employee_id}/request_totp"
]
}
},
"/v0/mobile_backend/totp/by_employee/{employee_id}/verify_totp": {
"post": {
"tags": [
"milo.Device"
],
"summary": "Verify if one time password is valid by employee.",
"description": "Verifies if one time password entered by employee is the last unused one created for one of employees devices.",
"operationId": "milo.DeviceAPI.verifyOneTimePasswordByEmployee",
"parameters": [
{
"name": "employee_id",
"in": "path",
"description": "id of the employee",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "code",
"in": "query",
"description": "the Time-based One Time Password",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/milo.PasswordVerification"
}
}
}
},
"400": {
"description": "Care provider not active, employee does not have a valid contract or no totp app."
},
"404": {
"description": "Employee not found"
}
},
"x-replacement-for": [
"/t/milo/totp/by_employee/{employee_id}/verify_totp"
]
}
},
"/v0/mobile_backend/totp/request_totp": {
"get": {
"tags": [
"milo.Device"
],
"summary": "Request a one time password for the device which correspond with the device id.",
"operationId": "milo.DeviceAPI.requestOneTimePassword",
"parameters": [
{
"name": "device_id",
"in": "query",
"description": "id of the device",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No content on GET method"
},
"400": {
"description": "Employee does not have a valid totp app."
}
},
"deprecated": true,
"x-deprecated-since": "20-11-2023",
"x-replacement-for": [
"/t/milo/totp/request_totp"
]
}
},
"/v0/mobile_backend/totp/verify_totp": {
"post": {
"tags": [
"milo.Device"
],
"summary": "Verify if one time password is valid by device.",
"operationId": "milo.DeviceAPI.verifyOneTimePassword",
"parameters": [
{
"name": "device_id",
"in": "query",
"description": "id of the device",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "code",
"in": "query",
"description": "the Time-based One Time Password",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/milo.PasswordVerification"
}
}
}
}
},
"deprecated": true,
"x-deprecated-since": "20-11-2023",
"x-replacement-for": [
"/t/milo/totp/verify_totp"
]
}
},
"/v0/notification/care_provider_settings": {
"get": {
"tags": [
"hermes.CareProviderSettings"
],
"summary": "Retrieves the CareProviderSettings",
"operationId": "hermes.CareProviderSettingsAPI.get",
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/hermes.CareProviderSettings"
}
}
}
}
},
"x-replacement-for": [
"/t/hermes/care_provider_settings"
]
}
},
"/v0/notification/clients/{client_id}/contact_method": {
"get": {
"tags": [
"hermes.ContactMethod"
],
"summary": "Return the hermes contact method of a Client corresponding to the given id.",
"operationId": "hermes.ContactMethodAPI.byClientId",
"parameters": [
{
"name": "client_id",
"in": "path",
"description": "id",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/hermes.ContactMethod"
}
}
}
}
},
"x-replacement-for": [
"/t/clients/{client_id}/contact_method"
]
}
},
"/v0/notification/clients/{client_id}/contact_methods/set_primary_type": {
"post": {
"tags": [
"hermes.ContactMethod"
],
"summary": "Set primary contact method for client by given contact method type and enable/disable notifications for it.",
"operationId": "hermes.ContactMethodAPI.setPrimaryType",
"parameters": [
{
"name": "client_id",
"in": "path",
"description": "client id.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "object to set the client's notification settings.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/hermes.ContactMethodConfig"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/hermes.ContactMethod"
}
}
}
}
},
"x-replacement-for": [
"/t/clients/{client_id}/contact_methods/set_primary_type"
]
}
},
"/v0/notification/employees/{employee_id}/notifications": {
"get": {
"tags": [
"hermes.Notification"
],
"summary": "Return the hermes notifications of an Employee corresponding to the given id.",
"operationId": "hermes.NotificationAPI.byEmployeeId",
"parameters": [
{
"name": "employee_id",
"in": "path",
"description": "id",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/hermes.list.NotificationList"
}
}
}
}
},
"x-replacement-for": [
"/t/employees/{employee_id}/notifications"
]
}
},
"/v0/notification/notifications": {
"post": {
"tags": [
"hermes.Notification"
],
"summary": "Send a notification to an employee or user.",
"description": "There are 2 notification systems available, but /portal/notifications is deprecated since 28-10-2019, so you should not implement that one.\n When hermes (ons-notificaties) is activated notifications are received by this api.",
"operationId": "hermes.NotificationAPI.create",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/hermes.Notification"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/hermes.Notification"
}
}
}
},
"204": {
"description": "Duplicate notification UUID"
},
"422": {
"description": "Invalid UUID"
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/hermes/notifications"
]
}
},
"/v0/notification/notifications/{id}": {
"get": {
"tags": [
"hermes.Notification"
],
"operationId": "hermes.NotificationAPI.byId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "used for selecting Notification",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/hermes.Notification"
}
}
}
},
"404": {
"description": "Notification does not exist"
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/hermes/notifications/{id}"
]
}
},
"/v0/notification/notifications/by_uuid/{uuid}": {
"get": {
"tags": [
"hermes.Notification"
],
"operationId": "hermes.NotificationAPI.byUuid",
"parameters": [
{
"name": "uuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/hermes.Notification"
}
}
}
},
"404": {
"description": "Notification does not exist"
}
},
"x-replacement-for": [
"/t/hermes/notifications/by_uuid/{uuid}"
]
}
},
"/v0/omnisearch/client/search": {
"get": {
"tags": [
"Client"
],
"summary": "Client Search via Omnisearch",
"description": "Searches performed through this method are 'grouped' according to the groups defined in\ncom.nedap.healthcare.domain.ClientSearchResultGroup, which value is set on the\ncom.nedap.healthcare.domain.ClientSearchResult#group field",
"operationId": "ClientAPI.omnisearch",
"parameters": [
{
"name": "query",
"in": "query",
"description": "The string to search for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "employee_id",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
}
},
{
"name": "offset",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "include_waiting",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "include_out_of_care",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "on_date",
"in": "query",
"description": "The search will be performed for the given date (instead of now)",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "location_id",
"in": "query",
"description": "Limit the scope of search to within this location",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "X-Cupido-User-Name",
"in": "header",
"schema": {
"type": "string"
}
},
{
"name": "X-Cupido-Active-Identity",
"in": "header",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/list.ClientSearchResultList"
}
}
}
},
"403": {
"description": "No valid authentication"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal server error"
},
"503": {
"description": "Service unavailable"
}
},
"x-replacement-for": [
"/t/omnisearch/clients/searchresult"
]
}
},
"/v0/ons_nexus/client_contact_relation_types": {
"get": {
"tags": [
"nexus.ClientContactRelationType"
],
"summary": "Deprecated. Please use `/administration/client_contact_relation_types` instead.",
"operationId": "nexus.ClientContactRelationTypeAPI.all",
"parameters": [
{
"name": "offset",
"in": "query",
"description": "number of results to skip",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "limit",
"in": "query",
"description": "number of results for one call",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/nexus.list.ClientContactRelationTypeList"
}
}
}
}
},
"deprecated": true,
"x-cupido-common-method": true,
"x-deprecated-since": "12-05-2026",
"x-replacement-for": [
"/t/nexus/client_contact_relation_types"
]
}
},
"/v0/ons_nexus/client_contact_relation_types/{id}": {
"get": {
"tags": [
"nexus.ClientContactRelationType"
],
"summary": "Deprecated. Please use `/administration/client_contact_relation_types/{id}` instead.",
"operationId": "nexus.ClientContactRelationTypeAPI.byId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "used for selecting ClientContactRelationType",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/nexus.ClientContactRelationType"
}
}
}
}
},
"deprecated": true,
"x-cupido-common-method": true,
"x-deprecated-since": "12-05-2026",
"x-replacement-for": [
"/t/nexus/client_contact_relation_types/{id}"
]
}
},
"/v0/ons_nexus/client_employee_relation_types": {
"get": {
"tags": [
"nexus.ClientEmployeeRelationType"
],
"summary": "Deprecated. Please use `/administration/client_employee_relation_types` instead.",
"operationId": "nexus.ClientEmployeeRelationTypeAPI.all",
"parameters": [
{
"name": "offset",
"in": "query",
"description": "number of results to skip",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "limit",
"in": "query",
"description": "number of results for one call",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/nexus.list.ClientEmployeeRelationTypeList"
}
}
}
}
},
"deprecated": true,
"x-cupido-common-method": true,
"x-deprecated-since": "12-05-2026",
"x-replacement-for": [
"/t/nexus/client_employee_relation_types"
]
}
},
"/v0/ons_nexus/client_employee_relation_types/{id}": {
"get": {
"tags": [
"nexus.ClientEmployeeRelationType"
],
"summary": "Deprecated. Please use `/administration/client_employee_relation_types/{id}` instead.",
"operationId": "nexus.ClientEmployeeRelationTypeAPI.byId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "used for selecting ClientEmployeeRelationType",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/nexus.ClientEmployeeRelationType"
}
}
}
}
},
"deprecated": true,
"x-cupido-common-method": true,
"x-deprecated-since": "12-05-2026",
"x-replacement-for": [
"/t/nexus/client_employee_relation_types/{id}"
]
}
},
"/v0/ons_nexus/client_employee_relations": {
"post": {
"tags": [
"nexus.ClientEmployeeRelation"
],
"summary": "Deprecated. Please use `/administration/client_employee_relations` instead.",
"operationId": "nexus.ClientEmployeeRelationAPI.create",
"requestBody": {
"description": "ClientEmployeeRelation to create",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/nexus.ClientEmployeeRelation"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/nexus.ClientEmployeeRelation"
}
}
}
}
},
"deprecated": true,
"x-cupido-common-method": true,
"x-deprecated-since": "12-05-2026",
"x-replacement-for": [
"/t/nexus/client_employee_relations"
]
}
},
"/v0/ons_nexus/client_employee_relations/{id}": {
"get": {
"tags": [
"nexus.ClientEmployeeRelation"
],
"summary": "Deprecated. Please use `/administration/client_employee_relations/{id}` instead.",
"operationId": "nexus.ClientEmployeeRelationAPI.byId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "used for selecting ClientEmployeeRelation",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/nexus.ClientEmployeeRelation"
}
}
}
}
},
"deprecated": true,
"x-cupido-common-method": true,
"x-deprecated-since": "12-05-2026",
"x-replacement-for": [
"/t/nexus/client_employee_relations/{id}"
]
},
"put": {
"tags": [
"nexus.ClientEmployeeRelation"
],
"summary": "Deprecated. Please use `/administration/client_employee_relations/{id}` instead.",
"operationId": "nexus.ClientEmployeeRelationAPI.update",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifier of ClientEmployeeRelation to update.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "ClientEmployeeRelation to update",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/nexus.ClientEmployeeRelation"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/nexus.ClientEmployeeRelation"
}
}
}
}
},
"deprecated": true,
"x-cupido-common-method": true,
"x-deprecated-since": "12-05-2026",
"x-replacement-for": [
"/t/nexus/client_employee_relations/{id}"
]
},
"delete": {
"tags": [
"nexus.ClientEmployeeRelation"
],
"summary": "Deprecated. Please use `/administration/client_employee_relations/{id}` instead.",
"operationId": "nexus.ClientEmployeeRelationAPI.delete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifier of ClientEmployeeRelation to delete.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "If successfully removed the client employee relation"
}
},
"deprecated": true,
"x-cupido-common-method": true,
"x-deprecated-since": "12-05-2026",
"x-replacement-for": [
"/t/nexus/client_employee_relations/{id}"
]
}
},
"/v0/ons_nexus/clients/{client_id}/client_employee_relations": {
"get": {
"tags": [
"nexus.ClientEmployeeRelation"
],
"summary": "Deprecated. Please use `/administration/clients/{client_id}/client_employee_relations` instead.",
"operationId": "nexus.ClientEmployeeRelationAPI.byClientId",
"parameters": [
{
"name": "client_id",
"in": "path",
"description": "id",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "valid_from",
"in": "query",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "valid_to",
"in": "query",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "offset",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/nexus.list.ClientEmployeeRelationList"
}
}
}
}
},
"deprecated": true,
"x-deprecated-since": "12-05-2026",
"x-replacement-for": [
"/t/clients/{client_id}/client_employee_relations"
]
}
},
"/v0/ons_nexus/employees/{employee_id}/client_employee_relations": {
"get": {
"tags": [
"nexus.ClientEmployeeRelation"
],
"summary": "Deprecated. Please use `/administration/employees/{employee_id}/client_employee_relations` instead.",
"operationId": "nexus.ClientEmployeeRelationAPI.byEmployeeId",
"parameters": [
{
"name": "employee_id",
"in": "path",
"description": "id",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "valid_from",
"in": "query",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "valid_to",
"in": "query",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "offset",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/nexus.list.ClientEmployeeRelationList"
}
}
}
}
},
"deprecated": true,
"x-deprecated-since": "12-05-2026",
"x-replacement-for": [
"/t/employees/{employee_id}/client_employee_relations"
]
}
},
"/v0/ons_nexus/organisation_categories": {
"get": {
"tags": [
"nexus.OrganisationCategory"
],
"summary": "Returns every OrganisationCategory available from the OrganisationCategoryAPI",
"operationId": "nexus.OrganisationCategoryAPI.all",
"parameters": [
{
"name": "offset",
"in": "query",
"description": "number of results to skip",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "limit",
"in": "query",
"description": "number of results for one call",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/nexus.list.OrganisationCategoryList"
}
}
}
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/nexus/organisation_categories"
]
}
},
"/v0/ons_nexus/organisation_categories/{id}": {
"get": {
"tags": [
"nexus.OrganisationCategory"
],
"operationId": "nexus.OrganisationCategoryAPI.byId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "used for selecting OrganisationCategory",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/nexus.OrganisationCategory"
}
}
}
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/nexus/organisation_categories/{id}"
]
}
},
"/v0/ons_nexus/personal_relation_types": {
"get": {
"tags": [
"nexus.PersonalRelationType"
],
"summary": "Deprecated. Please use `/administration/personal_relation_types` instead.",
"operationId": "nexus.PersonalRelationTypeAPI.all",
"parameters": [
{
"name": "offset",
"in": "query",
"description": "number of results to skip",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "limit",
"in": "query",
"description": "number of results for one call",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/nexus.list.PersonalRelationTypeList"
}
}
}
}
},
"deprecated": true,
"x-cupido-common-method": true,
"x-deprecated-since": "12-05-2026",
"x-replacement-for": [
"/t/nexus/personal_relation_types"
]
}
},
"/v0/ons_nexus/personal_relation_types/{id}": {
"get": {
"tags": [
"nexus.PersonalRelationType"
],
"summary": "Deprecated. Please use `/administration/personal_relation_types/{id}` instead.",
"operationId": "nexus.PersonalRelationTypeAPI.byId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "used for selecting PersonalRelationType",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/nexus.PersonalRelationType"
}
}
}
}
},
"deprecated": true,
"x-cupido-common-method": true,
"x-deprecated-since": "12-05-2026",
"x-replacement-for": [
"/t/nexus/personal_relation_types/{id}"
]
}
},
"/v0/openehr_db/unauthorized/cupido/employee_groups/{id}": {
"get": {
"tags": [
"openehr.EmployeeGroup"
],
"summary": "Returns the employee group corresponding to the given id, including direct parent and child groups",
"operationId": "openehr.EmployeeGroupAPI.byId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the employee group",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Employee group corresponding to the given id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.EmployeeGroup"
}
}
}
},
"404": {
"description": "Employee group not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/openehr/employee_groups/{id}"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/archetype_wrappers": {
"get": {
"tags": [
"openehr.ArchetypeWrapper"
],
"summary": "Finds a list of all archetypeWrappers in the requested format, filtering by archetypeId.",
"operationId": "openehr.ArchetypeWrapperAPI.all",
"parameters": [
{
"name": "archetype_form",
"in": "query",
"description": "Format of the serialized archetypes. (Requires to be {@link ArchetypeForm#METADATA}.)",
"required": true,
"schema": {
"$ref": "#/components/schemas/openehr.ArchetypeForm"
}
},
{
"name": "archetype_id",
"in": "query",
"description": "Id of the archetype to filter by. May have partial version information e.g. openEHR-EHR-COMPOSITION.barthel.v2",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.list.ArchetypeWrapperList"
}
}
}
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/openehr/archetype_wrappers"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/archetype_wrappers/{id}": {
"get": {
"tags": [
"openehr.ArchetypeWrapper"
],
"summary": "Finds an archetypeWrapper by archetypeId in the requested format",
"operationId": "openehr.ArchetypeWrapperAPI.byId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the archetype, f.e. openEHR-EHR-COMPOSITION.barthel.v2.0.0",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "archetype_form",
"in": "query",
"description": "Format of the serialized archetype. (Use {@link ArchetypeForm#METADATA} to avoid fetching large JSON blobs.)",
"required": true,
"schema": {
"$ref": "#/components/schemas/openehr.ArchetypeForm"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.ArchetypeWrapper"
}
}
}
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/openehr/archetype_wrappers/{id}"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/archetype_wrappers/creatable": {
"get": {
"tags": [
"openehr.ArchetypeWrapper"
],
"summary": "Finds a list of archetypeWrappers that are creatable",
"operationId": "openehr.ArchetypeWrapperAPI.creatable",
"parameters": [
{
"name": "archetype_form",
"in": "query",
"description": "Format of the serialized archetypes. (Requires to be {@link ArchetypeForm#METADATA}.)",
"required": true,
"schema": {
"$ref": "#/components/schemas/openehr.ArchetypeForm"
}
},
{
"name": "module_uuid[]",
"in": "query",
"description": "Module UUID(s) of the requested archetypes. When provided, only metadata of archetypes assigned to the module are returned.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "string",
"example": "adc5ab71-364a-4661-ae51-586f781b1910"
}
},
"x-original-parameter": {
"name": "module_uuid"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.list.ArchetypeWrapperList"
}
}
}
}
},
"x-replacement-for": [
"/t/openehr/archetype_wrappers/creatable"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/archetype_wrappers/creatable/current_versions": {
"get": {
"tags": [
"openehr.ArchetypeWrapper"
],
"summary": "Finds a list of archetypeWrappers that are the creatable current versions",
"operationId": "openehr.ArchetypeWrapperAPI.creatableCurrentVersions",
"parameters": [
{
"name": "archetype_form",
"in": "query",
"description": "Format of the serialized archetypes. (Requires to be {@link ArchetypeForm#METADATA}.)",
"required": true,
"schema": {
"$ref": "#/components/schemas/openehr.ArchetypeForm"
}
},
{
"name": "module_uuid[]",
"in": "query",
"description": "Module UUID(s) of the requested archetypes. When provided, only metadata of archetypes assigned to the module are returned.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "string",
"example": "adc5ab71-364a-4661-ae51-586f781b1910"
}
},
"x-original-parameter": {
"name": "module_uuid"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.list.ArchetypeWrapperList"
}
}
}
}
},
"x-replacement-for": [
"/t/openehr/archetype_wrappers/creatable/current_versions"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/archetype_wrappers/for_client/{client_id}": {
"get": {
"tags": [
"openehr.ArchetypeWrapper"
],
"summary": "Finds a list of archetypeWrappers for a given client id",
"operationId": "openehr.ArchetypeWrapperAPI.forClient",
"parameters": [
{
"name": "client_id",
"in": "path",
"description": "id of the client",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "archetype_form",
"in": "query",
"description": "Format of the serialized archetypes. (Requires to be {@link ArchetypeForm#METADATA}.)",
"required": true,
"schema": {
"$ref": "#/components/schemas/openehr.ArchetypeForm"
}
},
{
"name": "module_uuid[]",
"in": "query",
"description": "UUID's of modules that the requested archetypes should belong to",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"x-original-parameter": {
"name": "module_uuid"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.list.ArchetypeWrapperList"
}
}
}
}
},
"x-replacement-for": [
"/t/openehr/archetype_wrappers/for_client/{client_id}"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/clients/{client_id}/navigation_availabilities": {
"get": {
"tags": [
"ons_ehr.NavigationAvailability"
],
"summary": "Get available navigation keys for the given client",
"operationId": "ons_ehr.NavigationAvailabilityAPI.byClient",
"parameters": [
{
"name": "client_id",
"in": "path",
"description": "The ID of the client",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "The navigation abilities of the requested navigation items",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ons_ehr.list.NavigationAvailabilityList"
}
}
}
}
},
"x-replacement-for": [
"/t/ons_ehr/api/back_channel/unauthorized/clients/{client_id}/navigation_availabilities"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/clients/by_archetype_id/{archetype_id}": {
"get": {
"tags": [
"Client"
],
"summary": "Returns the clients (but only the client ids) who have data for the given archetype in the given period.",
"description": "When querying\nan archetype id, this also returns clients with data for subversions of that archetype id.\n\nFor example openEHR-EHR-COMPOSITION.berg_balance_scale_report.v1 returns clients with data for\nopenEHR-EHR-COMPOSITION.berg_balance_scale_report.v1.0.2 and openEHR-EHR-COMPOSITION.berg_balance_scale_report.v1.5.0,\nbut not for openEHR-EHR-COMPOSITION.berg_balance_scale_report.v2.0.0.\n\nThis will take into account data with lifecycle state COMPLETE and INCOMPLETE, but not DELETED.",
"operationId": "ClientAPI.allByArchetypeId",
"parameters": [
{
"name": "archetype_id",
"in": "path",
"description": "- archetype id can contain the archetype concept plus any precision of the version, like v1 or v1.1.1",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "valid_from",
"in": "query",
"description": "- begin date of the period",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "valid_to",
"in": "query",
"description": "- end date of the period",
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/list.ClientList"
}
}
}
}
},
"x-replacement-for": [
"/t/openehr/clients/by_archetype_id/{archetype_id}"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers": {
"get": {
"tags": [
"openehr.CompositionWrapper"
],
"summary": "Finds all CompositionWrappers of all clients that are an instance of the given archetypeId.",
"description": "This API supports pagination by using limit, and by default will only return the 20 most recent results.",
"operationId": "openehr.CompositionWrapperAPI.all",
"parameters": [
{
"name": "client_id",
"in": "query",
"description": "The client id",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "archetype_id",
"in": "query",
"description": "Id of the archetype that the requested compositions should be an instance of",
"schema": {
"type": "string"
}
},
{
"name": "reference_model_object_form",
"in": "query",
"description": "The requested form of the compositions. The options are:\n* **METADATA**: Return only the metadata. `referenceModelObject` and `pathsAndValues` will be empty.\n* **PATHS_AND_VALUES**: Return the `pathsAndValues`. `referenceModelObject` will be empty.\n* **RM_OBJECT**: Return the `referenceModelObject` in the older Nedap specific JSON format. Matches `ArchieJacksonConfiguration.createLegacyConfiguration` in the Archie library. `pathsAndValues` will be empty.\n* **RM_OBJECT_STANDARDS_COMPLIANT_JSON**: Return the `referenceModelObject` compliant with the openEHR JSON specification. Matches `ArchieJacksonConfiguration.createStandardsCompliant` in the Archie library. `pathsAndValues` will be empty.",
"required": true,
"schema": {
"$ref": "#/components/schemas/openehr.ReferenceModelObjectForm"
}
},
{
"name": "with_incomplete",
"in": "query",
"description": "Set to true to also include compositions with lifecycleState INCOMPLETE. By default only compositions with lifecycleState COMPLETE are included.",
"schema": {
"type": "boolean"
}
},
{
"name": "limit",
"in": "query",
"description": "Limits the number of results returned",
"schema": {
"maximum": 10000,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "offset",
"in": "query",
"description": "Offsets the number of records of the first result.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "valid_from",
"in": "query",
"description": "Starting time",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "valid_to",
"in": "query",
"description": "End time",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "updated_since",
"in": "query",
"description": "Fetch only the compositions that were updated on or after the given date",
"schema": {
"type": "string",
"format": "local-date-time"
},
"example": "2014-12-29T00:00:00"
},
{
"name": "item_tag_key[]",
"in": "query",
"description": "Fetch only the compositions associated with any of the provided item tag keys",
"required": false,
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"x-original-parameter": {
"name": "item_tag_key"
}
},
{
"name": "module_uuid[]",
"in": "query",
"description": "UUID's of modules that the archetypes of the requested compositions should belong to",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"x-original-parameter": {
"name": "module_uuid"
}
},
{
"name": "with_abandoned",
"in": "query",
"description": "Set to true to also include compositions with lifecycleState ABANDONED. By default only compositions with lifecycleState COMPLETE are included.",
"schema": {
"type": "boolean"
}
},
{
"name": "with_inactive",
"in": "query",
"description": "Set to true to also include compositions with lifecycleState INACTIVE. By default only compositions with lifecycleState COMPLETE are included.",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.list.CompositionWrapperList"
}
}
}
},
"400": {
"description": "Limit exceeds bounds (1-10000)"
},
"404": {
"description": "When the clientId does not exist"
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/openehr/composition_wrappers",
"/t/openehr/composition_wrappers/all"
]
},
"post": {
"tags": [
"openehr.CompositionWrapper"
],
"summary": "Create CompositionWrapper",
"description": "Composition data can be provided by means of either paths and values or ReferenceModelObject. A provided ReferenceModelObject will be deserialized using the standard-compliant Jackson deserializer.",
"operationId": "openehr.CompositionWrapperAPI.createV2",
"parameters": [
{
"name": "reference_model_object_form",
"in": "query",
"description": "The requested form of the composition. The default value is PATHS_AND_VALUES. The options are:\n* **METADATA**: Return only the metadata. `referenceModelObject` and `pathsAndValues` will be empty.\n* **PATHS_AND_VALUES**: Return the `pathsAndValues`. `referenceModelObject` will be empty.\n* **RM_OBJECT**: Return the `referenceModelObject` in the older Nedap specific JSON format. Matches `ArchieJacksonConfiguration.createLegacyConfiguration` in the Archie library. `pathsAndValues` will be empty.\n* **RM_OBJECT_STANDARDS_COMPLIANT_JSON**: Return the `referenceModelObject` compliant with the openEHR JSON specification. Matches `ArchieJacksonConfiguration.createStandardsCompliant` in the Archie library. `pathsAndValues` will be empty.",
"required": false,
"schema": {
"$ref": "#/components/schemas/openehr.ReferenceModelObjectForm"
}
}
],
"requestBody": {
"description": "CompositionWrapper to create",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.CompositionWrapper"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.CompositionWrapper"
}
}
}
},
"400": {
"description": "When the composition could not be created because it failed validation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.CompositionValidationErrorResponse"
}
}
}
}
},
"x-replacement-for": [
"/t/openehr/composition_wrappers"
]
},
"delete": {
"tags": [
"openehr.CompositionWrapper"
],
"summary": "Deletes multiple Compositions by given id's",
"operationId": "openehr.CompositionWrapperAPI.deleteMultiple",
"parameters": [
{
"name": "id[]",
"in": "query",
"description": "A list with Identifiers of CompositionWrappers to delete",
"required": true,
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"x-original-parameter": {
"name": "id"
}
}
],
"responses": {
"204": {
"description": "Deleted"
},
"404": {
"description": "When one or more compositions do not exist or are deleted"
}
},
"x-replacement-for": [
"/t/openehr/composition_wrappers"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/{id}": {
"get": {
"tags": [
"openehr.CompositionWrapper"
],
"summary": "Finds a compositionWrapper in the requested form",
"operationId": "openehr.CompositionWrapperAPI.byId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the composition",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "reference_model_object_form",
"in": "query",
"description": "The requested form of the composition. The options are:\n* **METADATA**: Return only the metadata. `referenceModelObject` and `pathsAndValues` will be empty.\n* **PATHS_AND_VALUES**: Return the `pathsAndValues`. `referenceModelObject` will be empty.\n* **RM_OBJECT**: Return the `referenceModelObject` in the older Nedap specific JSON format. Matches `ArchieJacksonConfiguration.createLegacyConfiguration` in the Archie library. `pathsAndValues` will be empty.\n* **RM_OBJECT_STANDARDS_COMPLIANT_JSON**: Return the `referenceModelObject` compliant with the openEHR JSON specification. Matches `ArchieJacksonConfiguration.createStandardsCompliant` in the Archie library. `pathsAndValues` will be empty.",
"required": true,
"schema": {
"$ref": "#/components/schemas/openehr.ReferenceModelObjectForm"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.CompositionWrapper"
}
}
}
},
"404": {
"description": "When the composition does not exist or is deleted"
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/openehr/composition_wrappers/{id}"
]
},
"put": {
"tags": [
"openehr.CompositionWrapper"
],
"summary": "Updates the given CompositionWrapper",
"description": "Updated composition data can be provided by means of either paths and values or ReferenceModelObject. A provided ReferenceModelObject will be deserialized using the standard-compliant Jackson deserializer.",
"operationId": "openehr.CompositionWrapperAPI.updateV2",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the composition",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "reference_model_object_form",
"in": "query",
"description": "The requested form of the composition. The default value is PATHS_AND_VALUES. The options are:\n* **METADATA**: Return only the metadata. `referenceModelObject` and `pathsAndValues` will be empty.\n* **PATHS_AND_VALUES**: Return the `pathsAndValues`. `referenceModelObject` will be empty.\n* **RM_OBJECT**: Return the `referenceModelObject` in the older Nedap specific JSON format. Matches `ArchieJacksonConfiguration.createLegacyConfiguration` in the Archie library. `pathsAndValues` will be empty.\n* **RM_OBJECT_STANDARDS_COMPLIANT_JSON**: Return the `referenceModelObject` compliant with the openEHR JSON specification. Matches `ArchieJacksonConfiguration.createStandardsCompliant` in the Archie library. `pathsAndValues` will be empty.",
"required": false,
"schema": {
"$ref": "#/components/schemas/openehr.ReferenceModelObjectForm"
}
}
],
"requestBody": {
"description": "CompositionWrapper to update",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.CompositionWrapper"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.CompositionWrapper"
}
}
}
},
"400": {
"description": "When the composition could not be updated because it failed validation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.CompositionValidationErrorResponse"
}
}
}
},
"404": {
"description": "When the composition does not exist or is deleted"
}
},
"x-replacement-for": [
"/t/openehr/composition_wrappers/{id}"
]
},
"delete": {
"tags": [
"openehr.CompositionWrapper"
],
"summary": "Deletes the CompositionWrapper with given id",
"operationId": "openehr.CompositionWrapperAPI.delete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the composition",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.CompositionWrapper"
}
}
}
},
"404": {
"description": "When the composition does not exist or is deleted"
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/openehr/composition_wrappers/{id}"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/{id}/composition_versions": {
"get": {
"tags": [
"openehr.CompositionWrapper"
],
"summary": "Finds all CompositionVersionWrappers of a given composition.",
"description": "Finds all {@link CompositionVersionWrapper}s of a given composition.\nContains logic for both authorized and non-authorized API usage.\nThis API supports pogination by using limit and offset. By default will only the 20 most recent results.",
"operationId": "openehr.CompositionWrapperAPI.compositionVersions",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the composition",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "reference_model_object_form",
"in": "query",
"description": "The requested form of the composition. The options are:\n* **METADATA**: Return only the metadata. `referenceModelObject` and `pathsAndValues` will be empty.\n* **PATHS_AND_VALUES**: Return the `pathsAndValues`. `referenceModelObject` will be empty.\n* **RM_OBJECT**: Return the `referenceModelObject` in the older Nedap specific JSON format. Matches `ArchieJacksonConfiguration.createLegacyConfiguration` in the Archie library. `pathsAndValues` will be empty.\n* **RM_OBJECT_STANDARDS_COMPLIANT_JSON**: Return the `referenceModelObject` compliant with the openEHR JSON specification. Matches `ArchieJacksonConfiguration.createStandardsCompliant` in the Archie library. `pathsAndValues` will be empty.",
"required": true,
"schema": {
"$ref": "#/components/schemas/openehr.ReferenceModelObjectForm"
}
},
{
"name": "limit",
"in": "query",
"description": "The amount of {@link CompositionVersionWrapper}s should be returned",
"schema": {
"maximum": 10000,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 20
}
},
{
"name": "offset",
"in": "query",
"description": "Offsets the number of records of the first result",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "client_id",
"in": "query",
"description": "The client id",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "lifecycle_state[]",
"in": "query",
"description": "List of lifecycle states that composition versions should be in, should be called in style: ?lifecycle_state[]=ABANDONED&lifecycle_state[]=INACTIVE",
"explode": true,
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.LifecycleState"
}
},
"example": [
"COMPLETE",
"INACTIVE"
],
"x-original-parameter": {
"name": "lifecycle_state"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.list.CompositionVersionWrapperList"
}
}
}
},
"400": {
"description": "Limit exceeds bounds (1-10000)"
}
},
"x-replacement-for": [
"/t/openehr/composition_wrappers/{id}/composition_versions"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/{id}/incoming_links": {
"get": {
"tags": [
"openehr.CompositionWrapper"
],
"summary": "Finds all reference model objects linking to given composition that are an instance of the given archetypeIds.",
"description": "This API supports pagination by using limit, and by default will only return the 20 most recent results.",
"operationId": "openehr.CompositionWrapperAPI.incomingLinks",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the composition",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "reference_model_object_form",
"in": "query",
"description": "The requested form of the reference model object. The options are:\n* **METADATA**: Return only the metadata. `referenceModelObject` and `pathsAndValues` will be empty.\n* **PATHS_AND_VALUES**: Return the `pathsAndValues`. `referenceModelObject` will be empty.\n* **RM_OBJECT**: Return the `referenceModelObject` in the older Nedap specific JSON format. Matches `ArchieJacksonConfiguration.createLegacyConfiguration` in the Archie library. `pathsAndValues` will be empty.\n* **RM_OBJECT_STANDARDS_COMPLIANT_JSON**: Return the `referenceModelObject` compliant with the openEHR JSON specification. Matches `ArchieJacksonConfiguration.createStandardsCompliant` in the Archie library. `pathsAndValues` will be empty.",
"required": true,
"schema": {
"$ref": "#/components/schemas/openehr.ReferenceModelObjectForm"
}
},
{
"name": "archetype_id[]",
"in": "query",
"description": "List of archetype Ids that the requested compositions should be an instance of",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"x-original-parameter": {
"name": "archetype_id"
}
},
{
"name": "limit",
"in": "query",
"description": "Limits the number of results returned",
"schema": {
"maximum": 10000,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "offset",
"in": "query",
"description": "Offsets the number of records of the first result.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "valid_from",
"in": "query",
"description": "Starting time",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "valid_to",
"in": "query",
"description": "End time",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "module_uuid[]",
"in": "query",
"description": "UUID's of modules that the archetypes of the requested compositions should belong to",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"x-original-parameter": {
"name": "module_uuid"
}
},
{
"name": "lifecycle_state",
"in": "query",
"description": "List of lifecycle states that the incoming links should be in, should be called in style: ?lifecycle_state=ABANDONED&lifecycle_state=INACTIVE",
"required": false,
"explode": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.LifecycleState"
}
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.list.LinkedReferenceModelObjectWrapperList"
}
}
}
},
"400": {
"description": "Limit exceeds bounds (1-10000)"
},
"404": {
"description": "When the composition does not exist or is deleted"
}
},
"x-replacement-for": [
"/t/openehr/composition_wrappers/{id}/incoming_links"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/{versioned_composition_id}/item_tags": {
"post": {
"tags": [
"openehr.ItemTag"
],
"summary": "Creates an item tag for a spesific versioned composition and returns the created item tag.",
"operationId": "openehr.ItemTagAPI.create",
"parameters": [
{
"name": "versioned_composition_id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "module_uuid[]",
"in": "query",
"description": "UUID's of modules that the archetypes of the requested compositions should belong to",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "X-Chiron-Skip-Authorization",
"in": "header",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.ItemTag"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.ItemTag"
}
}
}
},
"400": {
"description": "Composition cannot contain item tags with duplicate keys",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Composition could not be found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/openehr/composition_wrappers/{versioned_composition_id}/item_tags"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/{versioned_composition_id}/item_tags/delete": {
"post": {
"tags": [
"openehr.ItemTag"
],
"summary": "Deletes item tag for a versioned composition.",
"operationId": "openehr.ItemTagAPI.delete",
"parameters": [
{
"name": "versioned_composition_id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "module_uuid[]",
"in": "query",
"description": "UUID's of modules that the archetypes of the requested compositions should belong to",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
{
"name": "X-Chiron-Skip-Authorization",
"in": "header",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.ItemTag"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No Content",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.ItemTag"
}
}
}
},
"400": {
"description": "Item tag payload invalid: only key and targetPath are allowed, and key must be provided.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Composition or item tag key cannot be found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/openehr/composition_wrappers/{versioned_composition_id}/item_tags/delete"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/by_item_tags": {
"post": {
"tags": [
"openehr.CompositionWrapper"
],
"summary": "Returns all compositions that contain all given item tags.",
"description": "Only compositions that match all item tags with key and/or value are returned (AND semantics). At least one item tag needs to be provided and each should have a key and optionally a value. If an archetype id is provided, only the compositions of that archetype are returned. Results are ordered by first event time, most recent first. If module uuid's are provided, only the archetypes that are assigned to these modules are returned.",
"operationId": "openehr.CompositionWrapperAPI.byItemTags",
"parameters": [
{
"name": "client_id",
"in": "query",
"description": "The client id.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "reference_model_object_form",
"in": "query",
"description": "The requested form of the compositions.",
"required": true,
"schema": {
"$ref": "#/components/schemas/openehr.ReferenceModelObjectForm"
}
},
{
"name": "archetype_id",
"in": "query",
"description": "Id of the archetype that the requested compositions should be an instance of.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "module_uuid[]",
"in": "query",
"description": "UUID's of modules that the archetypes of the requested compositions should belong to.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"x-original-parameter": {
"name": "module_uuid"
}
},
{
"name": "offset",
"in": "query",
"description": "Offsets the number of records of the first result.",
"required": false,
"schema": {
"minimum": 0,
"type": "integer",
"format": "int32"
}
},
{
"name": "limit",
"in": "query",
"description": "Limits the number of results returned.",
"required": false,
"schema": {
"maximum": 10000,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 20
}
}
],
"requestBody": {
"description": "The item tags that the returned compositions must all match where key is mandatory and value optional.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.list.ItemTagList"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.list.CompositionWrapperList"
}
}
}
},
"400": {
"description": "Invalid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-replacement-for": [
"/t/openehr/composition_wrappers/by_item_tags"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/evaluate": {
"post": {
"tags": [
"openehr.CompositionWrapper"
],
"summary": "Posts a compositionWrapper and returns the ruleEvaluation.",
"description": "Composition data can be provided by means of either paths and values or ReferenceModelObject. A provided ReferenceModelObject will be deserialized using the standard-compliant Jackson deserializer.",
"operationId": "openehr.CompositionWrapperAPI.evaluate",
"parameters": [
{
"name": "save_temporary_composition",
"in": "query",
"description": "When true, this will save the provided composition as temporary composition.",
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"description": "The posted CompositionWrapper, containing the structure of the paths and values.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.CompositionWrapper"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.RuleEvaluationResult"
}
}
}
}
},
"x-replacement-for": [
"/t/openehr/composition_wrappers/evaluate"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/export_to_xlsx": {
"get": {
"tags": [
"openehr.CompositionWrapper"
],
"summary": "Returns an XLSX file with the content of all compositions within a clients ehr as stream of bytes",
"operationId": "openehr.CompositionWrapperAPI.exportToXLSX",
"parameters": [
{
"name": "client_id",
"in": "query",
"description": "client id",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"description": "When the clientId does not exist"
}
},
"x-replacement-for": [
"/t/openehr/composition_wrappers/export_to_xlsx"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/plan_elements": {
"get": {
"tags": [
"openehr.CompositionWrapper"
],
"summary": "Lists all plan element compositions associated with the requested executor group names",
"description": "A provided archetype id for filtering must be (a specialization of) openEHR-EHR-COMPOSITION.care_plan-plan_element. If no executor group names are provided, all plan elements are returned. Matches also direct parent and child groups of the provided executor group names. If a client id is provided, only the compositions of that client are returned. Results are ordered by first event time, most recent first. If module UUIDs are provided, only the archetypes that are assigned to these modules are returned.",
"operationId": "openehr.CompositionWrapperAPI.planElementCompositions",
"parameters": [
{
"name": "client_id",
"in": "query",
"description": "The client id, when given only the compositions of that client are returned",
"required": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "reference_model_object_form",
"in": "query",
"description": "The requested form of the compositions",
"required": true,
"schema": {
"$ref": "#/components/schemas/openehr.ReferenceModelObjectForm"
}
},
{
"name": "archetype_id",
"in": "query",
"description": "Id of the archetype that the requested compositions should be an instance of, must be (a specialization of) openEHR-EHR-COMPOSITION.care_plan-plan_element",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "executor_group_name[]",
"in": "query",
"description": "Names of the executor employee groups that the requested plan elements should be assigned to",
"required": false,
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"x-original-parameter": {
"name": "executor_group_name"
}
},
{
"name": "lifecycle_state[]",
"in": "query",
"description": "List of lifecycle states that the requested compositions should be in",
"required": false,
"explode": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.LifecycleState"
}
},
"x-original-parameter": {
"name": "lifecycle_state"
}
},
{
"name": "module_uuid[]",
"in": "query",
"description": "UUIDs of modules that the archetypes of the requested compositions should belong to",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"x-original-parameter": {
"name": "module_uuid"
}
},
{
"name": "offset",
"in": "query",
"description": "Offsets the number of records of the first result.",
"required": false,
"schema": {
"minimum": 0,
"type": "integer",
"format": "int32"
}
},
{
"name": "limit",
"in": "query",
"description": "Limits the number of results returned",
"required": false,
"schema": {
"maximum": 10000,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 20
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.list.CompositionWrapperList"
}
}
}
},
"400": {
"description": "Invalid request"
}
},
"x-replacement-for": [
"/t/openehr/composition_wrappers/plan_elements"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/composition_wrappers/selected_values": {
"post": {
"tags": [
"openehr.CompositionWrapper"
],
"summary": "Query composition data by archetype and path",
"description": "Queries values from compositions based on the requested archetypes and paths, optionally limited by a start and/or end date/time. Returns values for the requested paths from compositions that match the requested archetype ids or specializations thereof. The result is ordered by first event time descending.",
"operationId": "openehr.CompositionWrapperAPI.selectedValues",
"parameters": [
{
"name": "client_id",
"in": "query",
"description": "The id of the client in Ons Administratie for which the data is requested",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "reference_model_object_form",
"in": "query",
"description": "The requested form of the compositions. The options are:\n* **METADATA**: Return only the metadata. `referenceModelObject` and `pathsAndValues` will be empty.\n* **PATHS_AND_VALUES**: Return the `pathsAndValues`. `referenceModelObject` will be empty.\n* **RM_OBJECT**: Return the `referenceModelObject` in the older Nedap specific JSON format. Matches `ArchieJacksonConfiguration.createLegacyConfiguration` in the Archie library. `pathsAndValues` will be empty.\n* **RM_OBJECT_STANDARDS_COMPLIANT_JSON**: Return the `referenceModelObject` compliant with the openEHR JSON specification. Matches `ArchieJacksonConfiguration.createStandardsCompliant` in the Archie library. `pathsAndValues` will be empty.",
"required": true,
"schema": {
"$ref": "#/components/schemas/openehr.ReferenceModelObjectForm"
}
},
{
"name": "with_authorized_employee_groups",
"in": "query",
"description": "Set this to true if the response should also include the employee groups who are allowed to read or update the composition",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "with_item_tags",
"in": "query",
"description": "Set this to true if the response should also include the item tags connected to the composition",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "lifecycle_state",
"in": "query",
"description": "List of lifecycle states that the compositions should be in, should be called in style: ?lifecycle_state=ABANDONED&lifecycle_state=INACTIVE",
"required": false,
"explode": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.LifecycleState"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.list.ArchetypeSelectionList"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.list.CompositionValuesForArchetypeList"
}
}
}
}
},
"x-replacement-for": [
"/t/openehr/composition_wrappers/selected_values"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/employee_groups": {
"get": {
"tags": [
"openehr.EmployeeGroup"
],
"summary": "Returns every EmployeeGroup available from the EmployeeGroupAPI",
"operationId": "openehr.EmployeeGroupAPI.all",
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.list.EmployeeGroupList"
}
}
}
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/openehr/employee_groups"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/employee_groups/by_employee/{employee_id}": {
"get": {
"tags": [
"openehr.EmployeeGroup"
],
"summary": "Returns employee groups that an employee is or was a member of",
"operationId": "openehr.EmployeeGroupAPI.byEmployee",
"parameters": [
{
"name": "employee_id",
"in": "path",
"description": "The id of the employee",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "only_active",
"in": "query",
"description": "When true, only return employee groups that an employee currently is a member of",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "with_ancestors",
"in": "query",
"description": "When true, also return ancestors of the direct assignments",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Employee groups that an employee is or was a member of",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.list.EmployeeGroupList"
}
}
}
}
},
"x-replacement-for": [
"/t/openehr/employee_groups/by_employee/{employee_id}"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/employees/{employee_id}/last_visited_plan": {
"get": {
"tags": [
"ons_ehr.LastVisitedPlan"
],
"summary": "Finds the last visited plan of the given employee",
"operationId": "ons_ehr.LastVisitedPlanAPI.byEmployeeId",
"parameters": [
{
"name": "employee_id",
"in": "path",
"description": "The id of the employee",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Last visited plan",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ons_ehr.LastVisitedPlan"
}
}
}
}
},
"x-replacement-for": [
"/t/ons_ehr/employees/{employee_id}/last_visited_plan"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/multimedia_files": {
"post": {
"tags": [
"openehr.MultimediaFile"
],
"summary": "Creates a MultimediaFile and associated meta object",
"description": "POST body:\n \n POST /uc/openehr/multimedia_files HTTP/1.1\n Accept: application/json\n Accept-Encoding: gzip, deflate\n Connection: keep-alive\n Content-Type: multipart/form-data;boundary=Boundary_1_1610615050_1558687905265\n Content-Length: 554\n --Boundary_1_1610615050_1558687905265\n Content-Disposition: form-data; name=\"metadata\"\n Content-Type: application/json\n\n {\"clientId\":3,\"mediaType\":\"image/jpeg\"}\n --Boundary_1_1610615050_1558687905265\n Content-Disposition: form-data; name=\"attachment\"; filename=\"dude_icon.jpg\"\n Content-Type: image/jpeg\n\n [jpeg data, e.g. output of 'cat dude_icon.jpeg | pbcopy']\n --Boundary_1_1610615050_1558687905265--\n \n This method is not actually used, but just a decoy to fool openapi2 into\n generating the correct doc for create(Long, MultimediaFile, String, InputStream)",
"operationId": "openehr.MultimediaFileAPI.create",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/openehr.MultimediaFileCreateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.MultimediaFile"
}
}
}
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/openehr/multimedia_files"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/multimedia_files/{id}": {
"get": {
"tags": [
"openehr.MultimediaFile"
],
"summary": "Finds a MultimediaFile metadata",
"operationId": "openehr.MultimediaFileAPI.byId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the MultimediaFile in Chiron",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.MultimediaFile"
}
}
}
},
"404": {
"description": "When the multimedia file does not exist"
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/openehr/multimedia_files/{id}"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/multimedia_files/{id}/download": {
"get": {
"tags": [
"openehr.MultimediaFile"
],
"summary": "Returns a stream of bytes representing the file related to this MultimediaFile meta data",
"operationId": "openehr.MultimediaFileAPI.download",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the MultimediaFile in Chiron",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Download file",
"content": {
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
},
"image/jpeg": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"description": "When the multimedia file does not exist"
}
},
"x-replacement-for": [
"/t/openehr/multimedia_files/{id}/download"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/multimedia_files/{id}/thumbnail": {
"get": {
"tags": [
"openehr.MultimediaFile"
],
"summary": "Returns a stream of bytes representing the thumbnail with specified scale related to this MultimediaFile meta data",
"operationId": "openehr.MultimediaFileAPI.thumbnail",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the MultimediaFile in Chiron",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "scale",
"in": "query",
"description": "The scale of the thumbnail",
"required": true,
"schema": {
"$ref": "#/components/schemas/openehr.Scale"
}
}
],
"responses": {
"200": {
"description": "Thumbnail of the multimedia file",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"description": "When the multimedia file does not exist"
}
},
"x-replacement-for": [
"/t/openehr/multimedia_files/{id}/thumbnail"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/plan_statistics/ggz": {
"get": {
"tags": [
"ons_ehr.GgzPlanStatistics"
],
"summary": "Retrieves plan statistics for the mental healthcare plan",
"operationId": "ons_ehr.GgzPlanStatisticsAPI.all",
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ons_ehr.GgzPlanStatistics"
}
}
}
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/ons_ehr/plan_statistics/ggz"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/settings": {
"get": {
"tags": [
"ons_ehr.Setting"
],
"summary": "Return all settings from OnsEhr",
"operationId": "ons_ehr.SettingAPI.getAllSettings",
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ons_ehr.list.SettingList"
}
}
}
}
},
"x-replacement-for": [
"/t/ons_ehr/settings"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/vvt_care_profiles/{careplan_id}": {
"get": {
"tags": [
"openehr.CompositionWrapper"
],
"summary": "Finds a VVT care profile compositionWrapper in the requested form",
"operationId": "openehr.CompositionWrapperAPI.byVvtCareProfileCareplanId",
"parameters": [
{
"name": "careplan_id",
"in": "path",
"description": "The id of the careplan for which to request the vvt care profile",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "reference_model_object_form",
"in": "query",
"description": "The requested form of the vvt care profile composition. The options are:\n* **METADATA**: Return only the metadata. `referenceModelObject` and `pathsAndValues` will be empty.\n* **PATHS_AND_VALUES**: Return the `pathsAndValues`. `referenceModelObject` will be empty.\n* **RM_OBJECT**: Return the `referenceModelObject` in the older Nedap specific JSON format. Matches `ArchieJacksonConfiguration.createLegacyConfiguration` in the Archie library. `pathsAndValues` will be empty.\n* **RM_OBJECT_STANDARDS_COMPLIANT_JSON**: Return the `referenceModelObject` compliant with the openEHR JSON specification. Matches `ArchieJacksonConfiguration.createStandardsCompliant` in the Archie library. `pathsAndValues` will be empty.",
"required": true,
"schema": {
"$ref": "#/components/schemas/openehr.ReferenceModelObjectForm"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.CompositionWrapper"
}
}
}
},
"404": {
"description": "When the vvt care profile composition does not exist or is deleted"
}
},
"x-replacement-for": [
"/t/openehr/vvt_care_profiles/{careplan_id}"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/vvt_care_profiles/{careplan_id}/copy": {
"post": {
"tags": [
"openehr.CompositionWrapper"
],
"summary": "Copies a VVT care profile compositionWrapper to a new careplan.",
"description": "This will update the event time of the observation in\nthe composition to the date time this was copied",
"operationId": "openehr.CompositionWrapperAPI.copyVvtCareProfile",
"parameters": [
{
"name": "careplan_id",
"in": "path",
"description": "The id of the careplan from which to copy the vvt care profile",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "new_careplan_id",
"in": "query",
"description": "The id of the careplan for which to create a vvt care profile",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "reference_model_object_form",
"in": "query",
"description": "The requested form of the vvt care profile composition. The options are:\n* **METADATA**: Return only the metadata. `referenceModelObject` and `pathsAndValues` will be empty.\n* **PATHS_AND_VALUES**: Return the `pathsAndValues`. `referenceModelObject` will be empty.\n* **RM_OBJECT**: Return the `referenceModelObject` in the older Nedap specific JSON format. Matches `ArchieJacksonConfiguration.createLegacyConfiguration` in the Archie library. `pathsAndValues` will be empty.\n* **RM_OBJECT_STANDARDS_COMPLIANT_JSON**: Return the `referenceModelObject` compliant with the openEHR JSON specification. Matches `ArchieJacksonConfiguration.createStandardsCompliant` in the Archie library. `pathsAndValues` will be empty.",
"required": true,
"schema": {
"$ref": "#/components/schemas/openehr.ReferenceModelObjectForm"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.CompositionWrapper"
}
}
}
},
"404": {
"description": "When the vvt care profile composition does not exist or is deleted"
}
},
"x-replacement-for": [
"/t/openehr/vvt_care_profiles/{careplan_id}/copy"
]
}
},
"/v0/openehr_dossier/back_channel/unauthorized/vvt_care_profiles/care_plan_links": {
"post": {
"tags": [
"openehr.CarePlanVvtCareProfileLink"
],
"summary": "Returns care plan IDs for given VVT care profile composition IDs",
"operationId": "openehr.CarePlanVvtCareProfileLinkAPI.linkIds",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.CompositionIdList"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "List of care plan IDs for given VVT care profile composition IDs",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/openehr.list.CarePlanVvtCareProfileLinkList"
}
}
}
}
},
"x-replacement-for": [
"/t/openehr/vvt_care_profiles/care_plan_links"
]
}
},
"/v0/plannen_roosteren/clients/{client_id}/client_planning_filters": {
"get": {
"tags": [
"moves.ClientPlanningFilter"
],
"summary": "Return the client planning filters of a Client within a specified period.",
"operationId": "moves.ClientPlanningFilterAPI.byClientId",
"parameters": [
{
"name": "client_id",
"in": "path",
"description": "The {id} of the requested Client",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "from",
"in": "query",
"description": "The start date of the requested period",
"required": true,
"schema": {
"type": "string",
"format": "date"
},
"x-original-parameter": {
"name": "valid_from"
}
},
{
"name": "to",
"in": "query",
"description": "The end date of the requested period (exclusive)",
"required": true,
"schema": {
"type": "string",
"format": "date"
},
"x-original-parameter": {
"name": "valid_to"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.list.ClientPlanningFilterList"
}
}
}
}
},
"x-replacement-for": [
"/t/clients/{client_id}/client_planning_filters"
]
}
},
"/v0/plannen_roosteren/clients/{client_id}/planned_schedule": {
"get": {
"tags": [
"moves.ClientPlannedSchedulePlannedVisit"
],
"summary": "Return the client planning filters of a Client within a specified period.",
"operationId": "moves.ClientPlannedSchedulePlannedVisitAPI.plannedSchedule",
"parameters": [
{
"name": "client_id",
"in": "path",
"description": "The id of the requested Client",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "date",
"in": "query",
"description": "The date for which to check",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.list.ClientPlannedSchedulePlannedVisitList"
}
}
}
}
},
"x-replacement-for": [
"/t/clients/{client_id}/planned_schedule"
]
}
},
"/v0/plannen_roosteren/containers/search": {
"post": {
"tags": [
"moves.Container"
],
"summary": "Return the active containers searched for within a specified period.",
"operationId": "moves.ContainerAPI.search",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.ContainerSearchRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.list.ContainerList"
}
}
}
},
"400": {
"description": "Parsing errors or user errors."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "It is forbidden for the user to look through these containers."
},
"429": {
"description": "Rate limit reached for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.MovesRatelimitError"
}
}
}
}
},
"x-replacement-for": [
"/t/containers/search"
]
}
},
"/v0/plannen_roosteren/employee_export_jobs/create": {
"post": {
"tags": [
"moves.EmployeeExportJob"
],
"summary": "Request to run the export for a single employee/date combination.\n(1) PresenceLogs are created in OnsPlanning, and immediately exported\nto OnsAdministration. When the export times out, the created\nPresenceLogs will be exported to OnsAdministration asynchronously.\n(2) The export can only be ran once for an employee/date combination.\nRerunning or re-requesting the export is a no-op.",
"operationId": "moves.EmployeeExportJobAPI.create",
"requestBody": {
"description": "EmployeeExportJob specifying the employee/date combination for which export is requested.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.EmployeeExportJob"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "PresenceLogs have been created within OnsPlanning, AND have been\nsuccessfully been exported to OnsAdministration.\nThe reponse ONLY contains PresenceLog.id, because after export\nOnsAdministration is the authoritive source of this data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.EmployeeExportJob"
}
}
}
},
"404": {
"description": "Could not find employee"
},
"500": {
"description": "Likely due to OnsAdministration being temporarily unavailable.\nIf PresenceLogs have been created within OnsPlanning,\nthey will be exported to OnsAdministration asynchronously."
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/moves/employee_export_jobs"
]
}
},
"/v0/plannen_roosteren/employee_export_jobs/preview": {
"post": {
"tags": [
"moves.EmployeeExportJob"
],
"summary": "Return a preview for the specified employee export job",
"description": "Preview means the response will show which presence logs will be exported but not actually do so.",
"operationId": "moves.EmployeeExportJobAPI.preview",
"requestBody": {
"description": "EmployeeExportJob object to preview",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.EmployeeExportJob"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.EmployeeExportJob"
}
}
}
},
"404": {
"description": "Could not find employee"
}
},
"x-replacement-for": [
"/t/moves/employee_export_jobs/preview"
]
}
},
"/v0/plannen_roosteren/employee_schedules/by_employee_id/{employee_id}": {
"get": {
"tags": [
"moves.EmployeeSchedule"
],
"summary": "Returns the EmployeeSchedule for the given Employee for the requested period.",
"operationId": "moves.EmployeeScheduleAPI.byEmployeeId",
"parameters": [
{
"name": "employee_id",
"in": "path",
"description": "The {id} of the requested Employee",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "from",
"in": "query",
"description": "The start date of the period.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "The end date of the period (exclusive).",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of keywords to indicate which\n features/fields/subresources you'd like to have included\n in the response.\n `exportability` - The `.exportable` attribute of various\n models will be computed to indicate whether they would\n be exported by the EmployeeExportApi at this time.\n `flex_signups` - RosterSlots will be included for which\n the employee has signedup, but has not been assigned to\n yet. FlexSignups of colleagues for the same RosterSlot\n are also included.\n `unavailability` - UnavailabilityOccurrences for both\n whole days and parts of days are included.\n `location_authorizations` - LocationAuthorizations are\n included for each RosterSlot and PlannedVisit.\n `availability` - AvailabilityOccurrences are included.\n `leave_requests` - LeaveRequestOccurrences are included.",
"schema": {
"type": "string"
}
},
{
"name": "apply_mutations",
"in": "query",
"description": "Whether to apply the employees plan mutations to the results",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.EmployeeSchedule"
}
}
}
}
},
"x-replacement-for": [
"/t/employee_schedules/by_employee_id/{employee_id}"
]
}
},
"/v0/plannen_roosteren/employees/{employee_id}/employee_moves_profile": {
"get": {
"tags": [
"moves.EmployeeMovesProfile"
],
"summary": "Return the moves profile of an employee specified by id.",
"operationId": "moves.EmployeeMovesProfileAPI.byEmployeeId",
"parameters": [
{
"name": "employee_id",
"in": "path",
"description": "The {id} of the requested Employee",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.EmployeeMovesProfile"
}
}
}
}
},
"x-replacement-for": [
"/t/employees/{employee_id}/employee_moves_profile"
]
}
},
"/v0/plannen_roosteren/employees/{employee_id}/hours_report": {
"get": {
"tags": [
"moves.EmployeeHoursReport"
],
"summary": "Return a report of the worked and leave hours of an employee in the current state and the future.",
"operationId": "moves.EmployeeHoursReportAPI.byEmployeeId",
"parameters": [
{
"name": "employee_id",
"in": "path",
"description": "The id of the requested Employee",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.EmployeeHoursReport"
}
}
}
}
},
"x-replacement-for": [
"/t/employees/{employee_id}/hours_report"
]
}
},
"/v0/plannen_roosteren/employees/{employee_id}/navigation_availabilities": {
"get": {
"tags": [
"moves.NavigationAvailability"
],
"summary": "Return the navigation availabilities of an employee specified by id.",
"operationId": "moves.NavigationAvailabilityAPI.byEmployeeId",
"parameters": [
{
"name": "employee_id",
"in": "path",
"description": "The {id} of the requested Employee",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.list.NavigationAvailabilityList"
}
}
}
}
},
"x-replacement-for": [
"/t/employees/{employee_id}/navigation_availabilities"
]
}
},
"/v0/plannen_roosteren/employees/{employee_id}/planning": {
"get": {
"tags": [
"moves.EmployeePlanning"
],
"summary": "Returns the Planning for the given Employee for the requested period.",
"operationId": "moves.EmployeePlanningAPI.planningByEmployeeId",
"parameters": [
{
"name": "employee_id",
"in": "path",
"description": "The {id} of the requested Employee",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "date",
"in": "query",
"description": "The start date of the period.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.EmployeePlanning"
}
}
}
}
},
"x-replacement-for": [
"/t/employee_planning/employees/{employee_id}/planning"
]
}
},
"/v0/plannen_roosteren/employees/{employee_id}/roster": {
"get": {
"tags": [
"moves.EmployeePlanning"
],
"summary": "Returns the Roster for the given Employee for the requested period.",
"operationId": "moves.EmployeePlanningAPI.rosterByEmployeeId",
"parameters": [
{
"name": "employee_id",
"in": "path",
"description": "The {id} of the requested Employee",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "from",
"in": "query",
"description": "The start date of the period.",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "The end date of the period (exclusive).",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.list.EmployeeRosterDayList"
}
}
}
}
},
"x-replacement-for": [
"/t/employee_planning/employees/{employee_id}/roster"
]
}
},
"/v0/plannen_roosteren/employees/{employee_id}/shift_assignments/upcoming": {
"get": {
"tags": [
"moves.ShiftAssignment"
],
"summary": "Return the first upcoming shift assignment of an Employee specified by id",
"description": "The response is a list of shift assignments of length 1",
"operationId": "moves.ShiftAssignmentAPI.upcomingForEmployee",
"parameters": [
{
"name": "employee_id",
"in": "path",
"description": "The {id} of the requested Employee",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.list.ShiftAssignmentList"
}
}
}
}
},
"x-replacement-for": [
"/t/moves/employees/{employee_id}/shift_assignments/upcoming"
]
}
},
"/v0/plannen_roosteren/employees/absences": {
"post": {
"tags": [
"moves.Absence"
],
"summary": "EXPERIMENTAL: Create or update an absence",
"description": "Creates a new absence or updates an existing one based on the remote ID.\n\nAbsences created through this API do not have any effect on workflows within Ons and are not visible in the Suite yet. For testing purposes only you can use the following URL in Ons Plannen & Roosteren /units/:id/dashboard/absence_cases?json=true&from=2026-01-01&to=2026-12-31.",
"operationId": "moves.AbsenceAPI.upsert",
"requestBody": {
"description": "The absence details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.AbsenceUpsert"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Absence created or updated successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.Absence"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemResponse"
}
}
}
},
"422": {
"description": "Unprocessable entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemResponse"
}
}
}
}
},
"x-replacement-for": [
"/t/employees/absences"
]
}
},
"/v0/plannen_roosteren/employees/absences/{remote_absence_id}": {
"get": {
"tags": [
"moves.Absence"
],
"summary": "Retrieve an absence by remote ID",
"operationId": "moves.AbsenceAPI.byRemoteId",
"parameters": [
{
"name": "remote_absence_id",
"in": "path",
"description": "The remote ID of the absence",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.Absence"
}
}
}
},
"404": {
"description": "Absence not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemResponse"
}
}
}
}
},
"x-replacement-for": [
"/t/employees/absences/{remote_absence_id}"
]
},
"delete": {
"tags": [
"moves.Absence"
],
"summary": "EXPERIMENTAL: Delete an absence by remote ID",
"operationId": "moves.AbsenceAPI.deleteByRemoteId",
"parameters": [
{
"name": "remote_absence_id",
"in": "path",
"description": "The remote ID of the absence",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"404": {
"description": "Absence not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemResponse"
}
}
}
}
},
"x-replacement-for": [
"/t/employees/absences/{remote_absence_id}"
]
}
},
"/v0/plannen_roosteren/flex_signups": {
"post": {
"tags": [
"moves.FlexSignup"
],
"summary": "Creates a flex signup for an employee on a flex request",
"description": "Signs up an employee for a specific flex request. If the employee already has a flex signup for the same shift timeline and date, the flex request will be added to the existing signup only if the request properties match those of the other request(s). The matching properties are: shift timeline ID, date, start time, end time, break start time, break end time, and expertise profile ID.",
"operationId": "moves.FlexSignupAPI.create",
"requestBody": {
"description": "The employee ID and flex request ID to create a signup",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.FlexSignupRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Flex signup created or updated successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.FlexSignup"
}
}
}
},
"400": {
"description": "Bad request - validation errors, employee already signed up, or resource not found"
},
"401": {
"description": "Unauthorized - authentication required"
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/moves/flex_signups"
]
}
},
"/v0/plannen_roosteren/plan_cards/{checksum}": {
"patch": {
"tags": [
"moves.PlanCardOccurrence"
],
"summary": "Update a plan card occurrence",
"operationId": "moves.PlanCardOccurrenceAPI.incidentalChange",
"parameters": [
{
"name": "checksum",
"in": "path",
"description": "The checksum of the PlanCardOccurrence being updated",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.PlanCardOccurrenceAttributesRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.PlanCardOccurrenceResponse"
}
}
}
},
"400": {
"description": "Parsing errors or user errors."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "It is forbidden for the user to look through these plan cards."
},
"404": {
"description": "Plan card occurrence not found."
},
"429": {
"description": "Rate limit reached for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.MovesRatelimitError"
}
}
}
}
},
"x-replacement-for": [
"/t/plan_cards/{checksum}"
]
}
},
"/v0/plannen_roosteren/plan_cards/{checksum}/plan": {
"post": {
"tags": [
"moves.PlanCardOccurrence"
],
"summary": "Plan a single plan card into a container",
"operationId": "moves.PlanCardOccurrenceAPI.plan",
"parameters": [
{
"name": "checksum",
"in": "path",
"description": "The checksum of the PlanCardOccurrence being planned",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.PlanCardOccurrencePlanRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.PlanCardOccurrenceResponse"
}
}
}
},
"400": {
"description": "Parsing errors or user errors."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "It is forbidden for the user to look through these plan cards."
},
"404": {
"description": "Plan card occurrence not found."
},
"429": {
"description": "Rate limit reached for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.MovesRatelimitError"
}
}
}
}
},
"x-replacement-for": [
"/t/plan_cards/{checksum}/plan"
]
}
},
"/v0/plannen_roosteren/plan_cards/search": {
"post": {
"tags": [
"moves.PlanCardOccurrence"
],
"summary": "Return the active plan cards searched for within a specified period.",
"operationId": "moves.PlanCardOccurrenceAPI.search",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.ContainerSearchRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.PlanCardOccurrenceList"
}
}
}
},
"400": {
"description": "Parsing errors or user errors."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "It is forbidden for the user to look through these plan cards."
},
"429": {
"description": "Rate limit reached for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.MovesRatelimitError"
}
}
}
}
},
"x-replacement-for": [
"/t/plan_cards/search"
]
}
},
"/v0/plannen_roosteren/planned_visits/by_client_id/{client_id}": {
"get": {
"tags": [
"moves.PlannedVisit"
],
"summary": "Return the planned visits of a Client within a specified period.",
"operationId": "moves.PlannedVisitAPI.byClientId",
"parameters": [
{
"name": "client_id",
"in": "path",
"description": "The id of the Client whose PlannedVisits you want to retrieve.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "from",
"in": "query",
"description": "The start date of the period.",
"required": true,
"schema": {
"type": "string",
"format": "date"
},
"x-original-parameter": {
"name": "valid_from"
}
},
{
"name": "to",
"in": "query",
"description": "The end date of the period (exclusive).",
"required": true,
"schema": {
"type": "string",
"format": "date"
},
"x-original-parameter": {
"name": "valid_to"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of keywords to indicate which\nfeatures/fields/subresources you'd like to have included\nin the response.\nNo keywords supported at the moment. Parameter is defined\nfor symmetry with PlannedVisitAPI.byEmployeeId.",
"schema": {
"type": "string"
}
},
{
"name": "apply_mutations",
"in": "query",
"description": "Whether to apply the employees plan mutations to the results",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.list.PlannedVisitList"
}
}
}
},
"400": {
"description": "Parsing errors"
}
},
"x-replacement-for": [
"/t/clients/{client_id}/planned_visits"
]
}
},
"/v0/plannen_roosteren/planned_visits/by_employee_id/{employee_id}": {
"get": {
"tags": [
"moves.PlannedVisit"
],
"summary": "Return the planned visits of an Employee within a specified period.",
"operationId": "moves.PlannedVisitAPI.byEmployeeId",
"parameters": [
{
"name": "employee_id",
"in": "path",
"description": "The id of the Employee whose PlannedVisits you want to retrieve.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "from",
"in": "query",
"description": "The start date of the period.",
"required": true,
"schema": {
"type": "string",
"format": "date"
},
"x-original-parameter": {
"name": "valid_from"
}
},
{
"name": "to",
"in": "query",
"description": "The end date of the period (exclusive).",
"required": true,
"schema": {
"type": "string",
"format": "date"
},
"x-original-parameter": {
"name": "valid_to"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of keywords to indicate which\nfeatures/fields/subresources you'd like to have included\nin the response.\n`exportability` - The `Plancard.exportable` attribute\nwill be computed to indicate whether a plancard would\nbe exported by the EmployeeExportApi at this time.",
"schema": {
"type": "string"
}
},
{
"name": "apply_mutations",
"in": "query",
"description": "Whether to apply the employees plan mutations to the results",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.list.PlannedVisitList"
}
}
}
},
"400": {
"description": "Parsing errors"
}
},
"x-replacement-for": [
"/t/employees/{employee_id}/planned_visits"
]
}
},
"/v0/plannen_roosteren/roster_slots": {
"get": {
"tags": [
"moves.RosterSlot"
],
"summary": "Return the roster slots of a unit (referred to with either a team_id or unit_id) within the specified period. Slots which are incidentally changed in time contain a ShiftAssignment with the adjusted times and no employee.",
"operationId": "moves.RosterSlotAPI.byUnitAndPeriod",
"parameters": [
{
"name": "team_id",
"in": "query",
"description": "The id of the requested unit in Ons Administration",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "unit_id",
"in": "query",
"description": "The id of the requested unit in Ons Planning",
"required": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "from",
"in": "query",
"description": "The start date of the requested period",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "The end date of the requested period (exclusive)",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.list.RosterSlotList"
}
}
}
},
"400": {
"description": "Parsing errors or user errors."
},
"401": {
"description": "Unauthorized."
},
"404": {
"description": "Could not find Unit"
}
},
"x-replacement-for": [
"/t/moves/roster_slots"
]
}
},
"/v0/plannen_roosteren/roster_slots/{id}": {
"get": {
"tags": [
"moves.RosterSlot"
],
"summary": "Return the roster slot with the specified id.",
"operationId": "moves.RosterSlotAPI.byId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the requested roster slot",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.RosterSlot"
}
}
}
},
"400": {
"description": "Parsing errors or user errors."
},
"401": {
"description": "Unauthorized."
},
"404": {
"description": "Could not find RosterSlot"
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/moves/roster_slots/{id}"
]
}
},
"/v0/plannen_roosteren/roster_slots/{roster_slot_id}/assign": {
"post": {
"tags": [
"moves.RosterSlot"
],
"summary": "Assigns a RosterSlot to an Employee by creating a ShiftAssignment for it.",
"description": "Requires `employeeId`, `timelineShiftId` and `date`. Optional fields (`beginTime`, `endTime`, `startBreakTime`, `stopBreakTime`, `externalExpertiseProfileId`) allow full shift customization. To explicitly remove a break or an external expertise profile from the assignment, send `null` or an empty string for the respective field(s). If optional fields are provided, their values will overwrite the original shift's values. An optional `order` assigns the employee to a specific spot when the shift has multiple positions. `order` does not modify the base shift or its default values, it only selects which spot this assignment occupies.",
"operationId": "moves.RosterSlotAPI.assign",
"parameters": [
{
"name": "roster_slot_id",
"in": "path",
"description": "The {id} of the roster slot",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The shift assignment to be added",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.ShiftAssignment"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.RosterSlot"
}
}
}
}
},
"x-replacement-for": [
"/t/moves/roster_slots/{roster_slot_id}/assign"
]
}
},
"/v0/plannen_roosteren/roster_slots/{roster_slot_id}/clear_assignments": {
"delete": {
"tags": [
"moves.RosterSlot"
],
"summary": "Clears all ShiftAssignments for the specified RosterSlot.",
"description": "Clears all shift assignments by default. When the `order` parameter is provided, only clears the assignment for the specified shift spot.",
"operationId": "moves.RosterSlotAPI.clearAssignmentsV2",
"parameters": [
{
"name": "roster_slot_id",
"in": "path",
"description": "The {id} of the roster slot",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "order",
"in": "query",
"description": "The `order` of the specific shift spot to clear. If not provided, all assignments will be cleared.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"example": 0
}
}
],
"responses": {
"204": {
"description": "Deleted"
}
},
"x-replacement-for": [
"/t/moves/roster_slots/{roster_slot_id}/clear_assignments"
]
}
},
"/v0/plannen_roosteren/roster_slots/on_call": {
"get": {
"tags": [
"moves.RosterSlot"
],
"summary": "Return the on call roster slots of a unit on the specified date.",
"operationId": "moves.RosterSlotAPI.onCallByUnitAndDate",
"parameters": [
{
"name": "team_id",
"in": "query",
"description": "The id of the requested unit in Ons Administration",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "unit_id",
"in": "query",
"description": "The id of the requested unit in Ons Planning",
"required": false,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "date",
"in": "query",
"description": "The requested date",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.list.RosterSlotList"
}
}
}
},
"400": {
"description": "Parsing errors or user errors."
},
"401": {
"description": "Unauthorized."
},
"404": {
"description": "Could not find Unit"
}
},
"x-replacement-for": [
"/t/moves/roster_slots/on_call"
]
}
},
"/v0/plannen_roosteren/shift_assignments/starting_between": {
"get": {
"tags": [
"moves.ShiftAssignment"
],
"summary": "Return all the shift assignments starting within the specified period",
"description": "The requested period must be 1 hour or less",
"operationId": "moves.ShiftAssignmentAPI.startingBetween",
"parameters": [
{
"name": "start_datetime",
"in": "query",
"description": "The start of the requested period",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
},
"example": "2014-12-29T00:00:00.000Z"
},
{
"name": "end_datetime",
"in": "query",
"description": "The end of the requested period (exclusive)",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
},
"example": "2014-12-29T00:00:00.000Z"
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.list.ShiftAssignmentList"
}
}
}
},
"400": {
"description": "Invalid period, or parsing errors"
}
},
"x-replacement-for": [
"/t/moves/shift_assignments/starting_between"
]
}
},
"/v0/plannen_roosteren/shifts/{id}": {
"get": {
"tags": [
"moves.Shift"
],
"summary": "Get a shift by its ID",
"operationId": "moves.ShiftAPI.byId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "used for selecting Shift",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.Shift"
}
}
}
},
"404": {
"description": "Could not find Shift"
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/moves/shifts/{id}"
]
}
},
"/v0/plannen_roosteren/teams/{team_id}/on_call_rosterslots": {
"get": {
"tags": [
"moves.RosterSlot"
],
"summary": "Return the on call roster slots of a Team on the specified date.",
"description": "This endpoint is deprecated. Please use `GET /plannen_roosteren/roster_slots/on_call` endpoint instead.",
"operationId": "moves.RosterSlotAPI.onCallByTeamId",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "The {id} of the requested team",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "date",
"in": "query",
"description": "The requested date",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.list.RosterSlotList"
}
}
}
}
},
"deprecated": true,
"x-deprecated-since": "02-09-2025",
"x-replacement-for": [
"/t/teams/{team_id}/on_call_roster_slots"
]
}
},
"/v0/plannen_roosteren/teams/{team_id}/rosterslots": {
"get": {
"tags": [
"moves.RosterSlot"
],
"summary": "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.",
"description": "This endpoint is deprecated. Please use `GET /plannen_roosteren/roster_slots` endpoint instead.",
"operationId": "moves.RosterSlotAPI.byTeamId",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "The {id} of the requested team",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "from",
"in": "query",
"description": "The start date of the requested period",
"required": true,
"schema": {
"type": "string",
"format": "date"
},
"x-original-parameter": {
"name": "valid_from"
}
},
{
"name": "to",
"in": "query",
"description": "The end date of the requested period (exclusive)",
"required": true,
"schema": {
"type": "string",
"format": "date"
},
"x-original-parameter": {
"name": "valid_to"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.list.RosterSlotList"
}
}
}
}
},
"deprecated": true,
"x-deprecated-since": "02-09-2025",
"x-replacement-for": [
"/t/teams/{team_id}/roster_slots"
]
}
},
"/v0/plannen_roosteren/units": {
"get": {
"tags": [
"moves.Team"
],
"summary": "Return all Teams used for planning and rostering ( also known as a unit ). Every unit (mostly) corresponds to a team in Ons Administration \n(however, it is possible to have a unit used for planning and rostering that is not connected to an administrative team).",
"operationId": "moves.TeamAPI.all",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.list.TeamList"
}
}
}
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/moves/units"
]
}
},
"/v0/plannen_roosteren/units/{unit_id}": {
"get": {
"tags": [
"moves.Team"
],
"summary": "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 \n(however, it is possible to have a unit used for planning and rostering that is not connected to an administrative team).",
"operationId": "moves.TeamAPI.byId",
"parameters": [
{
"name": "unit_id",
"in": "path",
"description": "The unit identifier of the requested Team",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.Team"
}
}
}
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/moves/units/{unit_id}"
]
}
},
"/v0/plannen_roosteren/units/{unit_id}/clients": {
"get": {
"tags": [
"moves.Team"
],
"summary": "Return a list of relevant clients for the team, for given start and end date.",
"operationId": "moves.TeamAPI.relevantClientsByUnitId",
"parameters": [
{
"name": "unit_id",
"in": "path",
"description": "The unit identifier for the requested team.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "from",
"in": "query",
"description": "The from-date for which to check. Defaults to last Monday. The maximum period is 6 weeks.",
"required": false,
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "to",
"in": "query",
"description": "The to-date for which to check. Defaults to next Monday. The maximum period is 6 weeks.",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.list.ClientList"
}
}
}
}
},
"x-replacement-for": [
"/t/moves/units/{unit_id}/clients"
]
}
},
"/v0/plannen_roosteren/working_employee_report": {
"get": {
"tags": [
"moves.WorkingEmployeeReport"
],
"summary": "Return the list of Employee ids working within the specified period.",
"description": "Working according to the planning.",
"operationId": "moves.WorkingEmployeeReportAPI.between",
"parameters": [
{
"name": "start_datetime",
"in": "query",
"description": "The start of the requested period",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
},
"example": "2014-12-29T00:00:00.000Z"
},
{
"name": "end_datetime",
"in": "query",
"description": "The end of the requested period (exclusive)",
"required": true,
"schema": {
"type": "string",
"format": "date-time"
},
"example": "2014-12-29T00:00:00.000Z"
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/moves.WorkingEmployeeReport"
}
}
}
}
},
"x-replacement-for": [
"/t/moves/working_employee_report"
]
}
},
"/v0/taken/care_task_group_statuses": {
"get": {
"tags": [
"tasque.CareTaskGroupStatus"
],
"summary": "Returns every CareTaskGroupStatus available from the CareTaskGroupStatusAPI",
"operationId": "tasque.CareTaskGroupStatusAPI.all",
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.list.CareTaskGroupStatusList"
}
}
}
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/tasque/care_task_group_statuses"
]
}
},
"/v0/taken/care_task_groups": {
"post": {
"tags": [
"tasque.CareTaskGroup"
],
"summary": "Create CareTaskGroup",
"operationId": "tasque.CareTaskGroupAPI.create",
"requestBody": {
"description": "CareTaskGroup to create",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.CareTaskGroup"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.CareTaskGroup"
}
}
}
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/tasque/care_task_groups"
]
}
},
"/v0/taken/care_task_groups/{id}": {
"get": {
"tags": [
"tasque.CareTaskGroup"
],
"summary": "Gets task group",
"operationId": "tasque.CareTaskGroupAPI.byId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "used for selecting CareTaskGroup",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.CareTaskGroup"
}
}
}
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/tasque/care_task_groups/{id}"
]
},
"put": {
"tags": [
"tasque.CareTaskGroup"
],
"summary": "Updates the given CareTaskGroup",
"operationId": "tasque.CareTaskGroupAPI.update",
"parameters": [
{
"name": "id",
"in": "path",
"description": "used for selecting CareTaskGroup",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "CareTaskGroup to update",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.CareTaskGroup"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.CareTaskGroup"
}
}
}
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/tasque/care_task_groups/{id}"
]
},
"delete": {
"tags": [
"tasque.CareTaskGroup"
],
"summary": "Deletes the CareTaskGroup with given id",
"operationId": "tasque.CareTaskGroupAPI.delete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "used for selecting CareTaskGroup",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "If successfully removed the care task group",
"content": {}
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/tasque/care_task_groups/{id}"
]
}
},
"/v0/taken/care_task_occurrences/{id}": {
"get": {
"tags": [
"tasque.CareTaskOccurrence"
],
"operationId": "tasque.CareTaskOccurrenceAPI.byId",
"parameters": [
{
"name": "id",
"in": "path",
"description": "used for selecting CareTaskOccurrence",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.CareTaskOccurrence"
}
}
}
}
},
"x-cupido-common-method": true,
"x-replacement-for": [
"/t/tasque/care_task_occurrences/{id}"
]
}
},
"/v0/taken/care_task_occurrences/{id}/destroy_following": {
"delete": {
"tags": [
"tasque.CareTaskOccurrence"
],
"summary": "Removes the given task occurrences item and all of the following occurrences of that item",
"operationId": "tasque.CareTaskOccurrenceAPI.destroyFollowing",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifier of CareTaskOccurrence to delete.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "AgendaOccurrence to remove",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.CareTaskOccurrence"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "If successfully removed the care task occurrences"
}
},
"x-replacement-for": [
"/t/tasque/care_task_occurrences/{id}/destroy_following"
]
}
},
"/v0/taken/care_task_occurrences/{id}/destroy_incidentally": {
"delete": {
"tags": [
"tasque.CareTaskOccurrence"
],
"summary": "Removes the given task occurrence item",
"operationId": "tasque.CareTaskOccurrenceAPI.destroyIncidentally",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifier of CareTaskOccurrence to delete.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "AgendaOccurrence to remove",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.CareTaskOccurrence"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "If successfully removed the care task occurrence"
}
},
"x-replacement-for": [
"/t/tasque/care_task_occurrences/{id}/destroy_incidentally"
]
}
},
"/v0/taken/care_task_occurrences/{id}/finish": {
"put": {
"tags": [
"tasque.CareTaskOccurrence"
],
"summary": "Set state of the given task occurrence to finish",
"operationId": "tasque.CareTaskOccurrenceAPI.finish",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifier of CareTaskOccurrence to update.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.CareTaskOccurrence"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.CareTaskOccurrence"
}
}
}
}
},
"x-replacement-for": [
"/t/tasque/care_task_occurrences/{id}/finish"
]
}
},
"/v0/taken/care_task_occurrences/{id}/next_date/{date}": {
"get": {
"tags": [
"tasque.CareTaskOccurrence"
],
"operationId": "tasque.CareTaskOccurrenceAPI.nextById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "used for selecting CareTaskOccurrence",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "path",
"description": "used for find the next occurrence",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.CareTaskOccurrence"
}
}
}
}
},
"x-replacement-for": [
"/t/tasque/care_task_occurrences/{id}/next_date/{date}"
]
}
},
"/v0/taken/care_task_occurrences/{id}/next_date/{date}/destroy_following": {
"delete": {
"tags": [
"tasque.CareTaskOccurrence"
],
"summary": "Find the next CareTaskOccurrence based on the id and a baseline search date and\nremoves that found task occurrence item and all of the following occurrences of that item",
"operationId": "tasque.CareTaskOccurrenceAPI.destroyNextFollowing",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifier of CareTaskOccurrence to delete.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "path",
"description": "The date from which the search for the next occurrence should be done",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"requestBody": {
"description": "AgendaOccurrence to remove",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.CareTaskOccurrence"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.CareTaskOccurrence"
}
}
}
}
},
"x-replacement-for": [
"/t/tasque/care_task_occurrences/{id}/next_date/{date}/destroy_following"
]
}
},
"/v0/taken/care_task_occurrences/{id}/next_date/{date}/destroy_incidentally": {
"delete": {
"tags": [
"tasque.CareTaskOccurrence"
],
"summary": "Find the next CareTaskOccurrence based on the id and a baseline search date and\nremoves that found task occurrence item",
"operationId": "tasque.CareTaskOccurrenceAPI.destroyNextIncidentally",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifier of CareTaskOccurrence to delete.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "path",
"description": "The date from which the search for the next occurrence should be done",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"requestBody": {
"description": "AgendaOccurrence to remove",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.CareTaskOccurrence"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.CareTaskOccurrence"
}
}
}
}
},
"x-replacement-for": [
"/t/tasque/care_task_occurrences/{id}/next_date/{date}/destroy_incidentally"
]
}
},
"/v0/taken/care_task_occurrences/{id}/next_date/{date}/update_following": {
"put": {
"tags": [
"tasque.CareTaskOccurrence"
],
"summary": "Find the next CareTaskOccurrence based on the id and a baseline search date and\nupdate only that found CareTaskOccurrence and all of the following occurrence of that item.",
"operationId": "tasque.CareTaskOccurrenceAPI.updateNextFollowing",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifier of CareTaskOccurrence to update.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "path",
"description": "The date from which the search for the next occurrence should be done",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.CareTaskOccurrence"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.CareTaskOccurrence"
}
}
}
}
},
"x-replacement-for": [
"/t/tasque/care_task_occurrences/{id}/next_date/{date}/update_following"
]
}
},
"/v0/taken/care_task_occurrences/{id}/next_date/{date}/update_incidentally": {
"put": {
"tags": [
"tasque.CareTaskOccurrence"
],
"summary": "Find the next CareTaskOccurrence based on the id and a baseline search date and\nupdate only that found CareTaskOccurrence.",
"operationId": "tasque.CareTaskOccurrenceAPI.updateNextIncidentally",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifier of CareTaskOccurrence to update.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "date",
"in": "path",
"description": "The date from which the search for the next occurrence should be done",
"required": true,
"schema": {
"type": "string",
"format": "date"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.CareTaskOccurrence"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.CareTaskOccurrence"
}
}
}
}
},
"x-replacement-for": [
"/t/tasque/care_task_occurrences/{id}/next_date/{date}/update_incidentally"
]
}
},
"/v0/taken/care_task_occurrences/{id}/update_following": {
"put": {
"tags": [
"tasque.CareTaskOccurrence"
],
"summary": "Updates the given CareTaskOccurrence item and all of the following occurrences of that item",
"operationId": "tasque.CareTaskOccurrenceAPI.updateFollowing",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifier of CareTaskOccurrence to update.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.CareTaskOccurrence"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.CareTaskOccurrence"
}
}
}
}
},
"x-replacement-for": [
"/t/tasque/care_task_occurrences/{id}/update_following"
]
}
},
"/v0/taken/care_task_occurrences/{id}/update_incidentally": {
"put": {
"tags": [
"tasque.CareTaskOccurrence"
],
"summary": "Updates only the given CareTaskOccurrence item",
"operationId": "tasque.CareTaskOccurrenceAPI.updateIncidentally",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Identifier of CareTaskOccurrence to update.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.CareTaskOccurrence"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.CareTaskOccurrence"
}
}
}
}
},
"x-replacement-for": [
"/t/tasque/care_task_occurrences/{id}/update_incidentally"
]
}
},
"/v0/taken/care_task_occurrences/by_sub_type_id/{sub_type_id}": {
"get": {
"tags": [
"tasque.CareTaskOccurrence"
],
"summary": "Returns the care task occurrences for the given sub-type and sub-type query.",
"operationId": "tasque.CareTaskOccurrenceAPI.bySubType",
"parameters": [
{
"name": "sub_type_query",
"in": "query",
"description": "regex for sub_type",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sub_type_id",
"in": "path",
"description": "sub_type_id of task",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "No response was specified",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/tasque.list.CareTaskOccurrenceList"
}
}
}
}
},
"x-replacement-for": [
"/t/tasque/care_task_occurrences/by_sub_type_id/{sub_type_id}"
]
}
},
"/v0/taken/care_task_occurrences/client_ids_by_sub_type": {
"get": {
"tags": [
"tasque.CareTaskOccurrence"
],
"summary": "Query unique pairs [ \nEither an abosulte value or the sum of calculated value and deviation.\n Distances are ordered based on the underlying work (e.g. client visits) \nExpenses can either be manual or automatic. Manual expenses will simply consist of an {@link #amount}.\nAutomatic expenses are based on the {@link #calculatedAmount} that, combined with a {@link #deviation}, leads to the\nexpense {@link #amount}.\n \nA DSM 4 classification consists of 5 axis.\nThe speficication says:\n \n1 Klinische stoornis (bijv. depressie)\n2 Persoonlijkheidsstoornissen (bijv. afhankelijke persoonlijkheidsstoornis)\n3 Lichamelijke aandoeningen (relevant voor het begrijpen of behandelen van een psychische stoornis) (bijv. migraine)\n4 Psychosociale en omgevingsfactoren (bijv. scheiding, werkeloosheid )\n5 Algehele beoordeling van het functioneren (Global Assement of Functioning Scale, GAF) uitgedrukt op een schaal van 0 tot 100",
"format": "int32"
},
"diagnoseCode": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.Diagnose"
}
],
"description": "NZA Stamdata code for this diagnosis"
},
"zorgtrajectId": {
"type": "integer",
"description": "Object identifier for the corresponding Zorgtraject",
"format": "int64"
}
},
"description": "A diagnosis which has been assigned to a client.",
"example": {
"id": 1,
"externalId": 123,
"primair": true,
"trekkenVan": false,
"datum": "2016-08-18",
"diagnoseAs": 1,
"diagnoseCode": {
"id": 1,
"code": "000",
"begindatum": "2016-08-16",
"einddatum": "2016-08-16",
"omschrijving": "Traject",
"icd10": "UUU"
},
"zorgtrajectId": 1
}
},
"dbc.ggz.Diagnose": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dbc.StamData"
}
],
"properties": {
"groepcode": {
"type": "string",
"description": "Group for this diagnosis"
},
"element": {
"type": "string",
"description": "Element in group"
},
"zvzSubscore": {
"type": "integer",
"format": "int32"
},
"aanspraakType": {
"type": "string",
"description": "Possible values:\nNIET_VERZEKERD(0),\nVERZEKERD(1);"
},
"hierarchieniveau": {
"type": "integer",
"description": "The nesting level",
"format": "int32"
},
"selecteerbaar": {
"type": "string",
"description": "Whether the user may select this diagnosis\n\nNIET_SELECTEERBAAR(0)\nSELECTEERBAAR_DIEPSTE_NIVEAU(1)\nSELECTEERBAAR_DIEPER_NIVEAU_MOGELIJK(2)"
},
"sorteervolgorde": {
"type": "integer",
"description": "Sorting order",
"format": "int32"
},
"diagnoseAs": {
"type": "integer",
"description": "Possible values:\n1,2,3,4,5",
"format": "int32"
},
"icd9cm": {
"type": "string"
},
"icd10": {
"type": "string"
},
"prestatieniveau": {
"type": "string"
},
"prestatiecodeNaamgevingGGZ": {
"type": "string"
},
"prestatiecodeNaamgevingFZ": {
"type": "string"
},
"prestatiecodedeelGGZ": {
"type": "string"
},
"prestatiecodedeelFZ": {
"type": "string"
},
"parallelliteitscodeGGZ": {
"type": "string"
},
"parallelliteitscodeFZ": {
"type": "string"
},
"brancheIndicatie": {
"type": "string",
"description": "Possible values:\nBEIDE(0)\nGGZ(1)\nFZ(2)"
}
},
"description": "NZA code list values for Diagnosis",
"example": {
"id": 1,
"code": "act_2.6",
"begindatum": "2016-01-01",
"einddatum": "9999-12-31",
"omschrijving": "Leesstoornis",
"groepcode": "as1_1.01",
"element": "Leesstoornis",
"zvzSubscore": 2,
"aanspraakType": "2",
"hierarchieniveau": 3,
"selecteerbaar": "1",
"sorteervolgorde": 1000050,
"diagnoseAs": 1,
"icd9cm": "315.00",
"icd10": "F81.0",
"prestatieniveau": "fictief_a",
"prestatiecodeNaamgevingGGZ": "Overige stoornissen in de kindertijd",
"prestatiecodeNaamgevingFZ": "Stoornissen in de kindertijd",
"prestatiecodedeelGGZ": "17",
"prestatiecodedeelFZ": "1",
"parallelliteitscodeGGZ": "28",
"parallelliteitscodeFZ": "1",
"brancheIndicatie": "0"
}
},
"dbc.ggz.Subtraject": {
"required": [
"openingsdatum",
"debiteurType"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"description": "Object identifier",
"format": "int64",
"x-cupido-id": true
},
"externalId": {
"type": "integer",
"description": "References Administration's CareOrderProduct",
"format": "int64"
},
"externalProductToewijzingId": {
"type": "integer",
"description": "References beschikking (assigned CareOrderProduct)",
"format": "int64"
},
"zorgtraject": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.Zorgtraject"
}
],
"description": "The parent zorgtraject containing client and diagnosis information"
},
"identificatienummer": {
"type": "string",
"description": "Optional user-supplied reference id for this DBC\nby default, an automatically generated unused Long as string"
},
"openingsdatum": {
"type": "string",
"description": "Start date of this DBC",
"format": "date"
},
"sluitdatum": {
"type": "string",
"description": "End date of this DBC.\nIf null, this DBC is 'open'. If non-null, this DBC is 'closed'.",
"format": "date"
},
"redenSluiten": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.RedenSluiten"
}
],
"description": "Reason for ending this DBC, subject to validation in ons-dbc.\nPart of a code list of the NZA"
},
"zorgtype": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.Zorgtype"
}
],
"description": "Type of care provided in this DBC"
},
"regiebehandelaar": {
"type": "string",
"description": "use regiebehandelaar_id",
"deprecated": true,
"x-deprecated-since": "23-09-2022"
},
"regiebehandelaarId": {
"type": "integer",
"description": "Object identifier of Employee which is the regiebehandelaar",
"format": "int64"
},
"medebehandelaar": {
"type": "string",
"description": "use medebehandelaar_id",
"deprecated": true,
"x-deprecated-since": "23-09-2022"
},
"medebehandelaarId": {
"type": "integer",
"description": "Object identifier of Employee which is the tweede regiebehandelaar",
"format": "int64"
},
"circuitcode": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.Circuit"
}
],
"description": "The care circuit, dealing with youth, adult or forensic types of care\nPart of a code list of the NZA"
},
"soortVerwijzer": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.SoortVerwijzer"
}
],
"description": "The type of practitioner of this DBC\nPart of a code list of the NZA"
},
"verwijzerAgb": {
"type": "string",
"description": "The AGB code of the referrer for the client."
},
"debiteurType": {
"type": "string",
"description": "Debtor type for this subtraject\npossible values:\n- 'CLIENT', indicating a manually invoiced DBC\n- 'ZORGVERZEKERAAR', indicating an automatically invoiced DBC\n- 'CUSTOM', indicating a custom Debtor can be set (`customDebtor`)",
"default": "ZORGVERZEKERAAR"
},
"customDebtorId": {
"type": "integer",
"description": "Object identifier of Administration's Debtor that can be set as a custom debtor\nShould only be set when `debiteurType` equals `CUSTOM`",
"format": "int64"
},
"tijdschrijvenRegistraties": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.Tijdschrijven"
}
],
"xml": {
"name": "tijdschrijvenRegistratie"
}
},
"description": "List of administrative time registrations",
"xml": {
"wrapped": true
}
},
"dagbestedingRegistraties": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.Dagbesteding"
}
],
"xml": {
"name": "dagbestedingRegistratie"
}
},
"description": "List of day care activity registrations",
"xml": {
"wrapped": true
}
},
"verblijfsdagRegistraties": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.Verblijfsdag"
}
],
"xml": {
"name": "verblijfsdagRegistratie"
}
},
"description": "List of residencies",
"xml": {
"wrapped": true
}
},
"verrichtingRegistraties": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.Verrichting"
}
],
"xml": {
"name": "verrichtingRegistratie"
}
},
"description": "List of treatments",
"xml": {
"wrapped": true
}
},
"nevenDiagnosen": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.DiagnoseToekenning"
}
],
"xml": {
"name": "nevenDiagnose"
}
},
"description": "List of evaluative diagnoses",
"xml": {
"wrapped": true
}
},
"grouperResultaten": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.grouper.GrouperResultaat"
}
],
"xml": {
"name": "grouperResultaat"
}
},
"description": "List of derived declarable products based on registered time",
"xml": {
"wrapped": true
}
},
"excludeInvoicing": {
"type": "boolean",
"description": "When true: do not create invoices / declarations for this Subtraject",
"default": false,
"deprecated": true,
"x-deprecated-since": "20-11-2023"
},
"latestGrouperResultaat": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.grouper.GrouperResultaat"
}
],
"description": "The latest grouper resultaat for this DBC, ordered in time.\nCan be null if there is none.",
"xml": {
"name": "latestGrouperResultaat"
}
},
"numberOfDirectMinutes": {
"type": "integer",
"description": "The number of direct registered minutes",
"format": "int32"
},
"numberOfIndirectMinutes": {
"type": "integer",
"description": "The number of direct registered minutes",
"format": "int32"
},
"numberOfTravelMinutes": {
"type": "integer",
"description": "The number of direct registered minutes",
"format": "int32"
},
"lastRegistrationDate": {
"type": "string",
"description": "The last registration date.\nNull if there are no registrations.",
"format": "date-time"
},
"excludeInvoicingReason": {
"type": "string",
"description": "When excludeInvoicing is true: this string contains the reason why in free text"
},
"invoiced": {
"type": "boolean",
"description": "Value that tracks if the subtraject has been invoiced",
"deprecated": true,
"x-deprecated-since": "20-11-2023"
}
},
"description": "The corresponding dbc.ggz.Subtraject,\nOnly filled in when possible, can be null",
"example": {
"updatedAt": "2016-08-18T00:00:00.000+02:00",
"createdAt": "2016-08-18T00:00:00.000+02:00",
"createdBy": "Administrator",
"id": 1,
"externalId": 1,
"externalProductToewijzingId": 2,
"zorgtraject": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"externalId": 1,
"beschikkingExternalId": 1,
"clientId": 1,
"verwijzingId": 1,
"jeugd": true,
"privacyBezwaar": true,
"identificatienummer": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"soortVerwijzer": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example"
},
"verwijzerAgb": "example",
"zorgdomein": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example"
},
"uitvoerendeInstellingAgb": "example",
"primaireDiagnose": {
"id": 1,
"externalId": 1,
"primair": true,
"trekkenVan": true,
"datum": "2014-12-29",
"diagnoseAs": 1,
"diagnoseCode": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"zvzSubscore": 1,
"aanspraakType": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"diagnoseAs": 1,
"icd9cm": "example",
"icd10": "example",
"prestatieniveau": "example",
"prestatiecodeNaamgevingGGZ": "example",
"prestatiecodeNaamgevingFZ": "example",
"prestatiecodedeelGGZ": "example",
"prestatiecodedeelFZ": "example",
"parallelliteitscodeGGZ": "example",
"parallelliteitscodeFZ": "example",
"brancheIndicatie": "example"
},
"zorgtrajectId": 1
},
"fzSubtrajecten": [
{
"id": 1,
"openingsdatum": "2014-12-29",
"debiteurType": "example",
"excludeInvoicing": false
},
{
"id": 1,
"openingsdatum": "2014-12-29",
"debiteurType": "example",
"excludeInvoicing": false
}
]
},
"identificatienummer": "997881",
"openingsdatum": "2016-08-18",
"sluitdatum": "2016-08-18",
"redenSluiten": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"sorteervolgorde": 1,
"brancheIndicatie": "example"
},
"zorgtype": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"prestatiecodedeel": "example",
"brancheIndicatie": "example"
},
"regiebehandelaar": "12345678",
"regiebehandelaarId": 1,
"medebehandelaar": "87654321",
"medebehandelaarId": 2,
"circuitcode": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"sorteervolgorde": 1,
"brancheIndicatie": "example"
},
"soortVerwijzer": {
"id": 1,
"code": "01",
"begindatum": "2016-08-18",
"einddatum": "2016-08-18",
"omschrijving": "huisarts"
},
"verwijzerAgb": "12345678",
"debiteurType": "CUSTOM",
"customDebtorId": 1,
"tijdschrijvenRegistraties": [
{
"id": 1,
"identificatienummer": 1,
"activiteit": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"aanspraakType": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"soort": "example",
"magDirect": true,
"magIndirect": true,
"magReistijd": true,
"magGroep": true,
"brancheIndicatie": "example"
},
"datum": "2014-12-29",
"subtraject": {
"id": 1,
"openingsdatum": "2014-12-29",
"debiteurType": "example",
"excludeInvoicing": false
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"directeMinuten": 1,
"indirecteAlgemeneMinuten": 1,
"indirecteReistijdminuten": 1,
"behandelaar": "example",
"afleidbaar": true
},
{
"id": 1,
"identificatienummer": 1,
"activiteit": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"aanspraakType": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"soort": "example",
"magDirect": true,
"magIndirect": true,
"magReistijd": true,
"magGroep": true,
"brancheIndicatie": "example"
},
"datum": "2014-12-29",
"subtraject": {
"id": 1,
"openingsdatum": "2014-12-29",
"debiteurType": "example",
"excludeInvoicing": false
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"directeMinuten": 1,
"indirecteAlgemeneMinuten": 1,
"indirecteReistijdminuten": 1,
"behandelaar": "example",
"afleidbaar": true
}
],
"dagbestedingRegistraties": [
{
"id": 1,
"identificatienummer": 1,
"activiteit": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"aanspraakType": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"soort": "example",
"magDirect": true,
"magIndirect": true,
"magReistijd": true,
"magGroep": true,
"brancheIndicatie": "example"
},
"datum": "2014-12-29",
"subtraject": {
"id": 1,
"openingsdatum": "2014-12-29",
"debiteurType": "example",
"excludeInvoicing": false
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"aantalUren": 1,
"declaratiecode": "example"
},
{
"id": 1,
"identificatienummer": 1,
"activiteit": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"aanspraakType": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"soort": "example",
"magDirect": true,
"magIndirect": true,
"magReistijd": true,
"magGroep": true,
"brancheIndicatie": "example"
},
"datum": "2014-12-29",
"subtraject": {
"id": 1,
"openingsdatum": "2014-12-29",
"debiteurType": "example",
"excludeInvoicing": false
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"aantalUren": 1,
"declaratiecode": "example"
}
],
"verblijfsdagRegistraties": [
{
"id": 1,
"identificatienummer": 1,
"activiteit": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"aanspraakType": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"soort": "example",
"magDirect": true,
"magIndirect": true,
"magReistijd": true,
"magGroep": true,
"brancheIndicatie": "example"
},
"datum": "2014-12-29",
"subtraject": {
"id": 1,
"openingsdatum": "2014-12-29",
"debiteurType": "example",
"excludeInvoicing": false
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"aantalDagen": 1,
"declaratiecode": "example"
},
{
"id": 1,
"identificatienummer": 1,
"activiteit": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"aanspraakType": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"soort": "example",
"magDirect": true,
"magIndirect": true,
"magReistijd": true,
"magGroep": true,
"brancheIndicatie": "example"
},
"datum": "2014-12-29",
"subtraject": {
"id": 1,
"openingsdatum": "2014-12-29",
"debiteurType": "example",
"excludeInvoicing": false
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"aantalDagen": 1,
"declaratiecode": "example"
}
],
"verrichtingRegistraties": [
{
"id": 1,
"identificatienummer": 1,
"activiteit": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"aanspraakType": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"soort": "example",
"magDirect": true,
"magIndirect": true,
"magReistijd": true,
"magGroep": true,
"brancheIndicatie": "example"
},
"datum": "2014-12-29",
"subtraject": {
"id": 1,
"openingsdatum": "2014-12-29",
"debiteurType": "example",
"excludeInvoicing": false
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"aantalBehandelingen": 1,
"declaratiecode": "example"
},
{
"id": 1,
"identificatienummer": 1,
"activiteit": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"aanspraakType": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"soort": "example",
"magDirect": true,
"magIndirect": true,
"magReistijd": true,
"magGroep": true,
"brancheIndicatie": "example"
},
"datum": "2014-12-29",
"subtraject": {
"id": 1,
"openingsdatum": "2014-12-29",
"debiteurType": "example",
"excludeInvoicing": false
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"aantalBehandelingen": 1,
"declaratiecode": "example"
}
],
"nevenDiagnosen": [
{
"id": 1,
"externalId": 1,
"primair": true,
"trekkenVan": true,
"datum": "2014-12-29",
"diagnoseAs": 1,
"diagnoseCode": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"zvzSubscore": 1,
"aanspraakType": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"diagnoseAs": 1,
"icd9cm": "example",
"icd10": "example",
"prestatieniveau": "example",
"prestatiecodeNaamgevingGGZ": "example",
"prestatiecodeNaamgevingFZ": "example",
"prestatiecodedeelGGZ": "example",
"prestatiecodedeelFZ": "example",
"parallelliteitscodeGGZ": "example",
"parallelliteitscodeFZ": "example",
"brancheIndicatie": "example"
},
"zorgtrajectId": 1
},
{
"id": 1,
"externalId": 1,
"primair": true,
"trekkenVan": true,
"datum": "2014-12-29",
"diagnoseAs": 1,
"diagnoseCode": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"zvzSubscore": 1,
"aanspraakType": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"diagnoseAs": 1,
"icd9cm": "example",
"icd10": "example",
"prestatieniveau": "example",
"prestatiecodeNaamgevingGGZ": "example",
"prestatiecodeNaamgevingFZ": "example",
"prestatiecodedeelGGZ": "example",
"prestatiecodedeelFZ": "example",
"parallelliteitscodeGGZ": "example",
"parallelliteitscodeFZ": "example",
"brancheIndicatie": "example"
},
"zorgtrajectId": 1
}
],
"grouperResultaten": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"prestatiecode": "example",
"declaratiecode": "example",
"productgroep": "example",
"productGroep": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"codeBehandeling": "example",
"omschrijvingBehandeling": "example",
"setting": "example",
"categorie": "example",
"lekenvertaling": "example",
"diagnoseBlinderen": true,
"brancheIndicatie": "example"
},
"timestamp": "2014-12-29T00:00:00.000+01:00"
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"prestatiecode": "example",
"declaratiecode": "example",
"productgroep": "example",
"productGroep": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"codeBehandeling": "example",
"omschrijvingBehandeling": "example",
"setting": "example",
"categorie": "example",
"lekenvertaling": "example",
"diagnoseBlinderen": true,
"brancheIndicatie": "example"
},
"timestamp": "2014-12-29T00:00:00.000+01:00"
}
],
"excludeInvoicing": false,
"latestGrouperResultaat": {
"updatedAt": "2016-08-16T00:00:00.000+02:00",
"createdAt": "2016-08-16T00:00:00.000+02:00",
"createdBy": "Administrator",
"id": 1,
"prestatiecode": "101010001230",
"declaratiecode": "25B019",
"productgroep": "00230",
"productGroep": {
"id": 5,
"code": "00230",
"codeBehandeling": "123123",
"omschrijvingBehandeling": "Behandeling",
"setting": "setting",
"categorie": "GEEN",
"lekenvertaling": "Behandeling voor problemen",
"diagnoseBlinderen": false,
"brancheIndicatie": "GGZ"
},
"timestamp": "2016-03-15T00:00:00.000+01:00"
},
"numberOfDirectMinutes": 30,
"numberOfIndirectMinutes": 40,
"numberOfTravelMinutes": 50,
"lastRegistrationDate": "2010-10-10T00:00:00.000+02:00",
"excludeInvoicingReason": "we do not want it anymore",
"invoiced": false
}
},
"dbc.ggz.RedenSluiten": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dbc.StamData"
}
],
"properties": {
"sorteervolgorde": {
"type": "integer",
"description": "The order these values need to be sorted with",
"format": "int32"
},
"brancheIndicatie": {
"type": "string",
"description": "Possible values:\nBEIDE(0)\nGGZ(1)\nFZ(2)"
}
},
"description": "The reason for closing a DBC or DBBC (Subtraject)",
"example": {
"id": 1,
"code": "1",
"begindatum": "2000-01-01",
"einddatum": "9999-12-31",
"omschrijving": "Reden voor afsluiting bij patiënt niet bij behandelaar",
"sorteervolgorde": 10,
"brancheIndicatie": "0"
},
"xml": {
"name": "redenSluiten"
}
},
"dbc.ggz.Zorgtype": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dbc.StamData"
}
],
"properties": {
"groepcode": {
"type": "string",
"description": "Group for this type"
},
"element": {
"type": "string",
"description": "Element in group"
},
"hierarchieniveau": {
"type": "integer",
"description": "Nesting level",
"format": "int32"
},
"selecteerbaar": {
"type": "string",
"description": "Can this value be selected\n\nPossible values:\nNIET_SELECTEERBAAR(0)\nSELECTEERBAAR_DIEPSTE_NIVEAU(1)\nSELECTEERBAAR_DIEPER_NIVEAU_MOGELIJK(2)"
},
"sorteervolgorde": {
"type": "integer",
"description": "The sorting order",
"format": "int32"
},
"prestatiecodedeel": {
"type": "string",
"description": "Part of the declaration code"
},
"brancheIndicatie": {
"type": "string",
"description": "Possible values:\nBEIDE(0)\nGGZ(1)\nFZ(2)"
}
},
"description": "Type of care provided in this DBC",
"example": {
"id": 1,
"code": "100",
"begindatum": "2016-08-18",
"einddatum": "2016-08-18",
"omschrijving": "Initieel zorgtype",
"groepcode": "",
"element": "Initieel zorgtype",
"hierarchieniveau": 0,
"selecteerbaar": "0",
"sorteervolgorde": 30,
"prestatiecodedeel": "100",
"brancheIndicatie": "0"
},
"xml": {
"name": "zorgtype"
}
},
"dbc.ggz.Circuit": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dbc.StamData"
}
],
"properties": {
"sorteervolgorde": {
"type": "integer",
"description": "The order the values need to be sorted",
"format": "int32"
},
"brancheIndicatie": {
"type": "string",
"description": "Possible values:\nBEIDE(0)\nGGZ(1)\nFZ(2)"
}
},
"description": "The care circuit, dealing with youth, adult or forensic types of care\nPart of a code list of the NZA",
"example": {
"id": 1,
"code": "1",
"begindatum": "2000-01-01",
"einddatum": "9999-12-31",
"omschrijving": "Volwassenen lang",
"sorteervolgorde": 20,
"brancheIndicatie": "1"
}
},
"dbc.ggz.grouper.GrouperResultaat": {
"required": [
"prestatiecode",
"declaratiecode",
"productgroep",
"productGroep",
"timestamp"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"description": "Object identifier",
"format": "int64",
"x-cupido-id": true
},
"prestatiecode": {
"type": "string",
"description": "The calculated code of the prestatie."
},
"declaratiecode": {
"type": "string",
"description": "Code used for declaring the product."
},
"productgroep": {
"type": "string",
"description": "The product group which was calculated.\n\nWill be deleted after 2020-08-01",
"deprecated": true,
"x-deprecated-since": "01-08-2020"
},
"productGroep": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.ProductGroep"
}
],
"description": "The product group which was calculated."
},
"timestamp": {
"type": "string",
"description": "The time at which the result was calculated.",
"format": "date-time"
}
},
"description": "A 'grouping' result of a DBC or DBBC. This result is recalculated every time changes are made to the DBC/DBBC (Subtraject),\nZorgtraject or activities. Contains the necessary information for decalring the DBC/DBBC.",
"example": {
"updatedAt": "2016-08-16T00:00:00.000+02:00",
"createdAt": "2016-08-16T00:00:00.000+02:00",
"createdBy": "Administrator",
"id": 1,
"prestatiecode": "101010001230",
"declaratiecode": "25B019",
"productgroep": "00230",
"productGroep": {
"id": 5,
"code": "00230",
"codeBehandeling": "123123",
"omschrijvingBehandeling": "Behandeling",
"setting": "setting",
"categorie": "GEEN",
"lekenvertaling": "Behandeling voor problemen",
"diagnoseBlinderen": false,
"brancheIndicatie": "GGZ"
},
"timestamp": "2016-03-15T00:00:00.000+01:00"
},
"xml": {
"name": "grouperResultaat"
}
},
"dbc.ggz.ProductGroep": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dbc.StamData"
}
],
"properties": {
"codeBehandeling": {
"type": "string"
},
"omschrijvingBehandeling": {
"type": "string"
},
"setting": {
"type": "string"
},
"categorie": {
"type": "string"
},
"lekenvertaling": {
"type": "string"
},
"diagnoseBlinderen": {
"type": "boolean",
"deprecated": true,
"x-deprecated-since": "20-11-2023"
},
"brancheIndicatie": {
"type": "string"
}
},
"description": "The product group which was calculated.",
"example": {
"id": 1,
"code": "00230",
"begindatum": "2007-01-01",
"einddatum": "9999-12-31",
"omschrijving": "Psychodiagnostisch onderzoek",
"codeBehandeling": "123123",
"omschrijvingBehandeling": "Behandeling",
"setting": "setting",
"categorie": "GEEN",
"lekenvertaling": "Behandeling voor problemen",
"diagnoseBlinderen": false,
"brancheIndicatie": "GGZ"
},
"xml": {
"name": "productGroep"
}
},
"dbc.ggz.Tijdschrijven": {
"required": [
"directeMinuten",
"indirecteAlgemeneMinuten",
"indirecteReistijdminuten"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.Zorgactiviteit"
}
],
"properties": {
"directeMinuten": {
"type": "integer",
"description": "Number of minutes of activity with direct client contact",
"format": "int32",
"default": 0
},
"indirecteAlgemeneMinuten": {
"type": "integer",
"description": "Number of minutes of activity without direct client contact",
"format": "int32",
"default": 0
},
"indirecteReistijdminuten": {
"type": "integer",
"description": "Number of minutes of travel time",
"format": "int32",
"default": 0
},
"behandelaar": {
"type": "string",
"description": "The Practitioner's reference id in administration"
},
"afleidbaar": {
"type": "boolean",
"description": "True by default, ons-dbc determines the value of this attribute using\nthe behandelaar's profession and the definitions provided by Vektis below",
"default": true,
"deprecated": true,
"x-deprecated-since": "20-11-2023"
}
},
"description": "Tijdschrijven model (no description)",
"example": {
"id": 1,
"identificatienummer": 1,
"activiteit": {
"id": 1,
"code": "act_2.6",
"begindatum": "2007-01-01",
"einddatum": "9999-12-31",
"omschrijving": "Psychodiagnostisch onderzoek",
"groepcode": "act_2",
"element": "Psychodiagnostisch onderzoek",
"aanspraakType": "B",
"hierarchieniveau": 2,
"selecteerbaar": "0",
"sorteervolgorde": 90,
"soort": "Tijdschrijven",
"magDirect": false,
"magIndirect": false,
"magReistijd": false,
"magGroep": false,
"brancheIndicatie": "0"
},
"datum": "2016-08-18",
"subtraject": {
"updatedAt": "2016-08-18T00:00:00.000+02:00",
"createdAt": "2016-08-18T00:00:00.000+02:00",
"createdBy": "Administrator",
"id": 1,
"externalId": 1,
"externalProductToewijzingId": 2,
"identificatienummer": "997881",
"openingsdatum": "2016-08-18",
"sluitdatum": "2016-08-18",
"regiebehandelaar": "12345678",
"regiebehandelaarId": 1,
"medebehandelaar": "87654321",
"medebehandelaarId": 2,
"soortVerwijzer": {
"id": 1,
"code": "01",
"begindatum": "2016-08-18",
"einddatum": "2016-08-18",
"omschrijving": "huisarts"
},
"verwijzerAgb": "12345678",
"debiteurType": "CUSTOM",
"customDebtorId": 1,
"excludeInvoicing": false,
"latestGrouperResultaat": {
"updatedAt": "2016-08-16T00:00:00.000+02:00",
"createdAt": "2016-08-16T00:00:00.000+02:00",
"createdBy": "Administrator",
"id": 1,
"prestatiecode": "101010001230",
"declaratiecode": "25B019",
"productgroep": "00230",
"productGroep": {
"id": 5,
"code": "00230",
"codeBehandeling": "123123",
"omschrijvingBehandeling": "Behandeling",
"setting": "setting",
"categorie": "GEEN",
"lekenvertaling": "Behandeling voor problemen",
"diagnoseBlinderen": false,
"brancheIndicatie": "GGZ"
},
"timestamp": "2016-03-15T00:00:00.000+01:00"
},
"numberOfDirectMinutes": 30,
"numberOfIndirectMinutes": 40,
"numberOfTravelMinutes": 50,
"lastRegistrationDate": "2010-10-10T00:00:00.000+02:00",
"excludeInvoicingReason": "we do not want it anymore",
"invoiced": false
},
"updatedAt": "2016-08-18T00:00:00.000+02:00",
"createdAt": "2016-08-18T00:00:00.000+02:00",
"createdBy": "Administrator",
"directeMinuten": 1,
"indirecteAlgemeneMinuten": 1,
"indirecteReistijdminuten": 1,
"behandelaar": "Sjaak Knaak",
"afleidbaar": true
},
"xml": {
"name": "tijdschrijven"
}
},
"dbc.ggz.Zorgactiviteit": {
"required": [
"activiteit",
"datum",
"subtraject"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"description": "Object identifier",
"format": "int64",
"x-cupido-id": true
},
"identificatienummer": {
"type": "integer",
"description": "The object identifier of a Presence Log",
"format": "int64"
},
"activiteit": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.Activiteit"
}
],
"description": "The activity that the client performed"
},
"datum": {
"type": "string",
"description": "The date at which the activity occurred",
"format": "date"
},
"subtraject": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.Subtraject"
}
],
"description": "The DBC or DBBC (Subtraject) this activity belongs to."
}
},
"description": "A base class for an Activity which a client performs",
"example": {
"updatedAt": "2016-08-18T00:00:00.000+02:00",
"createdAt": "2016-08-18T00:00:00.000+02:00",
"createdBy": "Administrator",
"id": 1,
"identificatienummer": 3231,
"activiteit": {
"id": 1,
"code": "act_2.6"
},
"datum": "2016-08-18",
"subtraject": {
"id": 1,
"openingsdatum": "2016-08-18",
"debiteurType": "ZORGVERZEKERAAR",
"excludeInvoicing": false
}
}
},
"dbc.ggz.Activiteit": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dbc.StamData"
}
],
"properties": {
"groepcode": {
"type": "string",
"description": "Grouping of activity"
},
"element": {
"type": "string",
"description": "Element in group"
},
"aanspraakType": {
"type": "string",
"description": "Possible values:\nNIET_VERZEKERD(\"A\")\nVERZEKERD(\"B\")\nVERZEKERD_INDIEN_DIAGNOSE_ZONDER_AANSPRAAKBEPERKING(\"C\")\nVERZEKERD_INDIEN_DIAGNOSE_ZONDER_AANSPRAAKBEPERKING_MET_AFHANKELIJKHEDEN(\"D\")\nNIET_VERZEKERD_TENZIJ(\"E\")"
},
"hierarchieniveau": {
"type": "integer",
"description": "Nesting level",
"format": "int32"
},
"selecteerbaar": {
"type": "string",
"description": "NIET_SELECTEERBAAR(0)\nSELECTEERBAAR_DIEPSTE_NIVEAU(1)\nSELECTEERBAAR_DIEPER_NIVEAU_MOGELIJK(2)"
},
"sorteervolgorde": {
"type": "integer",
"description": "The order the activities need to be sorted",
"format": "int32"
},
"soort": {
"type": "string",
"description": "Possible values:\nTijdschrijven\nVerblijfsdag\nDagbesteding\nVerrichting"
},
"magDirect": {
"type": "boolean",
"description": "May there be direct time declared for this activity",
"deprecated": true,
"x-deprecated-since": "20-11-2023"
},
"magIndirect": {
"type": "boolean",
"description": "May there be indirect time declared for this activity",
"deprecated": true,
"x-deprecated-since": "20-11-2023"
},
"magReistijd": {
"type": "boolean",
"description": "May there be travel time declared for this activity",
"deprecated": true,
"x-deprecated-since": "20-11-2023"
},
"magGroep": {
"type": "boolean",
"description": "May this activity be performed by a group.",
"deprecated": true,
"x-deprecated-since": "20-11-2023"
},
"brancheIndicatie": {
"type": "string",
"description": "Possible values:\nBEIDE(0)\nGGZ(1)\nFZ(2)"
}
},
"description": "The activity that the client performed",
"example": {
"id": 1,
"code": "act_2.6",
"begindatum": "2007-01-01",
"einddatum": "9999-12-31",
"omschrijving": "Psychodiagnostisch onderzoek",
"groepcode": "act_2",
"element": "Psychodiagnostisch onderzoek",
"aanspraakType": "B",
"hierarchieniveau": 2,
"selecteerbaar": "0",
"sorteervolgorde": 90,
"soort": "Tijdschrijven",
"magDirect": false,
"magIndirect": false,
"magReistijd": false,
"magGroep": false,
"brancheIndicatie": "0"
},
"xml": {
"name": "activiteit"
}
},
"dbc.ggz.Dagbesteding": {
"required": [
"aantalUren"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.Zorgactiviteit"
}
],
"properties": {
"aantalUren": {
"type": "integer",
"description": "The number of hours of the duration of this Dagbesteding",
"format": "int32",
"default": 0
},
"declaratiecode": {
"type": "string",
"description": "The declaration code which will be used to declare this activity"
}
},
"description": "An activity which the client performs during the day",
"example": {
"id": 1,
"identificatienummer": 1,
"activiteit": {
"id": 1,
"code": "act_2.6",
"begindatum": "2007-01-01",
"einddatum": "9999-12-31",
"omschrijving": "Psychodiagnostisch onderzoek",
"groepcode": "act_2",
"element": "Psychodiagnostisch onderzoek",
"aanspraakType": "B",
"hierarchieniveau": 2,
"selecteerbaar": "0",
"sorteervolgorde": 90,
"soort": "Tijdschrijven",
"magDirect": false,
"magIndirect": false,
"magReistijd": false,
"magGroep": false,
"brancheIndicatie": "0"
},
"datum": "2016-08-18",
"subtraject": {
"updatedAt": "2016-08-18T00:00:00.000+02:00",
"createdAt": "2016-08-18T00:00:00.000+02:00",
"createdBy": "Administrator",
"id": 1,
"externalId": 1,
"externalProductToewijzingId": 2,
"identificatienummer": "997881",
"openingsdatum": "2016-08-18",
"sluitdatum": "2016-08-18",
"regiebehandelaar": "12345678",
"regiebehandelaarId": 1,
"medebehandelaar": "87654321",
"medebehandelaarId": 2,
"soortVerwijzer": {
"id": 1,
"code": "01",
"begindatum": "2016-08-18",
"einddatum": "2016-08-18",
"omschrijving": "huisarts"
},
"verwijzerAgb": "12345678",
"debiteurType": "CUSTOM",
"customDebtorId": 1,
"excludeInvoicing": false,
"latestGrouperResultaat": {
"updatedAt": "2016-08-16T00:00:00.000+02:00",
"createdAt": "2016-08-16T00:00:00.000+02:00",
"createdBy": "Administrator",
"id": 1,
"prestatiecode": "101010001230",
"declaratiecode": "25B019",
"productgroep": "00230",
"productGroep": {
"id": 5,
"code": "00230",
"codeBehandeling": "123123",
"omschrijvingBehandeling": "Behandeling",
"setting": "setting",
"categorie": "GEEN",
"lekenvertaling": "Behandeling voor problemen",
"diagnoseBlinderen": false,
"brancheIndicatie": "GGZ"
},
"timestamp": "2016-03-15T00:00:00.000+01:00"
},
"numberOfDirectMinutes": 30,
"numberOfIndirectMinutes": 40,
"numberOfTravelMinutes": 50,
"lastRegistrationDate": "2010-10-10T00:00:00.000+02:00",
"excludeInvoicingReason": "we do not want it anymore",
"invoiced": false
},
"updatedAt": "2016-08-18T00:00:00.000+02:00",
"createdAt": "2016-08-18T00:00:00.000+02:00",
"createdBy": "Administrator",
"aantalUren": 1,
"declaratiecode": "123AA"
}
},
"dbc.ggz.Verblijfsdag": {
"required": [
"aantalDagen"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.Zorgactiviteit"
}
],
"properties": {
"aantalDagen": {
"type": "integer",
"description": "Larger or equal to 0.\nThe number of days the client stayed at a location.",
"format": "int32",
"default": 0
},
"declaratiecode": {
"type": "string",
"description": "Code used for declaring this activity"
}
},
"description": "A period of time that a client has stayed at a location.",
"example": {
"id": 1,
"identificatienummer": 1,
"activiteit": {
"id": 1,
"code": "act_2.6",
"begindatum": "2007-01-01",
"einddatum": "9999-12-31",
"omschrijving": "Psychodiagnostisch onderzoek",
"groepcode": "act_2",
"element": "Psychodiagnostisch onderzoek",
"aanspraakType": "B",
"hierarchieniveau": 2,
"selecteerbaar": "0",
"sorteervolgorde": 90,
"soort": "Tijdschrijven",
"magDirect": false,
"magIndirect": false,
"magReistijd": false,
"magGroep": false,
"brancheIndicatie": "0"
},
"datum": "2016-08-18",
"subtraject": {
"updatedAt": "2016-08-18T00:00:00.000+02:00",
"createdAt": "2016-08-18T00:00:00.000+02:00",
"createdBy": "Administrator",
"id": 1,
"externalId": 1,
"externalProductToewijzingId": 2,
"identificatienummer": "997881",
"openingsdatum": "2016-08-18",
"sluitdatum": "2016-08-18",
"regiebehandelaar": "12345678",
"regiebehandelaarId": 1,
"medebehandelaar": "87654321",
"medebehandelaarId": 2,
"soortVerwijzer": {
"id": 1,
"code": "01",
"begindatum": "2016-08-18",
"einddatum": "2016-08-18",
"omschrijving": "huisarts"
},
"verwijzerAgb": "12345678",
"debiteurType": "CUSTOM",
"customDebtorId": 1,
"excludeInvoicing": false,
"latestGrouperResultaat": {
"updatedAt": "2016-08-16T00:00:00.000+02:00",
"createdAt": "2016-08-16T00:00:00.000+02:00",
"createdBy": "Administrator",
"id": 1,
"prestatiecode": "101010001230",
"declaratiecode": "25B019",
"productgroep": "00230",
"productGroep": {
"id": 5,
"code": "00230",
"codeBehandeling": "123123",
"omschrijvingBehandeling": "Behandeling",
"setting": "setting",
"categorie": "GEEN",
"lekenvertaling": "Behandeling voor problemen",
"diagnoseBlinderen": false,
"brancheIndicatie": "GGZ"
},
"timestamp": "2016-03-15T00:00:00.000+01:00"
},
"numberOfDirectMinutes": 30,
"numberOfIndirectMinutes": 40,
"numberOfTravelMinutes": 50,
"lastRegistrationDate": "2010-10-10T00:00:00.000+02:00",
"excludeInvoicingReason": "we do not want it anymore",
"invoiced": false
},
"updatedAt": "2016-08-18T00:00:00.000+02:00",
"createdAt": "2016-08-18T00:00:00.000+02:00",
"createdBy": "Administrator",
"aantalDagen": 1,
"declaratiecode": "123AA"
},
"xml": {
"name": "verblijfsdag"
}
},
"dbc.ggz.Verrichting": {
"required": [
"aantalBehandelingen"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.Zorgactiviteit"
}
],
"properties": {
"aantalBehandelingen": {
"type": "integer",
"description": "Number of treatments",
"format": "int32"
},
"declaratiecode": {
"type": "string",
"description": "Declaration code"
}
},
"description": "Some operation/treatment that has been performed on/with the client, such as Electroconvulsive therapy (ECT)",
"example": {
"id": 1,
"identificatienummer": 1,
"activiteit": {
"id": 1,
"code": "act_2.6",
"begindatum": "2007-01-01",
"einddatum": "9999-12-31",
"omschrijving": "Psychodiagnostisch onderzoek",
"groepcode": "act_2",
"element": "Psychodiagnostisch onderzoek",
"aanspraakType": "B",
"hierarchieniveau": 2,
"selecteerbaar": "0",
"sorteervolgorde": 90,
"soort": "Tijdschrijven",
"magDirect": false,
"magIndirect": false,
"magReistijd": false,
"magGroep": false,
"brancheIndicatie": "0"
},
"datum": "2016-08-18",
"subtraject": {
"updatedAt": "2016-08-18T00:00:00.000+02:00",
"createdAt": "2016-08-18T00:00:00.000+02:00",
"createdBy": "Administrator",
"id": 1,
"externalId": 1,
"externalProductToewijzingId": 2,
"identificatienummer": "997881",
"openingsdatum": "2016-08-18",
"sluitdatum": "2016-08-18",
"regiebehandelaar": "12345678",
"regiebehandelaarId": 1,
"medebehandelaar": "87654321",
"medebehandelaarId": 2,
"soortVerwijzer": {
"id": 1,
"code": "01",
"begindatum": "2016-08-18",
"einddatum": "2016-08-18",
"omschrijving": "huisarts"
},
"verwijzerAgb": "12345678",
"debiteurType": "CUSTOM",
"customDebtorId": 1,
"excludeInvoicing": false,
"latestGrouperResultaat": {
"updatedAt": "2016-08-16T00:00:00.000+02:00",
"createdAt": "2016-08-16T00:00:00.000+02:00",
"createdBy": "Administrator",
"id": 1,
"prestatiecode": "101010001230",
"declaratiecode": "25B019",
"productgroep": "00230",
"productGroep": {
"id": 5,
"code": "00230",
"codeBehandeling": "123123",
"omschrijvingBehandeling": "Behandeling",
"setting": "setting",
"categorie": "GEEN",
"lekenvertaling": "Behandeling voor problemen",
"diagnoseBlinderen": false,
"brancheIndicatie": "GGZ"
},
"timestamp": "2016-03-15T00:00:00.000+01:00"
},
"numberOfDirectMinutes": 30,
"numberOfIndirectMinutes": 40,
"numberOfTravelMinutes": 50,
"lastRegistrationDate": "2010-10-10T00:00:00.000+02:00",
"excludeInvoicingReason": "we do not want it anymore",
"invoiced": false
},
"updatedAt": "2016-08-18T00:00:00.000+02:00",
"createdAt": "2016-08-18T00:00:00.000+02:00",
"createdBy": "Administrator",
"aantalBehandelingen": 1,
"declaratiecode": "123AA"
},
"xml": {
"name": "verrichting"
}
},
"dbc.ggz.fz.Subtraject": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.Subtraject"
}
],
"properties": {
"aardDelict": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.fz.AardDelict"
}
],
"description": "The type of delinquency"
},
"vluchtGevaar": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.fz.Gevaar"
}
],
"description": "The measure of danger the client may flee"
},
"recidiveGevaar": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.fz.Gevaar"
}
],
"description": "The measure of danger the client may relapse"
},
"fysiekGevaar": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.fz.Gevaar"
}
],
"description": "The measure of danger the client may perform physical harm"
},
"plaatsingsbesluitnummer": {
"type": "string",
"description": "The identifier for the placement of the client in a facility."
},
"strafrechtketennummer": {
"type": "string",
"description": "SKN identifier that identifies a person in a forensic delict"
},
"forensischeZorgtitel": {
"$ref": "#/components/schemas/dbc.ggz.fz.ForensischeZorgtitel"
}
},
"description": "A Forensic DBBC.\nCauses the creation of a ForensicCareOrder.",
"example": {
"id": 1,
"externalId": 1,
"externalProductToewijzingId": 2,
"zorgtraject": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"externalId": 1,
"beschikkingExternalId": 1,
"clientId": 1,
"verwijzingId": 1,
"jeugd": true,
"privacyBezwaar": true,
"identificatienummer": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"soortVerwijzer": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example"
},
"verwijzerAgb": "example",
"zorgdomein": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example"
},
"uitvoerendeInstellingAgb": "example",
"primaireDiagnose": {
"id": 1,
"externalId": 1,
"primair": true,
"trekkenVan": true,
"datum": "2014-12-29",
"diagnoseAs": 1,
"diagnoseCode": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"zvzSubscore": 1,
"aanspraakType": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"diagnoseAs": 1,
"icd9cm": "example",
"icd10": "example",
"prestatieniveau": "example",
"prestatiecodeNaamgevingGGZ": "example",
"prestatiecodeNaamgevingFZ": "example",
"prestatiecodedeelGGZ": "example",
"prestatiecodedeelFZ": "example",
"parallelliteitscodeGGZ": "example",
"parallelliteitscodeFZ": "example",
"brancheIndicatie": "example"
},
"zorgtrajectId": 1
},
"subtrajecten": [
{
"id": 1,
"openingsdatum": "2014-12-29",
"debiteurType": "example",
"excludeInvoicing": false
},
{
"id": 1,
"openingsdatum": "2014-12-29",
"debiteurType": "example",
"excludeInvoicing": false
}
]
},
"identificatienummer": "997881",
"openingsdatum": "2016-08-18",
"sluitdatum": "2016-08-18",
"redenSluiten": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"sorteervolgorde": 1,
"brancheIndicatie": "example"
},
"zorgtype": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"prestatiecodedeel": "example",
"brancheIndicatie": "example"
},
"regiebehandelaar": "12345678",
"regiebehandelaarId": 1,
"medebehandelaar": "87654321",
"medebehandelaarId": 2,
"circuitcode": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"sorteervolgorde": 1,
"brancheIndicatie": "example"
},
"soortVerwijzer": {
"id": 1,
"code": "01",
"begindatum": "2016-08-18",
"einddatum": "2016-08-18",
"omschrijving": "huisarts"
},
"verwijzerAgb": "12345678",
"debiteurType": "CUSTOM",
"customDebtorId": 1,
"tijdschrijvenRegistraties": [
{
"id": 1,
"identificatienummer": 1,
"activiteit": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"aanspraakType": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"soort": "example",
"magDirect": true,
"magIndirect": true,
"magReistijd": true,
"magGroep": true,
"brancheIndicatie": "example"
},
"datum": "2014-12-29",
"subtraject": {
"id": 1,
"openingsdatum": "2014-12-29",
"debiteurType": "example",
"excludeInvoicing": false
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"directeMinuten": 1,
"indirecteAlgemeneMinuten": 1,
"indirecteReistijdminuten": 1,
"behandelaar": "example",
"afleidbaar": true
},
{
"id": 1,
"identificatienummer": 1,
"activiteit": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"aanspraakType": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"soort": "example",
"magDirect": true,
"magIndirect": true,
"magReistijd": true,
"magGroep": true,
"brancheIndicatie": "example"
},
"datum": "2014-12-29",
"subtraject": {
"id": 1,
"openingsdatum": "2014-12-29",
"debiteurType": "example",
"excludeInvoicing": false
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"directeMinuten": 1,
"indirecteAlgemeneMinuten": 1,
"indirecteReistijdminuten": 1,
"behandelaar": "example",
"afleidbaar": true
}
],
"dagbestedingRegistraties": [
{
"id": 1,
"identificatienummer": 1,
"activiteit": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"aanspraakType": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"soort": "example",
"magDirect": true,
"magIndirect": true,
"magReistijd": true,
"magGroep": true,
"brancheIndicatie": "example"
},
"datum": "2014-12-29",
"subtraject": {
"id": 1,
"openingsdatum": "2014-12-29",
"debiteurType": "example",
"excludeInvoicing": false
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"aantalUren": 1,
"declaratiecode": "example"
},
{
"id": 1,
"identificatienummer": 1,
"activiteit": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"aanspraakType": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"soort": "example",
"magDirect": true,
"magIndirect": true,
"magReistijd": true,
"magGroep": true,
"brancheIndicatie": "example"
},
"datum": "2014-12-29",
"subtraject": {
"id": 1,
"openingsdatum": "2014-12-29",
"debiteurType": "example",
"excludeInvoicing": false
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"aantalUren": 1,
"declaratiecode": "example"
}
],
"verblijfsdagRegistraties": [
{
"id": 1,
"identificatienummer": 1,
"activiteit": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"aanspraakType": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"soort": "example",
"magDirect": true,
"magIndirect": true,
"magReistijd": true,
"magGroep": true,
"brancheIndicatie": "example"
},
"datum": "2014-12-29",
"subtraject": {
"id": 1,
"openingsdatum": "2014-12-29",
"debiteurType": "example",
"excludeInvoicing": false
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"aantalDagen": 1,
"declaratiecode": "example"
},
{
"id": 1,
"identificatienummer": 1,
"activiteit": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"aanspraakType": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"soort": "example",
"magDirect": true,
"magIndirect": true,
"magReistijd": true,
"magGroep": true,
"brancheIndicatie": "example"
},
"datum": "2014-12-29",
"subtraject": {
"id": 1,
"openingsdatum": "2014-12-29",
"debiteurType": "example",
"excludeInvoicing": false
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"aantalDagen": 1,
"declaratiecode": "example"
}
],
"verrichtingRegistraties": [
{
"id": 1,
"identificatienummer": 1,
"activiteit": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"aanspraakType": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"soort": "example",
"magDirect": true,
"magIndirect": true,
"magReistijd": true,
"magGroep": true,
"brancheIndicatie": "example"
},
"datum": "2014-12-29",
"subtraject": {
"id": 1,
"openingsdatum": "2014-12-29",
"debiteurType": "example",
"excludeInvoicing": false
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"aantalBehandelingen": 1,
"declaratiecode": "example"
},
{
"id": 1,
"identificatienummer": 1,
"activiteit": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"aanspraakType": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"soort": "example",
"magDirect": true,
"magIndirect": true,
"magReistijd": true,
"magGroep": true,
"brancheIndicatie": "example"
},
"datum": "2014-12-29",
"subtraject": {
"id": 1,
"openingsdatum": "2014-12-29",
"debiteurType": "example",
"excludeInvoicing": false
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"aantalBehandelingen": 1,
"declaratiecode": "example"
}
],
"nevenDiagnosen": [
{
"id": 1,
"externalId": 1,
"primair": true,
"trekkenVan": true,
"datum": "2014-12-29",
"diagnoseAs": 1,
"diagnoseCode": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"zvzSubscore": 1,
"aanspraakType": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"diagnoseAs": 1,
"icd9cm": "example",
"icd10": "example",
"prestatieniveau": "example",
"prestatiecodeNaamgevingGGZ": "example",
"prestatiecodeNaamgevingFZ": "example",
"prestatiecodedeelGGZ": "example",
"prestatiecodedeelFZ": "example",
"parallelliteitscodeGGZ": "example",
"parallelliteitscodeFZ": "example",
"brancheIndicatie": "example"
},
"zorgtrajectId": 1
},
{
"id": 1,
"externalId": 1,
"primair": true,
"trekkenVan": true,
"datum": "2014-12-29",
"diagnoseAs": 1,
"diagnoseCode": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"zvzSubscore": 1,
"aanspraakType": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"diagnoseAs": 1,
"icd9cm": "example",
"icd10": "example",
"prestatieniveau": "example",
"prestatiecodeNaamgevingGGZ": "example",
"prestatiecodeNaamgevingFZ": "example",
"prestatiecodedeelGGZ": "example",
"prestatiecodedeelFZ": "example",
"parallelliteitscodeGGZ": "example",
"parallelliteitscodeFZ": "example",
"brancheIndicatie": "example"
},
"zorgtrajectId": 1
}
],
"grouperResultaten": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"prestatiecode": "example",
"declaratiecode": "example",
"productgroep": "example",
"productGroep": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"codeBehandeling": "example",
"omschrijvingBehandeling": "example",
"setting": "example",
"categorie": "example",
"lekenvertaling": "example",
"diagnoseBlinderen": true,
"brancheIndicatie": "example"
},
"timestamp": "2014-12-29T00:00:00.000+01:00"
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"prestatiecode": "example",
"declaratiecode": "example",
"productgroep": "example",
"productGroep": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"codeBehandeling": "example",
"omschrijvingBehandeling": "example",
"setting": "example",
"categorie": "example",
"lekenvertaling": "example",
"diagnoseBlinderen": true,
"brancheIndicatie": "example"
},
"timestamp": "2014-12-29T00:00:00.000+01:00"
}
],
"excludeInvoicing": false,
"latestGrouperResultaat": {
"updatedAt": "2016-08-16T00:00:00.000+02:00",
"createdAt": "2016-08-16T00:00:00.000+02:00",
"createdBy": "Administrator",
"id": 1,
"prestatiecode": "101010001230",
"declaratiecode": "25B019",
"productgroep": "00230",
"productGroep": {
"id": 5,
"code": "00230",
"codeBehandeling": "123123",
"omschrijvingBehandeling": "Behandeling",
"setting": "setting",
"categorie": "GEEN",
"lekenvertaling": "Behandeling voor problemen",
"diagnoseBlinderen": false,
"brancheIndicatie": "GGZ"
},
"timestamp": "2016-03-15T00:00:00.000+01:00"
},
"numberOfDirectMinutes": 30,
"numberOfIndirectMinutes": 40,
"numberOfTravelMinutes": 50,
"lastRegistrationDate": "2010-10-10T00:00:00.000+02:00",
"excludeInvoicingReason": "we do not want it anymore",
"invoiced": false,
"updatedAt": "2016-08-18T00:00:00.000+02:00",
"createdAt": "2016-08-18T00:00:00.000+02:00",
"createdBy": "Administrator",
"aardDelict": {
"id": 1,
"code": "1",
"begindatum": "2000-01-01",
"einddatum": "9999-12-31",
"omschrijving": "Test aardDelict!"
},
"vluchtGevaar": {
"id": 1,
"code": "1",
"begindatum": "2000-01-01",
"einddatum": "9999-12-31",
"omschrijving": "Test vluchtGevaar!"
},
"recidiveGevaar": {
"id": 1,
"code": "1",
"begindatum": "2000-01-01",
"einddatum": "9999-12-31",
"omschrijving": "Test recidiveGevaar!"
},
"fysiekGevaar": {
"id": 1,
"code": "1",
"begindatum": "2000-01-01",
"einddatum": "9999-12-31",
"omschrijving": "Test fysiekGevaar!"
},
"plaatsingsbesluitnummer": "123",
"strafrechtketennummer": "789789",
"forensischeZorgtitel": {
"id": 1,
"code": "1",
"omschrijving": "Test zorgtitel!",
"begindatum": "2000-01-01",
"einddatum": "9999-12-31"
}
},
"xml": {
"name": "fzSubtraject"
}
},
"dbc.ggz.fz.ForensischeZorgtitel": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Object identifier",
"format": "int64",
"x-cupido-id": true
},
"code": {
"type": "string",
"description": "Zorgtitle code from stamdata"
},
"omschrijving": {
"type": "string",
"description": "The caretitle description, as given in the stamdata"
},
"begindatum": {
"type": "string",
"description": "The startdate of the caretitle",
"format": "date"
},
"einddatum": {
"type": "string",
"description": "The enddate eof the caretitle",
"format": "date"
}
},
"description": "Forensic care title which defines the funding basis for compensation with DJI",
"example": {
"id": 1,
"code": "1",
"omschrijving": "Test zorgtitel!",
"begindatum": "2000-01-01",
"einddatum": "9999-12-31"
}
},
"dbc.ggz.fz.AardDelict": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dbc.StamData"
}
],
"description": "The type of delinquency the client performed",
"example": {
"id": 1,
"code": "1",
"begindatum": "2000-01-01",
"einddatum": "9999-12-31",
"omschrijving": "Test aard delict!"
}
},
"dbc.ggz.fz.Gevaar": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dbc.StamData"
}
],
"description": "The measure of danger this client imposes",
"example": {
"id": 1,
"code": "1",
"begindatum": "2000-01-01",
"einddatum": "9999-12-31",
"omschrijving": "Test gevaar!"
}
},
"dbc.ggz.list.DiagnoseToekenningList": {
"type": "object",
"properties": {
"diagnoseToekenningen": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.DiagnoseToekenning"
}
],
"xml": {
"name": "diagnoseToekenning"
}
}
}
},
"description": "DiagnoseToekenningList model (no description)",
"example": {
"diagnoseToekenningen": [
{
"id": 1,
"externalId": 1,
"primair": true,
"trekkenVan": false,
"datum": "2016-08-19",
"diagnoseCode": {
"id": 1,
"code": "000",
"begindatum": "2016-08-16",
"einddatum": "2016-08-16",
"omschrijving": "Traject",
"icd10": "UUU"
},
"zorgtrajectId": 1
}
]
},
"xml": {
"name": "diagnoseToekenningen"
}
},
"dienst_verwijzen_module.BundleWrapper": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"type": "string",
"description": "Data from original HL7 FHIR DSTU3 bundle. Contains JSON."
}
},
"description": "BundleWrapper model for transporting HL7 FHIR DSTU3 bundle data to the Dienst Verwijzen module.",
"example": {
"data": "bundlejson"
}
},
"dossier.admin.alerts.Topic": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Object id of this alert topic",
"format": "int64",
"x-cupido-id": true
},
"name": {
"type": "string",
"description": "The name of the alert topic"
},
"active": {
"type": "boolean",
"description": "Whether or not the topic is active"
},
"protocol": {
"type": "string",
"description": "The protocol associated with this alert topic"
},
"showDescription": {
"type": "boolean",
"description": "Whether or not an extra description input should be shown when creating\nan alert with this topic for a client"
},
"alertType": {
"type": "string",
"description": "The type of alert. Can be:\n- danger_medical\n- danger_non_medical\n- other"
},
"icon": {
"type": "string",
"description": "The name of the icon associated with this alert"
}
},
"description": "Topic model (no description)",
"example": {
"id": 1,
"name": "Covid-19",
"active": true,
"protocol": "http://www.example.org",
"showDescription": true,
"alertType": "danger_medical",
"icon": "virus"
}
},
"dossier.Alert": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.MedicalBase"
}
],
"properties": {
"name": {
"type": "string",
"description": "Name of this alert"
},
"type": {
"type": "string",
"description": "The type of alert"
},
"icon": {
"type": "string",
"description": "Name of Ivy icon to show for this alert"
},
"iconUrl": {
"type": "string",
"description": "The URL for the icon for this alert"
},
"iconPngUrl": {
"type": "string",
"description": "The PNG URL for the icon for this alert"
},
"protocol": {
"type": "string",
"description": "Protocol for this alert"
},
"description": {
"type": "string",
"description": "Description of this alert"
},
"beginDate": {
"type": "string",
"description": "Begin date of this alert",
"format": "date"
},
"endDate": {
"type": "string",
"description": "End date of this alert",
"format": "date"
},
"active": {
"type": "boolean",
"description": "Whether or not the alert is currently active\nAn alert is active when the day of retrieval falls between the begin and end dates"
},
"topicId": {
"type": "integer",
"description": "The ID of the topic this alert is linked to",
"format": "int64"
},
"authorizedExpertiseProfileIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Only users with these expertise profiles are allowed to access this alert"
},
"authorizedExpertiseGroupIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Only users with these expertise groups are allowed to access this alert"
},
"encodings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.Encoding"
},
"description": "The encodings of this alert"
},
"feederAuditContentStore": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.FeederAuditContentStoreType"
}
],
"description": "Identifier of the content store that is providing this content"
},
"feederAuditContentId": {
"type": "string",
"description": "Identifier referencing the original content in the feederAuditContentStore"
},
"feederAuditSenderName": {
"type": "string",
"description": "Name of the sender of the original content"
},
"feederAuditTransferType": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.FeederAuditTransferType"
}
],
"description": "Type of the transfer containing this content (a.k.a. the use case)"
}
},
"description": "Alert model (no description)",
"example": {
"id": 1,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 4,
"createdById": 1,
"updatedById": 1,
"createdAt": "2020-11-10T12:00:00.000+01:00",
"updatedAt": "2020-11-10T12:00:00.000+01:00",
"name": "MRSA",
"type": "Agressie",
"icon": "virus",
"iconUrl": "http://www.example.com",
"iconPngUrl": "http://www.example.com",
"protocol": "http://www.example.com",
"description": "Some additional text",
"beginDate": "2021-01-01",
"endDate": "2021-02-06",
"active": true,
"topicId": 1,
"authorizedExpertiseProfileIds": [
1,
2
],
"authorizedExpertiseGroupIds": [
3,
4
],
"encodings": [
{
"code": "61372001",
"codeSystem": "SNOMED CT",
"displayName": "aggression"
}
],
"feederAuditContentStore": "ons_ketenverkeer",
"feederAuditContentId": "abz123",
"feederAuditSenderName": "Some care organisation",
"feederAuditTransferType": "eoverdracht_nursing"
}
},
"dossier.medical.MedicalBase": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"nullable": true,
"x-cupido-id": true
},
"uuid": {
"type": "string",
"nullable": true
},
"clientId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"createdById": {
"type": "integer",
"format": "int64",
"nullable": true
},
"updatedById": {
"type": "integer",
"format": "int64",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"description": "MedicalBase model (no description)",
"example": {
"id": 1,
"uuid": "Dummy",
"clientId": 1,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-10T00:00:00.000+01:00",
"updatedAt": "2014-11-10T00:00:00.000+01:00"
}
},
"dossier.Encoding": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"codeSystem": {
"type": "string"
},
"displayName": {
"type": "string",
"description": "The display name (or title) corresponding to the code in its code system"
}
},
"description": "Encoding",
"example": {
"code": "E10",
"codeSystem": "ICD-10",
"displayName": "Type 1-diabetes"
}
},
"dossier.FeederAuditContentStoreType": {
"enum": [
"ons_ketenverkeer",
"other"
],
"type": "string",
"description": "Identifier of the content store that is providing this content",
"example": "ons_ketenverkeer"
},
"dossier.FeederAuditTransferType": {
"enum": [
"eoverdracht_nursing",
"anw",
"other"
],
"type": "string",
"description": "Type of the transfer containing this content (a.k.a. the use case)",
"example": "eoverdracht_nursing"
},
"dossier.medical.PropensityToAdverseReaction": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.MedicalBase"
}
],
"properties": {
"causeBuilders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.CauseBuilder"
}
},
"cause": {
"type": "string",
"description": "Deprecated since: 22-02-2022 - use causative_agent instead\n( the `name` field of causative_agent is equivalent to the name of this cause(.destination.name) )",
"deprecated": true
},
"causativeAgent": {
"$ref": "#/components/schemas/dossier.medical.encoded_concepts.CausativeAgent"
},
"manifestations": {
"type": "array",
"items": {
"type": "string"
}
},
"active": {
"type": "boolean"
},
"specification": {
"type": "string"
},
"narrative": {
"type": "string"
},
"certainty": {
"type": "string"
},
"severity": {
"type": "string"
},
"course": {
"type": "string"
},
"onsetPeriodOfLife": {
"type": "string"
},
"onsetApproximateDate": {
"type": "string"
},
"diagnosis": {
"$ref": "#/components/schemas/dossier.snomed.ClinicalFinding"
},
"feederAuditContentStore": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.FeederAuditContentStoreType"
}
],
"description": "Identifier of the content store that is providing this content"
},
"feederAuditContentId": {
"type": "string",
"description": "Identifier referencing the original content in the feederAuditContentStore"
},
"feederAuditSenderName": {
"type": "string",
"description": "Name of the sender of the original content"
},
"feederAuditTransferType": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.FeederAuditTransferType"
}
],
"description": "Type of the transfer containing this content (a.k.a. the use case)"
},
"immutable": {
"type": "boolean",
"description": "Whether or not the propensity to adverse reaction is immutable"
}
},
"description": "PropensityToAdverseReaction model (no description)",
"example": {
"id": 1,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 4,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-10T12:00:00.000+01:00",
"updatedAt": "2014-11-10T12:00:00.000+01:00",
"causeBuilders": [
{
"system": "CUSTOM",
"query": "Stofmijt"
},
{
"system": "SNOMED",
"query": "256259004 | pollen |",
"name": "Pollen"
}
],
"cause": "Haar van dieren",
"causativeAgent": {
"name": "Haar/schilfers van dieren",
"encodings": [
{
"code": "264287008",
"codeSystem": "SNOMED CT",
"displayName": "animal dander"
}
]
},
"manifestations": [
"Diarree",
"Misselijkheid",
"Duizeligheid"
],
"active": true,
"specification": "Specificatie",
"narrative": "Het doet zeer",
"certainty": "Ik ben er niet zo zeker van",
"severity": "Niet levensbedreigend",
"course": "De afgelopen twee weken",
"onsetPeriodOfLife": "Vanaf kleuterperiode",
"onsetApproximateDate": "2014",
"diagnosis": "allergy",
"feederAuditContentStore": "ons_ketenverkeer",
"feederAuditContentId": "abz123",
"feederAuditSenderName": "Some care organisation",
"feederAuditTransferType": "eoverdracht_nursing",
"immutable": true
}
},
"dossier.medical.encoded_concepts.CausativeAgent": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"encodings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.Encoding"
}
}
},
"description": "CausativeAgent model (no description)",
"example": {
"name": "Aardbeien",
"encodings": [
{
"code": "102261002",
"codeSystem": "SNOMED CT",
"displayName": "strawberry"
}
]
}
},
"dossier.snomed.ClinicalFinding": {
"enum": [
"allergy",
"adverse_reaction"
],
"type": "string",
"description": "ClinicalFinding enum (no description)",
"example": "allergy"
},
"dossier.medical.CauseBuilder": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.RelationshipBuilder"
}
],
"description": "CauseBuilder model (no description)",
"example": {
"system": "SNOMED",
"query": "256259004 | pollen |",
"name": "Pollen"
}
},
"dossier.medical.RelationshipBuilder": {
"type": "object",
"properties": {
"system": {
"type": "string",
"description": "Which code system this builder should query\nCan be any of CUSTOM, SNOMED, ICD-10, ICPC-1 or ICPC-2",
"nullable": true
},
"query": {
"type": "string",
"description": "Query used to build the correct concept within the given code system.\nWill use the first concept within the code system that matches the query,\nfor the best results your query should be as close as possible to a complete code from the system",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
},
"description": "RelationshipBuilder model (no description)",
"example": {
"system": "Dummy",
"query": "Dummy",
"name": "Dummy"
}
},
"dossier.RestrictiveMeasureRegistration": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The id of this registration",
"format": "int64",
"nullable": true,
"x-cupido-id": true
},
"restrictiveMeasureEntryId": {
"type": "integer",
"description": "Optional linked restrictive measure entry from the care plan",
"format": "int64",
"nullable": true
},
"restrictiveMeasureId": {
"type": "integer",
"description": "The applied restrictive measure",
"format": "int64",
"nullable": true
},
"law": {
"type": "integer",
"description": "The law that was valid when this measure was applied\n- 0 Bopz\n- 1 Wzd\n- 2 Wvggz\n- 3 Wzd with fz",
"format": "int32",
"nullable": true
},
"narrative": {
"type": "string",
"description": "Optional narrative that was recorded during the registration",
"nullable": true
},
"resistant": {
"type": "boolean",
"description": "Whether there was resistance during the application of this measure",
"default": false,
"nullable": true,
"deprecated": true
},
"clientExternalId": {
"type": "integer",
"description": "The id of the client this registration is linked to",
"format": "int64",
"nullable": true
},
"legalTitle": {
"type": "string",
"description": "The legal title under which this measure was applied:\n- determine_later\n- care_authorization\n- crisis_measure\n- temp_unforeseen\n- temp_mandatory_before_cm\n- continuation_authorization\n- tbs_pij",
"nullable": true
},
"startTime": {
"type": "string",
"description": "When the application of this measure started",
"format": "date-time",
"nullable": true
},
"endTime": {
"type": "string",
"description": "Optional when the application of this measure ended.",
"format": "date-time",
"nullable": true
},
"createdAt": {
"type": "string",
"description": "When this registration was created",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"description": "When this registration was last updated",
"format": "date-time",
"nullable": true
},
"reportId": {
"type": "integer",
"description": "The id of the report that is linked to this registration",
"format": "int64",
"nullable": true
}
},
"description": "RestrictiveMeasureRegistration model (no description)",
"example": {
"id": 1,
"restrictiveMeasureEntryId": 2,
"restrictiveMeasureId": 3,
"law": 1,
"narrative": "narrative",
"resistant": false,
"clientExternalId": 4,
"reportId": 1234,
"legalTitle": "crisis_measure",
"startTime": "2021-01-01T00:00:00.000+01:00",
"endTime": "2021-01-02T00:00:00.000+01:00",
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00"
}
},
"dossier.RestrictiveMeasureCarePlanEntry": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.MedicalBase"
}
],
"properties": {
"restrictiveMeasureEntries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.RestrictiveMeasureEntry"
},
"description": "The restrictive measure entries belonging to this care plan entry",
"nullable": true
},
"restrictiveMeasureEvaluations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.RestrictiveMeasureEvaluation"
},
"description": "Optional evaluations for this care plan entry",
"nullable": true
},
"situation": {
"type": "string",
"description": "Optional situation in which this measure is/was applied\nnull if it does not end",
"format": "date"
},
"hourTypeId": {
"type": "integer",
"description": "The HourType of the Intent",
"format": "int64"
},
"frequency": {
"type": "integer",
"description": "The number of times this intent is present within the recurrence interval. It can be seen as the multiplier of the\nquantity. For example in '3 times 4 hours every week', 3 is the frequency.",
"format": "int32"
},
"quantityAmount": {
"type": "integer",
"description": "The amount matching the quantity",
"format": "int32"
},
"quantityUnit": {
"allOf": [
{
"$ref": "#/components/schemas/arrangement.QuantityUnit"
}
],
"description": "The Intent's quantity unit, for example MINUTE or HOUR. In combination with the quantity amount, it determines the\nquantity of th the care that is intended. For example:\n- 2, HOUR means '2 hours'\n- 120, MINUTE means '120 minutes'"
},
"recurrenceInterval": {
"type": "integer",
"description": "The recurrence interval",
"format": "int32"
},
"recurrenceType": {
"allOf": [
{
"$ref": "#/components/schemas/arrangement.RecurrenceType"
}
],
"description": "Together with the recurrence interval, the recurrence type determines how the intent is repeated over time.\nExamples:\n- 1, WEEK corresponds to 'every week'\n- 2, DAY corresponds to 'every 2 days' or 'every other day'"
},
"sourceApp": {
"type": "string",
"description": "The app that created this intent. Apps should use upper case names to identify themselves and never change this."
},
"sourceReference": {
"type": "string",
"description": "The reference to this intent. The exact meaning is application specific."
},
"sourceDescription": {
"type": "string",
"description": "Free text description."
},
"splittable": {
"type": "boolean",
"description": "Whether this intent may be split across multiple agenda entries when planning it."
},
"title": {
"type": "string",
"description": "The title of this intent."
},
"description": {
"type": "string",
"description": "The description of this intent."
},
"plannable": {
"type": "boolean",
"description": "Whether this intent plannable;"
}
},
"description": "Intent of the preference",
"example": {
"uuid": "12345",
"timelineUuid": "12344",
"clientUuid": "ABCD",
"clientId": 24,
"beginDate": "2018-06-14",
"endDate": "2018-05-20",
"hourTypeId": 12,
"frequency": 3,
"quantityAmount": 1,
"quantityUnit": "DAY_PART",
"recurrenceInterval": 1,
"recurrenceType": "WEEK",
"sourceApp": "PLANNING",
"sourceReference": "planning/123",
"sourceDescription": "for someone",
"splittable": true,
"title": "title",
"description": "description",
"plannable": true
},
"xml": {
"name": "intent"
}
},
"arrangement.QuantityUnit": {
"enum": [
"MINUTE",
"HOUR",
"DAY_PART",
"DAY",
"PIECE"
],
"type": "string",
"description": "The Intent's quantity unit, for example MINUTE or HOUR. In combination with the quantity amount, it determines the\nquantity of th the care that is intended. For example:\n- 2, HOUR means '2 hours'\n- 120, MINUTE means '120 minutes'",
"example": "MINUTE"
},
"arrangement.RecurrenceType": {
"enum": [
"HOUR",
"DAY",
"WEEK",
"PERIOD"
],
"type": "string",
"description": "Together with the recurrence interval, the recurrence type determines how the intent is repeated over time.\nExamples:\n- 1, WEEK corresponds to 'every week'\n- 2, DAY corresponds to 'every 2 days' or 'every other day'",
"example": "HOUR"
},
"arrangement.list.IntentList": {
"type": "object",
"properties": {
"intents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/arrangement.Intent"
}
}
},
"description": "IntentList model (no description)",
"example": {
"intents": [
{
"uuid": "4dc4ee6a-6b09-4245-8dd1-7aa192178280",
"timelineUuid": "1c7acb14-6d31-4b67-a999-3ed68fcbbf14",
"clientUuid": "1b481755-bada-4a28-9d9e-b1bf77943814",
"clientId": 544,
"beginDate": "2022-01-01",
"hourTypeId": 1,
"frequency": 3,
"quantityAmount": 4,
"quantityUnit": "HOUR",
"recurrenceInterval": 1,
"recurrenceType": "WEEK",
"sourceApp": "PLANNING"
},
{
"uuid": "4dc4ee6a-6b09-4245-8dd1-7aa192178280",
"timelineUuid": "1c7acb14-6d31-4b67-a999-3ed68fcbbf14",
"clientUuid": "1b481755-bada-4a28-9d9e-b1bf77943814",
"clientId": 544,
"beginDate": "2022-01-01",
"hourTypeId": 1,
"frequency": 3,
"quantityAmount": 4,
"quantityUnit": "HOUR",
"recurrenceInterval": 1,
"recurrenceType": "WEEK",
"sourceApp": "PLANNING"
}
]
}
},
"arrangement.Stakeholder": {
"required": [
"uuid",
"timelineUuid",
"intentUuid"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "UUID identifying this Stakeholder across applications",
"x-cupido-id": true
},
"timelineUuid": {
"type": "string",
"description": "UUID for the timeline that groups this Stakeholder with other Stakeholders and Intents"
},
"intentUuid": {
"type": "string",
"description": "UUID of the Intent to which this Stakeholder is coupled"
},
"employeeObjectId": {
"type": "integer",
"description": "Employee responsible for the Intent",
"format": "int64"
},
"educationObjectId": {
"type": "integer",
"description": "Education required for the Intent",
"format": "int64"
},
"responsibleClusterObjectId": {
"type": "integer",
"description": "Team responsible for the Intent",
"format": "int64"
},
"executingClusterObjectId": {
"type": "integer",
"description": "Team executing the Intent",
"format": "int64"
},
"presenceTime": {
"type": "integer",
"description": "Time (in minutes) present at the Intent",
"format": "int32"
},
"extraTime": {
"type": "integer",
"description": "Client time (in minutes)\n\nTime registered for the client where the stakeholder is not present at the client",
"format": "int32"
},
"travelTime": {
"type": "integer",
"description": "Travel time (in minutes)",
"format": "int32"
}
},
"description": "Stakeholder model (no description)",
"example": {
"uuid": "AAABB",
"timelineUuid": "ABCDEF",
"intentUuid": "AAAABB",
"employeeObjectId": 1,
"educationObjectId": 2,
"responsibleClusterObjectId": 123,
"executingClusterObjectId": 123,
"presenceTime": 60,
"extraTime": 0,
"travelTime": 5
},
"xml": {
"name": "stakeholder"
}
},
"arrangement.TimeSlot": {
"required": [
"uuid",
"clientId",
"clientUuid",
"dayOfWeek",
"beginAfter",
"endBefore"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "UUID identifying this time slot",
"x-cupido-id": true
},
"clientId": {
"type": "integer",
"description": "Client of this time slot",
"format": "int64"
},
"clientUuid": {
"type": "string",
"description": "Client UUID of this time slot"
},
"dayOfWeek": {
"type": "integer",
"description": "Day number of the week of this time slot\nMonday = 1 ... Sunday = 7",
"format": "int32",
"default": 0
},
"beginAfter": {
"type": "string",
"description": "Start time of this time slot",
"format": "time"
},
"endBefore": {
"type": "string",
"description": "End time of this time slot",
"format": "time"
}
},
"description": "TimeSlot of the preference",
"example": {
"uuid": "TIME_SLOT_UUID",
"clientId": 1,
"clientUuid": "CLIENT_UUID",
"dayOfWeek": 1,
"beginAfter": "00:00:00.000",
"endBefore": "00:00:00.000"
},
"xml": {
"name": "timeSlot"
}
},
"expense.ExpenseAddressModel": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"beginDate": {
"type": "string",
"description": "Begindate of this departure location settings",
"format": "date"
},
"departureLocation": {
"$ref": "#/components/schemas/DepartureLocation"
},
"endDate": {
"type": "string",
"description": "Enddate of this departure location settings",
"format": "date"
}
},
"description": "Departure location of an employee",
"example": {
"id": 123,
"beginDate": "2020-01-01",
"departureLocation": "HOME",
"endDate": "2020-01-31"
}
},
"DepartureLocation": {
"enum": [
"HOME",
"OFFICE"
],
"type": "string",
"description": "DepartureLocation which is used to determine which address should be used for the automated travel calculations",
"example": "HOME"
},
"VehicleAssignmentModel": {
"type": "object",
"properties": {
"beginDate": {
"type": "string",
"description": "Begindate of vehicle assignment",
"format": "date"
},
"endDate": {
"type": "string",
"description": "Enddate of vehicle assignment",
"format": "date"
},
"id": {
"type": "integer",
"description": "Id of this object",
"format": "int64",
"x-cupido-id": true
},
"isCompanyVehicle": {
"type": "boolean",
"description": "True if the assigned vehicle is a company vehicle"
},
"employeeObjectid": {
"type": "integer",
"format": "int64"
},
"vehicle": {
"allOf": [
{
"$ref": "#/components/schemas/WpmVehicle"
}
],
"description": "Assigned vehicle. Possible values:\n\nCAR_GASOLINE\nCAR_DIESEL\nCAR_PHEV\nCAR_EV\nCAR_OTHER\nMOTORCYCLE_GASOLINE\nMOTORCYCLE_EV\nSCOOTER_GASOLINE\nSCOOTER_EV\nBIKE_WALK\n
"
}
},
"description": "Vehicle assignment for a given employee during a given period",
"example": {
"id": 1,
"beginDate": "2010-12-02",
"endDate": "2011-01-02",
"isCompanyVehicle": false,
"employeeObjectid": 123456,
"vehicle": "CAR_EV"
},
"xml": {
"name": "vehicleAssignmentModel"
}
},
"WpmVehicle": {
"enum": [
"CAR_GASOLINE",
"CAR_DIESEL",
"CAR_PHEV",
"CAR_EV",
"CAR_OTHER",
"MOTORCYCLE_GASOLINE",
"MOTORCYCLE_EV",
"SCOOTER_GASOLINE",
"SCOOTER_EV",
"BIKE_WALK",
"PUBLIC_TRANSPORT"
],
"type": "string",
"description": "The vehicle used for travel by the employee stated in the WPM legislation",
"example": "CAR_EV"
},
"Bsn": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"clientId": {
"type": "integer",
"format": "int64"
},
"number": {
"type": "string"
},
"sourceVerified": {
"type": "boolean"
},
"idVerified": {
"type": "boolean"
},
"idNumber": {
"type": "string"
},
"idType": {
"type": "string"
},
"source": {
"type": "string"
},
"idVerifiedType": {
"type": "string"
},
"idVerifiedDate": {
"type": "string",
"format": "date-time"
},
"bsnUnknown": {
"type": "boolean"
},
"reasonBsnUnknown": {
"type": "string"
},
"idValidUntil": {
"type": "string",
"format": "date"
},
"bsnVerifiedDate": {
"type": "string",
"format": "date"
},
"widVerified": {
"type": "boolean"
},
"verifiedByEmployeeId": {
"type": "integer",
"format": "int64"
},
"bsnDocumentType": {
"$ref": "#/components/schemas/bsn.BsnDocumentType"
},
"bsnSource": {
"$ref": "#/components/schemas/bsn.BsnSource"
},
"bsnIdVerifiedType": {
"$ref": "#/components/schemas/bsn.BsnIdVerifiedType"
}
},
"description": "Bsn model (no description)",
"example": {
"id": 42,
"clientId": 200,
"number": "0123456789",
"sourceVerified": true,
"idVerified": false,
"idNumber": "asd234",
"idType": "Paspoort",
"source": "OwnAdministration",
"idVerifiedType": "Geen",
"idVerifiedDate": "2010-03-15T00:00:00.000+01:00",
"bsnUnknown": false,
"reasonBsnUnknown": "Illegaal",
"idValidUntil": "2010-03-15",
"bsnVerifiedDate": "2010-03-15",
"widVerified": false,
"verifiedByEmployeeId": 100,
"bsnDocumentType": 1,
"bsnSource": -1,
"bsnIdVerifiedType": 2
},
"xml": {
"name": "bsn"
}
},
"bsn.BsnDocumentType": {
"type": "integer",
"oneOf": [
{
"title": "PASPOORT",
"enum": [
0
]
},
{
"title": "ID",
"enum": [
1
]
},
{
"title": "RIJBEWIJS",
"enum": [
2
]
},
{
"title": "VREEMDELINGENDOCUMENT",
"enum": [
3
]
}
],
"description": "BsnDocumentType model (no description)",
"example": 0
},
"bsn.BsnSource": {
"type": "integer",
"oneOf": [
{
"title": "UNKNOWN",
"enum": [
-1
]
},
{
"title": "OWN_ADMINISTRATION",
"enum": [
0
]
},
{
"title": "SBVZ",
"enum": [
1
]
},
{
"title": "GBA",
"enum": [
2
]
},
{
"title": "OTHER_BSN_USER",
"enum": [
3
]
}
],
"description": "BsnSource model (no description)",
"example": -1
},
"bsn.BsnIdVerifiedType": {
"type": "integer",
"oneOf": [
{
"title": "GEEN",
"enum": [
0
]
},
{
"title": "VERGEWIST",
"enum": [
1
]
},
{
"title": "WID",
"enum": [
2
]
}
],
"description": "BsnIdVerifiedType model (no description)",
"example": 0
},
"CareProviderAddress": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Address"
}
],
"properties": {
"careProviderId": {
"type": "integer",
"format": "int64"
}
},
"description": "CareProviderAddress model (no description)",
"example": {
"id": 1,
"beginDate": "2010-02-16",
"endDate": "2010-02-17",
"homeNumber": 4,
"homeNumberExtension": "a",
"poBoxNumber": "123a",
"street": "Parallelweg",
"city": "Enschede",
"zipcode": "7513KC",
"municipality": "Enschede",
"country": "Netherlands",
"telephoneNumber": "053-1234567",
"telephoneCountryCode": "+31",
"telephoneNumber2": "053-1234567",
"telephoneCountryCode2": "+31",
"faxNumber": "053-1234567",
"email": "mike.wazowski@nedap.com",
"type": "residence address",
"typeString": "local",
"residentType": "0",
"personType": "1",
"personTypeString": "client",
"roomNumber": "1",
"locationDescription": "Afdeling noord",
"updatedAt": "2016-01-01T12:00:00.000+01:00",
"createdAt": "2016-01-01T12:00:00.000+01:00",
"latitude": 52.1,
"longitude": 6.9,
"careProviderId": 2,
"situationDescription": "Test",
"residenceAccessInfo": "Test"
},
"xml": {
"name": "careProviderAddress"
}
},
"Address": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"beginDate": {
"type": "string",
"format": "date"
},
"endDate": {
"type": "string",
"format": "date"
},
"homeNumber": {
"type": "integer",
"format": "int32"
},
"homeNumberExtension": {
"type": "string"
},
"poBoxNumber": {
"type": "string"
},
"street": {
"type": "string"
},
"city": {
"type": "string"
},
"zipcode": {
"type": "string"
},
"municipality": {
"type": "string"
},
"country": {
"type": "string"
},
"telephoneNumber": {
"type": "string"
},
"telephoneCountryCode": {
"type": "string"
},
"telephoneNumber2": {
"type": "string"
},
"telephoneCountryCode2": {
"type": "string"
},
"faxNumber": {
"type": "string"
},
"email": {
"type": "string"
},
"type": {
"type": "string",
"description": "0: Unknown\n1: Living\n2: Postal\n3: Residence\n4: Temporary\n50: Sleuteladres\n98: Other\n100: Factuuradres"
},
"typeString": {
"type": "string"
},
"residentType": {
"type": "string",
"description": "0: Unknown\n1: One-family house\n2: Upstairs apartment\n3: Ground floor apartment\n4: Apartment or flat\n5: Apartment or flat, with elevator between floors\n6: Houseboat\n7: Trailer\n8: WLZ organisation (with stay facilities)\n9: Homeless\n11: Assisted living\n12: WLZ organisation\n13: ZVW organisation\n14: WMO organisation\n21: asylum seekers center\n31: Correctional Institution\n99: Other"
},
"personType": {
"type": "string",
"description": "1: Client\n2: Employee\n3: Relation\n4: Careprovider\n5: Unit"
},
"personTypeString": {
"type": "string"
},
"roomNumber": {
"type": "string"
},
"locationDescription": {
"type": "string"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"latitude": {
"type": "number",
"format": "double"
},
"longitude": {
"type": "number",
"format": "double"
},
"situationDescription": {
"type": "string",
"description": "Toelichting woonsituatie"
},
"residenceAccessInfo": {
"type": "string",
"description": "Informatie over toegang tot de woning"
}
},
"description": "Address model.",
"example": {
"id": 1,
"beginDate": "2010-02-16",
"endDate": "2010-02-17",
"homeNumber": 4,
"homeNumberExtension": "b",
"poBoxNumber": "123a",
"street": "Parallelweg",
"city": "Groenlo",
"zipcode": "7513KC",
"municipality": "Enschede",
"country": "Netherlands",
"telephoneNumber": "053-1234567",
"telephoneCountryCode": "+31",
"telephoneNumber2": "053-1234567",
"telephoneCountryCode2": "+31",
"faxNumber": "053-1234567",
"email": "mike.wazowski@nedap.com",
"type": "3",
"typeString": "residence address",
"residentType": "?",
"personType": "1",
"personTypeString": "client",
"roomNumber": "1",
"locationDescription": "Afdeling noord",
"updatedAt": "2016-01-01T12:00:00.000+01:00",
"createdAt": "2016-01-01T12:00:00.000+01:00",
"latitude": 52.1,
"longitude": 6.9,
"situationDescription": "Woont bij ex",
"residenceAccessInfo": "Sleutel ligt onder de blauwe bloempot"
}
},
"CareAllocation": {
"required": [
"clientId",
"beginDate"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"clientId": {
"type": "integer",
"format": "int64"
},
"beginDate": {
"type": "string",
"format": "date"
},
"endDate": {
"type": "string",
"format": "date"
},
"comments": {
"type": "string"
},
"destination": {
"type": "string",
"description": "NVT: N.v.t.\nEIGEN_OMGEVING: Eigen omgeving\nEIGEN_OMGEVING_DAGBEHANDELING: Eigen omgeving met dagbehandeling\nINSTELLING_WLZ: Instelling (WLZ) of ziekenhuis\nINSTELLING_NIET_WLZ: Instelling (niet-WLZ)"
},
"reason": {
"type": "string",
"description": "REJECTED: Afgekeurd\nCLASS_CHANGED: Klasse is aangepast\nREVOKE_MUT: Intrekking MUT\nREVOKE_MAZ: Intrekking MAZ\nIN_CARE: N.v.t.\nDISMISS: Ontslag (intramuraal)\nDEATH: Overlijden\nTEMP_GONE: Tijdelijke afwezigheid\nREFUSED_BY_PROVIDER: Aanbieder weigert functie\nREFUSED_BY_CLIENT: Cliënt weigert functie\nRESUME: Onderbroken functie hervat\nEND_OF_CARE: Beëindiging zorg\nTRANSFER: Overplaatsing\nEND_OF_CARE_CLOSE_FUNCTION: Einde zorg (functies intrekken)\nEND_OF_CARE_OPEN_FUNCTION: Einde zorg (functies openlaten)\nTRANSFER_NO_MAZ: Overplaatsing (er is geen Maz)\nREQUEST_CUSTOM_CARE_ORDER: Aanvraag aangepaste zorgtoewijzing\nEND_OF_CARE_AFTER_INTAKE: Beëindiging zorg na intake\nDEATH_BY_SUICIDE: Overlijden door suïcide"
},
"reasonTemporary": {
"type": "string",
"description": "NVT: N.v.t.\nVAKANTIEVERLOF: Vakantieverlof\nZIEKENHUISOPNAME: Ziekenhuisopname\nKORTE_VERBLIJFPLAATSING: Korte verblijfplaatsing in WLZ-erkende instelling\nTIJDELIJK_THUIS: Tijdelijk thuis\nPANDEMIE: Pandemie"
},
"careProviderId": {
"type": "integer",
"description": "Care provider id, required when reason is TRANSFER and destination is INSTELLING_WLZ",
"format": "int64"
}
},
"description": "CareAllocation model (no description)",
"example": {
"id": 1,
"clientId": 10,
"beginDate": "2016-01-01",
"endDate": "2020-01-01",
"comments": "niets te melden",
"destination": "EIGEN_OMGEVING",
"reason": "IN_CARE",
"reasonTemporary": "VAKANTIEVERLOF",
"careProviderId": 42
},
"xml": {
"name": "careAllocation"
}
},
"CareProvider": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"identificationNumber": {
"type": "string"
},
"beholdenId": {
"type": "string"
},
"companyName": {
"type": "string"
},
"name": {
"type": "string"
},
"firstName": {
"type": "string"
},
"initials": {
"type": "string"
},
"prefix": {
"type": "string"
},
"gender": {
"type": "string",
"description": "\nPossible values:\nM - Male\nF - Female\nU - Unknown\n
"
},
"preferredContactTime": {
"type": "string"
},
"comments": {
"type": "string"
},
"categoryObjectId": {
"type": "integer",
"format": "int64"
},
"organisationCategoryId": {
"type": "integer",
"format": "int64"
},
"isDispensing": {
"type": "boolean"
},
"uraNumber": {
"type": "string"
}
},
"description": "The source of this MedicationChart. A pharmacy.\nidentificationNumber and companyName should be filled.\nThe identificationNumber should be the AGB-code of the pharmacy.\nAll other fields are optional.",
"example": {
"id": 111,
"identificationNumber": "555",
"beholdenId": "333",
"companyName": "compname",
"name": "name",
"firstName": "firstname",
"initials": "initials",
"prefix": "prefix",
"gender": "F",
"preferredContactTime": "preferredContactTime",
"comments": "comments",
"categoryObjectId": 123,
"organisationCategoryId": 456,
"isDispensing": false,
"uraNumber": "12345678"
},
"xml": {
"name": "careProvider"
}
},
"ClientAddress": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Address"
}
],
"properties": {
"clientId": {
"type": "integer",
"format": "int64"
}
},
"description": "ClientAddress model (no description)",
"example": {
"id": 1,
"beginDate": "2010-02-16",
"endDate": "2010-02-17",
"homeNumber": 4,
"homeNumberExtension": "a",
"poBoxNumber": "123a",
"street": "Parallelweg",
"city": "Enschede",
"zipcode": "7513KC",
"municipality": "Enschede",
"country": "Netherlands",
"telephoneNumber": "053-1234567",
"telephoneCountryCode": "+31",
"telephoneNumber2": "053-1234567",
"telephoneCountryCode2": "+31",
"faxNumber": "053-1234567",
"email": "mike.wazowski@nedap.com",
"type": "residence address",
"typeString": "local",
"residentType": "0",
"personType": "1",
"personTypeString": "client",
"roomNumber": "1",
"locationDescription": "Afdeling noord",
"updatedAt": "2016-01-01T12:00:00.000+01:00",
"createdAt": "2016-01-01T12:00:00.000+01:00",
"latitude": 52.1,
"longitude": 6.9,
"clientId": 2,
"situationDescription": "Test",
"residenceAccessInfo": "Test"
},
"xml": {
"name": "clientAddress"
}
},
"ClientContactRelationAddress": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Address"
}
],
"properties": {
"clientContactRelationId": {
"type": "integer",
"format": "int64"
}
},
"description": "ClientContactRelationAddress model (no description)",
"example": {
"id": 1,
"beginDate": "2010-02-16",
"endDate": "2010-02-17",
"homeNumber": 4,
"homeNumberExtension": "a",
"poBoxNumber": "123a",
"street": "Parallelweg",
"city": "Enschede",
"zipcode": "7513KC",
"municipality": "Enschede",
"country": "Netherlands",
"telephoneNumber": "053-1234567",
"telephoneCountryCode": "+31",
"telephoneNumber2": "053-1234567",
"telephoneCountryCode2": "+31",
"faxNumber": "053-1234567",
"email": "mike.wazowski@nedap.com",
"type": "residence address",
"typeString": "local",
"residentType": "0",
"personType": "client",
"personTypeString": "birthname",
"roomNumber": "1",
"locationDescription": "Afdeling noord",
"updatedAt": "2016-01-01T12:00:00.000+01:00",
"createdAt": "2016-01-01T12:00:00.000+01:00",
"latitude": 52.1,
"longitude": 6.9,
"clientContactRelationId": 1,
"situationDescription": "Test",
"residenceAccessInfo": "Test"
},
"xml": {
"name": "clientContactRelationAddress"
}
},
"ClientContactRelation": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"firstName": {
"type": "string"
},
"name": {
"type": "string"
},
"identificationNo": {
"type": "string"
},
"preferredNameType": {
"type": "string"
},
"lastName": {
"type": "string"
},
"birthName": {
"type": "string"
},
"partnerName": {
"type": "string"
},
"initials": {
"type": "string"
},
"prefix": {
"type": "string"
},
"birthNamePrefix": {
"type": "string"
},
"partnerNamePrefix": {
"type": "string"
},
"gender": {
"type": "string"
},
"clientObjectId": {
"type": "integer",
"format": "int64"
},
"bsn": {
"allOf": [
{
"$ref": "#/components/schemas/Bsn"
}
],
"description": "DEPRECATED",
"deprecated": true
},
"clientContactRelationType": {
"allOf": [
{
"$ref": "#/components/schemas/nexus.ClientContactRelationType"
}
],
"description": "Vektiscode"
},
"clientContactRelationTypeObjectId": {
"type": "integer",
"format": "int64"
},
"personalRelationType": {
"allOf": [
{
"$ref": "#/components/schemas/nexus.PersonalRelationType"
}
],
"description": "Vektiscode"
},
"personalRelationTypeObjectId": {
"type": "integer",
"format": "int64"
},
"organization": {
"type": "string"
},
"inCaseOfEmergency": {
"type": "boolean"
},
"comments": {
"type": "string"
}
},
"description": "ClientContactRelation model (no description)",
"example": {
"updatedAt": "2014-04-17T16:04:36.000+02:00",
"createdAt": "2014-04-17T16:04:36.000+02:00",
"createdBy": "user",
"id": 10310,
"firstName": "Wil",
"name": "Mw. MMT 05-11-86",
"identificationNo": "code",
"preferredNameType": "0",
"lastName": "Jansen-Niemeijer",
"birthName": "Jansen",
"partnerName": "Niemeijer",
"initials": "MMT",
"prefix": "",
"birthNamePrefix": "",
"partnerNamePrefix": "",
"gender": "F",
"clientObjectId": 30259,
"bsn": {
"id": 1,
"clientId": 1,
"number": "example",
"sourceVerified": true,
"idVerified": true,
"idNumber": "example",
"idType": "example",
"source": "example",
"idVerifiedType": "example",
"idVerifiedDate": "2014-12-29T00:00:00.000+01:00",
"bsnUnknown": true,
"reasonBsnUnknown": "example",
"idValidUntil": "2014-12-29",
"bsnVerifiedDate": "2014-12-29",
"widVerified": true,
"verifiedByEmployeeId": 1,
"bsnDocumentType": 0,
"bsnSource": -1,
"bsnIdVerifiedType": 0
},
"clientContactRelationType": {
"id": 1,
"name": "example",
"tag": "example",
"primary": true,
"exclusive": true,
"relevant": true,
"negative": true,
"active": true,
"legal": true,
"vbmResponsible": true,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"type": "example"
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example"
},
"clientContactRelationTypeObjectId": 1,
"personalRelationType": {
"id": 1,
"name": "example",
"tag": "example",
"primary": true,
"exclusive": true,
"relevant": true,
"negative": true,
"active": true,
"legal": true,
"vbmResponsible": true,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"type": "example"
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example"
},
"personalRelationTypeObjectId": 2,
"organization": "Nedap",
"inCaseOfEmergency": false,
"comments": "Casemanager komt 1 keer per maand"
},
"xml": {
"name": "clientContactRelation"
}
},
"AuditedBase": {
"title": "AuditedBase",
"type": "object",
"properties": {
"updatedAt": {
"type": "string",
"description": "Dated Base extension.",
"format": "date-time",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createdBy": {
"type": "string",
"nullable": true
}
},
"description": "AuditedBase model (no description)",
"example": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example"
}
},
"nexus.ClientContactRelationType": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/nexus.RelationType"
}
],
"description": "Vektiscode",
"example": {
"id": 6,
"name": "Curator",
"tag": "tag",
"primary": true,
"exclusive": true,
"relevant": true,
"negative": false,
"active": true,
"legal": true,
"vbmResponsible": false,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user",
"id": 7,
"name": "Standard"
},
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user"
}
},
"nexus.RelationType": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"name": {
"type": "string"
},
"tag": {
"type": "string"
},
"primary": {
"type": "boolean"
},
"exclusive": {
"type": "boolean"
},
"relevant": {
"type": "boolean"
},
"negative": {
"type": "boolean"
},
"active": {
"type": "boolean"
},
"legal": {
"type": "boolean"
},
"vbmResponsible": {
"type": "boolean"
},
"vektisCode": {
"type": "integer",
"description": "See https://www.vektis.nl/standaardisatie/codelijsten/COD821-VEKT",
"format": "int64"
},
"reference": {
"type": "integer",
"description": "Only available during transitional period.",
"format": "int64",
"deprecated": true
},
"relationCategory": {
"$ref": "#/components/schemas/nexus.RelationCategory"
}
},
"description": "RelationType model (no description)",
"example": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user",
"id": 6,
"name": "Coach",
"tag": "coach",
"primary": true,
"exclusive": true,
"relevant": true,
"negative": false,
"active": true,
"legal": false,
"vbmResponsible": false,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user",
"id": 7,
"name": "Standard"
}
},
"deprecated": true,
"x-deprecated-since": "03-10-2014"
},
"nexus.RelationCategory": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"name": {
"type": "string"
},
"type": {
"type": "string"
}
},
"description": "RelationCategory model (no description)",
"example": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user",
"id": 7,
"name": "Standard",
"type": "SOCIAL"
},
"xml": {
"name": "relationCategory"
}
},
"nexus.PersonalRelationType": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/nexus.RelationType"
}
],
"description": "Vektiscode",
"example": {
"id": 6,
"name": "Father",
"tag": "tag",
"primary": true,
"exclusive": true,
"relevant": true,
"negative": false,
"active": true,
"legal": true,
"vbmResponsible": false,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user",
"id": 7,
"name": "Standard"
},
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user"
}
},
"ClientEmployeeRelation": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"relationName": {
"type": "string",
"description": "The name of the relation type, equal to relationType.name."
},
"validFrom": {
"type": "string",
"format": "date-time"
},
"validTo": {
"type": "string",
"format": "date-time"
},
"relationType": {
"$ref": "#/components/schemas/ClientEmployeeRelationType"
},
"relationTypeId": {
"type": "integer",
"format": "int64"
},
"clientId": {
"type": "integer",
"format": "int64"
},
"employeeId": {
"type": "integer",
"format": "int64"
}
},
"description": "ClientEmployeeRelation model (no description)",
"example": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user",
"id": 5,
"relationName": "Cach",
"validFrom": "2013-11-28T00:00:00.000+01:00",
"validTo": "2013-11-30T00:00:00.000+01:00",
"relationType": {
"id": 6,
"name": "Cach",
"primary": true,
"exclusive": true,
"relevant": true,
"negative": false,
"active": true,
"legal": false,
"vbmResponsible": false,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user",
"id": 7,
"name": "Standard"
},
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user"
},
"relationTypeId": 6,
"clientId": 3,
"employeeId": 12
}
},
"ClientEmployeeRelationType": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/RelationType"
}
],
"description": "ClientEmployeeRelationType model (no description)",
"example": {
"id": 6,
"name": "Coach",
"tag": "tag",
"primary": true,
"exclusive": true,
"relevant": true,
"negative": false,
"active": true,
"legal": false,
"vbmResponsible": false,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user",
"id": 7,
"name": "Standard"
},
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user"
}
},
"RelationType": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"name": {
"type": "string"
},
"tag": {
"type": "string"
},
"primary": {
"type": "boolean"
},
"exclusive": {
"type": "boolean"
},
"relevant": {
"type": "boolean"
},
"negative": {
"type": "boolean"
},
"active": {
"type": "boolean"
},
"legal": {
"type": "boolean"
},
"vbmResponsible": {
"type": "boolean"
},
"vektisCode": {
"type": "integer",
"description": "See https://www.vektis.nl/standaardisatie/codelijsten/COD821-VEKT",
"format": "int64"
},
"reference": {
"type": "integer",
"description": "Only available during transitional period.",
"format": "int64",
"deprecated": true,
"x-deprecated-since": "03-10-2014"
},
"relationCategory": {
"$ref": "#/components/schemas/RelationCategory"
}
},
"description": "RelationType model (no description)",
"example": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user",
"id": 6,
"name": "Coach",
"tag": "coach",
"primary": true,
"exclusive": true,
"relevant": true,
"negative": false,
"active": true,
"legal": false,
"vbmResponsible": false,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user",
"id": 7,
"name": "Standard"
}
}
},
"RelationCategory": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"name": {
"type": "string"
},
"type": {
"type": "string"
}
},
"description": "RelationCategory model (no description)",
"example": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user",
"id": 7,
"name": "Standard",
"type": "SOCIAL"
}
},
"ClientAbsence": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"clientId": {
"type": "integer",
"format": "int64"
},
"clientAbsenceReason": {
"$ref": "#/components/schemas/ClientAbsenceReason"
},
"beginDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
},
"beginTime": {
"type": "string",
"format": "time"
},
"endTime": {
"type": "string",
"format": "time"
},
"note": {
"type": "string"
},
"sourceId": {
"type": "integer",
"format": "int64"
}
},
"description": "ClientAbsence domain model used by Cupido system.",
"example": {
"id": 1,
"clientId": 1,
"clientAbsenceReason": {
"id": 42,
"reason": "aap",
"active": true
},
"beginDate": "2012-08-02T13:48:46.836+02:00",
"endDate": "2012-08-02T13:48:46.836+02:00",
"beginTime": "11:48:46.836",
"endTime": "12:48:46.836",
"note": "mies",
"sourceId": 900
},
"xml": {
"name": "clientAbsence"
}
},
"ClientAbsenceReason": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"reason": {
"type": "string"
},
"active": {
"type": "boolean",
"default": false
}
},
"description": "ClientAbsenceReason domain model used by Cupido system.",
"example": {
"id": 42,
"reason": "aap",
"active": true
},
"xml": {
"name": "clientAbsenceReason"
}
},
"Client": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Person"
}
],
"properties": {
"givenName": {
"type": "string",
"description": "The given name (roepnaam) of the client."
},
"civilStatus": {
"type": "integer",
"description": "The civil status of the client. Allowed values:\n0: Unknown\n1: Unmarried and never had registered partnership\n2: Married\n3: Divorced\n4: Widow\n5: Registered partnership\n6: Divorced but has registered partnership\n7: Widow but has registered partnership\n8: Unmarried and no registered partnership\n9: Unmarried and no registered partnership, but had once a registered partnership",
"format": "int32"
},
"civilStatusDate": {
"type": "string",
"description": "The date from which the civil status applies.",
"format": "date-time"
},
"deathDate": {
"type": "string",
"description": "The date the client passed away.",
"format": "date-time"
},
"hometown": {
"type": "string",
"description": "The home town of the client."
},
"nationality": {
"type": "string",
"description": "The nationality of the client, as a 2-letter ISO3166 country code."
},
"language": {
"type": "string",
"description": "The language of the client, as a ISO 639-1 language code."
},
"religion": {
"type": "string",
"description": "The religion of the client."
},
"addressString": {
"type": "string",
"description": "Deprecated, this field is never set.",
"deprecated": true
},
"match": {
"type": "string",
"description": "Deprecated, this field is never set.",
"deprecated": true
},
"careAllocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CareAllocation"
},
"description": "All care periods for this client.",
"xml": {
"wrapped": true
}
},
"careAllocationBeginDate": {
"type": "string",
"description": "The begin date of the current of most recent past care allocation. Deprecated, use careAllocations.",
"format": "date",
"deprecated": true
},
"careAllocationEndDate": {
"type": "string",
"description": "The end date of the current or most recent past care allocation. Deprecated, use careAllocations.",
"format": "date",
"deprecated": true
},
"careAllocationReason": {
"type": "string",
"description": "The end of care reason of the current or most recent past care allocation. Deprecated, use careAllocations.",
"deprecated": true
},
"secretClient": {
"type": "boolean",
"description": "Indicates if this client is secret."
},
"uuid": {
"type": "string",
"description": "Type 4 Universally Unique Identifier of the client."
},
"levelOfEducation": {
"type": "string",
"description": "Level of education of the client. Allowed values are:\n10: Onderwijs aan kleuters\n20: Primair Onderwijs (omvat codes 10 en 20)\n30: VMBO (omvat codes 31, 32 en 33)\n31: Secundair onderwijs, eerste fase, Laag\n32: Secundair onderwijs, eerste fase, Midden\n33: Secundair onderwijs, eerste fase, Hoog\n40: HAVO, VWO, MBO (omvat codes 41, 42 en 43)\n41: Secundair onderwijs, tweede fase, Laag\n42: Secundair onderwijs, tweede fase, Midden\n43: Secundair onderwijs, tweede fase, Hoog\n50: Bachelor (omvat codes 51, 52 en 53)\n51: Hoger onderwijs, eerste fase, Laag\n52: Hoger onderwijs, eerste fase, Midden\n53: Hoger onderwijs, eerste fase, Hoog\n60: Master (omvat codes 60 en 70)\n70: Hoger onderwijs, derde fase\n99: Onbekend"
},
"livingSituation": {
"type": "string",
"description": "Living situation of the client. Allowed values are:\n10: Alleenstaand\n20: Zonder partner, met kinderen\n30: Met partner, zonder kinderen\n40: Met partner, met kinderen\n70: Optioneel: Niet-ggz-institutie\n80: Optioneel: Ggz-institutie\n90: Optioneel: Zwervend, dakloos\n97: Anders\n99: Onbekend"
},
"skn": {
"type": "string",
"description": "The strafrechtketennummer, max 15 numeric characters."
},
"pronouns": {
"x-deprecated-since": "21-08-2026",
"$ref": "#/components/schemas/Pronouns",
"description": "This field is deprecated and has been replaced by pronounsType.",
"deprecated": true
},
"preferredName": {
"type": "string",
"description": "This field is no longer used and is not populated.",
"deprecated": true,
"x-deprecated-since": "21-08-2026"
},
"genderIdentity": {
"x-deprecated-since": "21-08-2026",
"$ref": "#/components/schemas/GenderIdentity",
"description": "This field is deprecated and has been replaced by genderIdentityType.",
"deprecated": true
},
"pronounsType": {
"$ref": "#/components/schemas/PronounsType"
},
"genderIdentityType": {
"$ref": "#/components/schemas/GenderIdentityType"
}
},
"description": "Client registered on Cupido system.",
"example": {
"id": 1,
"firstName": "Mike",
"name": "Dhr Mike Wazowski",
"identificationNo": "wazo",
"dateOfBirth": "1982-01-01",
"preferredNameType": "0",
"lastName": "Wazowski",
"birthName": "Wazowski",
"partnerName": "none",
"initials": "W",
"prefix": "ir",
"birthNamePrefix": "ir",
"partnerNamePrefix": "none",
"gender": "M",
"emailAddress": "someone@nedap.com",
"mobilePhone": "0612345678",
"freeField1": "Free field 1 description",
"freeField2": "Free field 2 description",
"freeField3": "Free field 3 description",
"freeField4": "Free field 4 description",
"updatedAt": "2016-01-01T12:00:00.000+01:00",
"createdAt": "2016-01-01T12:00:00.000+01:00",
"givenName": "Mike",
"civilStatus": 0,
"civilStatusDate": "2010-03-15T00:00:00.000+01:00",
"deathDate": "2010-03-15T00:00:00.000+01:00",
"hometown": "Groenlo",
"nationality": "NL",
"language": "NL",
"religion": "None",
"addressString": "parallelweg 4, groenlo",
"match": "Waiting",
"careAllocations": [
{
"id": 1,
"clientId": 10,
"beginDate": "2016-01-01",
"endDate": "2020-01-01",
"comments": "niets te melden",
"destination": "EIGEN_OMGEVING",
"reason": "IN_CARE",
"reasonTemporary": "VAKANTIEVERLOF"
}
],
"careAllocationBeginDate": "2010-01-01",
"careAllocationEndDate": "2014-01-01",
"careAllocationReason": "InCare",
"secretClient": false,
"uuid": "abca58ed-0138-4aec-87c6-5d391e98161b",
"levelOfEducation": "52",
"livingSituation": "40",
"skn": "123456789012345",
"pronouns": {
"type": "SHE_HER",
"description": "zij/haar"
},
"preferredName": "Michelle Wazowski",
"genderIdentity": {
"type": "NON_BINARY",
"description": "non-binair"
},
"pronounsType": "SHE_HER",
"genderIdentityType": "NON_BINARY"
},
"xml": {
"name": "client"
}
},
"Person": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"nullable": true,
"x-cupido-id": true
},
"firstName": {
"type": "string",
"description": "The first name(s) of the person."
},
"name": {
"type": "string",
"description": "The client’s full official name.\nShowing the initials or client first name is a setting that care organisations can select."
},
"identificationNo": {
"type": "string",
"description": "Human-readable identification number of the person (clientnummer or medewerkernummer)."
},
"dateOfBirth": {
"type": "string",
"description": "The date of birth of the person.",
"format": "date"
},
"preferredNameType": {
"type": "string",
"description": "Preferred way of writing the name of the person. Possible values:\n0 (birth name)\n1 (partner name)\n2 (birth name - partner name)\n3 (partner name - birth name)"
},
"lastName": {
"type": "string",
"description": "The last name of the person, taking into account the preferredNameType setting."
},
"birthName": {
"type": "string",
"description": "The birth name of the person, without prefix."
},
"partnerName": {
"type": "string",
"description": "The last name of the partner of the person, without prefix."
},
"initials": {
"type": "string",
"description": "The initials of the person."
},
"prefix": {
"type": "string",
"description": "The prefix(es) of the last name(s) of the person, taking into account the preferredNameType setting."
},
"birthNamePrefix": {
"type": "string",
"description": "The birth name prefix of the person."
},
"partnerNamePrefix": {
"type": "string",
"description": "The partner name prefix of the person."
},
"gender": {
"type": "string",
"description": "The gender of the person."
},
"emailAddress": {
"type": "string",
"description": "The email address of the person, as registered on the personalia screen."
},
"mobilePhone": {
"type": "string",
"description": "The phone number of the person, as registered on the personalia screen."
},
"freeField1": {
"type": "string",
"description": "Contents of free field 1."
},
"freeField2": {
"type": "string",
"description": "Contents of free field 2."
},
"freeField3": {
"type": "string",
"description": "Contents of free field 3."
},
"freeField4": {
"type": "string",
"description": "Contents of free field 4."
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"createdAt": {
"type": "string",
"format": "date-time"
}
},
"description": "Common attributes for Client and Employee.",
"example": {
"id": 1,
"firstName": "Mike",
"name": "Dhr Mike Wazowski",
"identificationNo": "wazo",
"dateOfBirth": "1982-01-01",
"preferredNameType": "0",
"lastName": "Wazowski",
"birthName": "Wazowski",
"partnerName": "none",
"initials": "W",
"prefix": "ir",
"birthNamePrefix": "ir",
"partnerNamePrefix": "none",
"gender": "M",
"emailAddress": "mike.wazowski@nedap.com",
"mobilePhone": "0612345678",
"freeField1": "Free field 1 description",
"freeField2": "Free field 2 description",
"freeField3": "Free field 3 description",
"freeField4": "Free field 4 description",
"updatedAt": "2016-01-01T12:00:00.000+01:00",
"createdAt": "2016-01-01T12:00:00.000+01:00"
}
},
"Pronouns": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/PronounsType"
},
"description": {
"type": "string",
"description": "Translated description of the pronouns."
}
},
"description": "The usage of this schema is deprecated and has been replaced by PronounsType.",
"example": {
"type": "WHO_THEIR",
"description": "die/diens"
},
"deprecated": true,
"x-deprecated-since": "21-08-2026"
},
"PronounsType": {
"enum": [
"SHE_HER",
"HE_HIS",
"WHO_THEIR",
"THEM_THEIRS"
],
"type": "string",
"description": "Predefined type of pronouns: SHE_HER: 'zij/haar', HE_HIS: 'hij/hem', WHO_THEIR: 'die/diens', THEM_THEIRS: 'hen/hun'",
"example": "WHO_THEIR"
},
"GenderIdentity": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/GenderIdentityType"
},
"description": {
"type": "string",
"description": "Translated description of the gender identity."
}
},
"description": "The usage of this schema is deprecated and has been replaced by GenderIdentityType.",
"example": {
"type": "NON_BINARY",
"description": "non-binair"
},
"deprecated": true,
"x-deprecated-since": "21-08-2026"
},
"GenderIdentityType": {
"enum": [
"MALE",
"FEMALE",
"NON_BINARY"
],
"type": "string",
"description": "Predefined type of gender identity. MALE: 'man', FEMALE: 'vrouw', NON_BINARY: 'non-binair'",
"example": "NON_BINARY"
},
"Document": {
"required": [
"employeeObjectId",
"clientObjectId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"employeeObjectId": {
"type": "integer",
"format": "int64"
},
"clientObjectId": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"rightSelection": {
"$ref": "#/components/schemas/RightSelection"
},
"status": {
"type": "integer",
"description": "0: New\n1: Uploading\n2: Stored\n3: Deleted\n4: Purged\n5: Error\n6: Archived",
"format": "int32"
},
"fileName": {
"type": "string"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"expertiseProfiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpertiseProfile"
},
"xml": {
"wrapped": true
}
},
"expertiseGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpertiseGroup"
},
"xml": {
"wrapped": true
}
},
"tags": {
"type": "array",
"items": {
"type": "string",
"xml": {
"name": "tag"
}
},
"xml": {
"wrapped": true
}
}
},
"description": "Document model (no description)",
"example": {
"id": 1233,
"employeeObjectId": 10,
"clientObjectId": 2,
"description": "Dit is een test",
"rightSelection": "Group",
"status": 1,
"fileName": "file.pdf",
"updatedAt": "2017-06-08T00:00:00.000+02:00",
"createdAt": "2017-06-06T00:00:00.000+02:00",
"expertiseProfiles": [
{
"id": 1
},
{
"id": 2
}
],
"expertiseGroups": [
{
"id": 1
}
],
"tags": [
"test",
"Een tweede tag"
]
},
"xml": {
"name": "document"
}
},
"RightSelection": {
"enum": [
"Me",
"Group",
"Education",
"All",
"Nobody"
],
"type": "string",
"description": "RightSelection enum (no description)",
"example": "Me"
},
"ExpertiseProfile": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"description": {
"type": "string"
},
"visible": {
"type": "boolean"
},
"beginDate": {
"type": "string",
"description": "Deprecated since: 2024-05-14, unused, always empty",
"format": "date-time",
"deprecated": true,
"x-deprecated-since": "14-05-2024"
},
"endDate": {
"type": "string",
"description": "Deprecated since: 2024-05-14, unused, always empty",
"format": "date-time",
"deprecated": true,
"x-deprecated-since": "14-05-2024"
},
"allowDossierActions": {
"type": "boolean"
},
"allowDossierConfidential": {
"type": "boolean"
},
"hourTypeIds": {
"type": "array",
"items": {
"type": "integer",
"description": "List of Ids of {@link HourType}s assigned to this expertise profile",
"format": "int64",
"xml": {
"name": "hourTypeId"
}
},
"description": "List of Ids of {@link HourType}s assigned to this expertise profile",
"xml": {
"wrapped": true
}
}
},
"description": "Model is used to check to see if a person can be connected to a certain {@link HourType}.",
"example": {
"id": 5,
"description": "Helpenden",
"visible": true,
"beginDate": "2015-01-01T12:00:00.000+01:00",
"endDate": "2020-01-01T12:00:00.000+01:00",
"allowDossierActions": true,
"allowDossierConfidential": false,
"hourTypeIds": [
1,
2,
3
]
}
},
"ExpertiseGroup": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"parentObjectid": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"beginDate": {
"type": "string",
"format": "date"
},
"endDate": {
"type": "string",
"format": "date"
},
"expertiseProfiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpertiseProfile"
},
"xml": {
"wrapped": true
}
}
},
"description": "Model is used to group {@link ExpertiseProfile}'s, with possibly other {@link ExpertiseGroup}'s as parent/children.",
"example": {
"id": 2,
"parentObjectid": 1,
"name": "Alle helpenden",
"beginDate": "2016-01-01",
"endDate": "2021-12-31",
"expertiseProfiles": [
{
"id": 5,
"description": "Helpenden A",
"visible": true,
"beginDate": "2015-01-01T12:00:00.000+01:00",
"endDate": "2020-01-01T12:00:00.000+01:00",
"allowDossierActions": true,
"allowDossierConfidential": false
},
{
"id": 6,
"description": "Helpenden B",
"visible": true,
"beginDate": "2015-01-01T12:00:00.000+01:00",
"endDate": "2020-01-01T12:00:00.000+01:00",
"allowDossierActions": true,
"allowDossierConfidential": false
}
]
},
"xml": {
"name": "expertiseGroup"
}
},
"payroll.CollectiveAgreementAssignment": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"collectiveAgreementId": {
"type": "integer",
"format": "int64"
},
"beginDate": {
"type": "string",
"format": "date"
},
"endDate": {
"type": "string",
"format": "date"
},
"settings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payroll.CollectiveAgreementSetting"
},
"description": "The settings of a collective agreement assignment for an employee"
}
},
"description": "CollectiveAgreementAssignment model\n\nCreated on 06/05/21.",
"example": {
"id": 1,
"employeeId": 1,
"collectiveAgreementId": 1,
"beginDate": "2015-01-01",
"endDate": "2020-01-01",
"settings": [
{
"id": 1,
"collectiveAgreementAssignmentId": 1,
"key": "SLEEPSHIFT_COMPENSATE_IN_TIME",
"value": "true"
},
{
"id": 2,
"collectiveAgreementAssignmentId": 1,
"key": "SLEEPSHIFT_COMPENSATE_IN_TIME",
"value": "false"
}
]
},
"xml": {
"name": "collectiveAgreementAssignment"
}
},
"payroll.CollectiveAgreementSetting": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"collectiveAgreementAssignmentId": {
"type": "integer",
"format": "int64"
},
"key": {
"$ref": "#/components/schemas/payroll.ClaSettingsOptions"
},
"value": {
"type": "string"
}
},
"description": "CollectiveAgreementSetting model\n\nCreated on 16/12/25.",
"example": {
"id": 1,
"collectiveAgreementAssignmentId": 1,
"key": "SLEEPSHIFT_COMPENSATE_IN_TIME",
"value": "true"
}
},
"payroll.ClaSettingsOptions": {
"enum": [
"SLEEPSHIFT_COMPENSATE_IN_TIME",
"ON_CALL_COMPENSATE_IN_TIME",
"STANDBY_COMPENSATE_IN_TIME",
"ON_CALL_PHONE_COMPENSATE_IN_TIME",
"SUNDAY_WORKER",
"CALCULATE_TRAVELTIME",
"CALL_DURING_ON_CALL_COMPENSATE_IN_TIME",
"CALL_DURING_ON_CALL_PHONE_COMPENSATE_IN_TIME",
"IRREGULAR_SHIFTS",
"ORT_COMPENSATE_IN_TIME",
"OVERTIME_COMPENSATE_IN_TIME",
"SLEEPSHIFT_CLAUSE",
"CONSIGNMENT_COMPENSATE_IN_TIME"
],
"type": "string",
"description": "Enum defining the supported configuration options that can be applied to collective agreement assignments.\n\nSLEEPSHIFT_COMPENSATE_IN_TIME:\nDetermines whether sleepshift compensation is granted in time (true) instead of monetary compensation (false).\n\nON_CALL_COMPENSATE_IN_TIME:\nDetermines whether on call shift compensation is granted in time (true) instead of monetary compensation (false).\n\nSTANDBY_COMPENSATE_IN_TIME:\nDetermines whether standby shift compensation is granted in time (true) instead of monetary compensation (false).\n\nON_CALL_PHONE_COMPENSATE_IN_TIME:\nDetermines whether on call phone shift compensation is granted in time (true) instead of monetary compensation (false).\n\nSUNDAY_WORKER:\nIndicates whether the employee qualifies as a structural Sunday-only weekend worker and should receive the applicable additional Sunday compensation.\n\nCALCULATE_TRAVELTIME:\nDetermines whether travel time should be calculated between consecutive registrations.\n\nCALL_DURING_ON_CALL_COMPENSATE_IN_TIME:\nDetermines whether call during on call compensation is granted in time (true) instead of monetary compensation (false).\n\nCALL_DURING_ON_CALL_PHONE_COMPENSATE_IN_TIME:\nDetermines whether call during on call phone compensation is granted in time (true) instead of monetary compensation (false).\n\nIRREGULAR_SHIFTS:\nIndicates whether the employee works irregular shifts.\n\nORT_COMPENSATE_IN_TIME:\nDetermines whether ORT compensation is granted in time (true) instead of the default monetary compensation (false).\n\nOVERTIME_COMPENSATE_IN_TIME:\nDetermines whether overtime compensation is granted in time (true) instead of the default monetary compensation (false).\n\nSLEEPSHIFT_CLAUSE:\nIndicates whether the employee wants to make use of the previous sleep shift compensation clause.\n\nCONSIGNMENT_COMPENSATE_IN_TIME:\nDetermines whether consignment compensation is granted in time (true) or monetary (false).",
"example": "SLEEPSHIFT_COMPENSATE_IN_TIME"
},
"payroll.Contract": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"fixed": {
"type": "number",
"format": "double"
},
"var": {
"type": "number",
"format": "double"
},
"contractTypeId": {
"type": "integer",
"format": "int64"
},
"beginDate": {
"type": "string",
"format": "date"
},
"endDate": {
"type": "string",
"format": "date"
}
},
"description": "Contract model\n\nCreated on 22/04/15.",
"example": {
"id": 1,
"employeeId": 1,
"fixed": 1.234,
"var": 1.234,
"contractTypeId": 1,
"beginDate": "2015-01-01",
"endDate": "2020-01-01"
},
"xml": {
"name": "contract"
}
},
"dossier.ActionEntry": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"carePlanEntryId": {
"type": "integer",
"format": "int64"
},
"action": {
"$ref": "#/components/schemas/dossier.Action"
},
"actionId": {
"type": "integer",
"format": "int64"
},
"carePlanPersistentActionId": {
"type": "integer",
"description": "The care plan persistent action id of this action entry",
"format": "int64"
},
"comment": {
"type": "string"
},
"title": {
"type": "string"
}
},
"description": "Zorgplan \"actie\" entry",
"example": {
"updatedAt": "2014-04-01T17:00:00.000+02:00",
"createdAt": "2013-12-01T17:00:00.000+01:00",
"createdBy": "user",
"id": 1,
"carePlanEntryId": 2,
"action": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 1,
"goal": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 1,
"demandId": 1,
"definition": "example",
"allowTitleOverride": true,
"allowComment": true,
"reportProgress": true,
"hidden": true,
"classificationId": "example"
},
"goalId": 1,
"definition": "example",
"instructionUrl": "example",
"allowTitleOverride": true,
"allowComment": true,
"hidden": true,
"classificationId": "example"
},
"actionId": 3,
"carePlanPersistentActionId": 4,
"comment": "commentaar",
"title": "Een titel"
},
"xml": {
"name": "actionEntry"
}
},
"dossier.Action": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"domain": {
"$ref": "#/components/schemas/dossier.Domain"
},
"domainId": {
"type": "integer",
"format": "int64"
},
"goal": {
"$ref": "#/components/schemas/dossier.Goal"
},
"goalId": {
"type": "integer",
"format": "int64"
},
"definition": {
"type": "string"
},
"instructionUrl": {
"type": "string"
},
"allowTitleOverride": {
"type": "boolean",
"default": false
},
"allowComment": {
"type": "boolean",
"default": false
},
"hidden": {
"type": "boolean",
"default": false
},
"classificationId": {
"type": "string"
}
},
"description": "Zorgplan \"actie\"",
"example": {
"updatedAt": "2014-04-01T17:00:00.000+02:00",
"createdAt": "2013-12-01T17:00:00.000+01:00",
"createdBy": "user",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 2,
"goal": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 1,
"demandId": 1,
"definition": "example",
"allowTitleOverride": true,
"allowComment": true,
"reportProgress": true,
"hidden": true,
"classificationId": "example"
},
"goalId": 3,
"definition": "Een definitie",
"instructionUrl": "http://www.nedap.com/",
"allowTitleOverride": true,
"allowComment": true,
"hidden": false,
"classificationId": "intervention.target.bowel_care"
},
"xml": {
"name": "action"
}
},
"dossier.Domain": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"name": {
"type": "string",
"description": "(nl) Naam van dit domein"
},
"hidden": {
"type": "boolean",
"default": false
},
"classificationId": {
"type": "string"
}
},
"description": "Zorgplan \"domein\"",
"example": {
"updatedAt": "2014-04-01T17:00:00.000+02:00",
"createdAt": "2013-12-01T17:00:00.000+01:00",
"createdBy": "user",
"id": 1,
"name": "Domein naam",
"hidden": false,
"classificationId": "classification.domain.health"
}
},
"dossier.Goal": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"domain": {
"$ref": "#/components/schemas/dossier.Domain"
},
"domainId": {
"type": "integer",
"format": "int64"
},
"demandId": {
"type": "integer",
"format": "int64"
},
"definition": {
"type": "string"
},
"allowTitleOverride": {
"type": "boolean",
"default": false
},
"allowComment": {
"type": "boolean",
"default": false
},
"reportProgress": {
"type": "boolean",
"default": false
},
"hidden": {
"type": "boolean",
"default": false
},
"classificationId": {
"type": "string"
}
},
"description": "Zorgplan \"doel\"",
"example": {
"updatedAt": "2014-04-01T17:00:00.000+02:00",
"createdAt": "2013-12-01T17:00:00.000+01:00",
"createdBy": "user",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 2,
"demandId": 3,
"definition": "Target definition",
"allowTitleOverride": true,
"allowComment": true,
"reportProgress": false,
"hidden": false,
"classificationId": "intervention.category.case_management"
},
"xml": {
"name": "goal"
}
},
"dossier.CarePlanEntry": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"carePlanId": {
"type": "integer",
"format": "int64"
},
"demandEntry": {
"$ref": "#/components/schemas/dossier.DemandEntry"
},
"demandEntryId": {
"type": "integer",
"format": "int64"
},
"goalEntry": {
"$ref": "#/components/schemas/dossier.GoalEntry"
},
"goalEntryId": {
"type": "integer",
"format": "int64"
},
"actionEntries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.ActionEntry"
},
"xml": {
"wrapped": true
}
},
"percentageRealized": {
"type": "integer",
"format": "int32",
"default": 0
},
"percentageTarget": {
"type": "integer",
"format": "int32",
"default": 0
},
"importantForCarePlanGroupId": {
"type": "integer",
"format": "int64"
},
"importantForCarePlanGroup": {
"$ref": "#/components/schemas/survey.ImportantForCarePlanGroup"
}
},
"description": "\"Zorgplan\" entry.",
"example": {
"updatedAt": "2014-04-01T17:00:00.000+02:00",
"createdAt": "2013-12-01T17:00:00.000+01:00",
"createdBy": "user",
"id": 1,
"carePlanId": 6,
"demandEntry": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"carePlanEntryId": 1,
"demand": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 1,
"definition": "example",
"protocolUrl": "example",
"hidden": true,
"classificationId": "example"
},
"demandId": 1,
"comment": "example"
},
"demandEntryId": 3,
"goalEntry": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"comment": "example",
"title": "example",
"carePlanEntryId": 1,
"goal": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 1,
"demandId": 1,
"definition": "example",
"allowTitleOverride": true,
"allowComment": true,
"reportProgress": true,
"hidden": true,
"classificationId": "example"
},
"goalId": 1,
"targetDate": "2014-12-29T00:00:00.000+01:00"
},
"goalEntryId": 4,
"actionEntries": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"carePlanEntryId": 1,
"action": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 1,
"goal": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 1,
"demandId": 1,
"definition": "example",
"allowTitleOverride": true,
"allowComment": true,
"reportProgress": true,
"hidden": true,
"classificationId": "example"
},
"goalId": 1,
"definition": "example",
"instructionUrl": "example",
"allowTitleOverride": true,
"allowComment": true,
"hidden": true,
"classificationId": "example"
},
"actionId": 1,
"carePlanPersistentActionId": 1,
"comment": "example",
"title": "example"
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"carePlanEntryId": 1,
"action": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 1,
"goal": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 1,
"demandId": 1,
"definition": "example",
"allowTitleOverride": true,
"allowComment": true,
"reportProgress": true,
"hidden": true,
"classificationId": "example"
},
"goalId": 1,
"definition": "example",
"instructionUrl": "example",
"allowTitleOverride": true,
"allowComment": true,
"hidden": true,
"classificationId": "example"
},
"actionId": 1,
"carePlanPersistentActionId": 1,
"comment": "example",
"title": "example"
}
],
"percentageRealized": 20,
"percentageTarget": 40,
"importantForCarePlanGroupId": 5,
"importantForCarePlanGroup": {
"id": 1,
"groupAnswerId": 1,
"surveyTitle": "example",
"description": "example",
"answeredQuestions": [
{
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example",
"answerDefinitionGroup": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"description": "example",
"readOnly": true,
"answerDefinitions": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"definition": "example",
"sequenceNumber": 1,
"hasInput": true,
"active": true,
"score": 1,
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
],
"classificationId": "example",
"answerDefinitionGroupId": 1
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"definition": "example",
"sequenceNumber": 1,
"hasInput": true,
"active": true,
"score": 1,
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
],
"classificationId": "example",
"answerDefinitionGroupId": 1
}
],
"questions": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example"
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example"
}
],
"classificationId": "example"
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
]
},
{
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example",
"answerDefinitionGroup": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"description": "example",
"readOnly": true,
"answerDefinitions": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"definition": "example",
"sequenceNumber": 1,
"hasInput": true,
"active": true,
"score": 1,
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
],
"classificationId": "example",
"answerDefinitionGroupId": 1
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"definition": "example",
"sequenceNumber": 1,
"hasInput": true,
"active": true,
"score": 1,
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
],
"classificationId": "example",
"answerDefinitionGroupId": 1
}
],
"questions": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example"
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example"
}
],
"classificationId": "example"
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
]
}
]
}
},
"xml": {
"name": "carePlanEntry"
}
},
"dossier.DemandEntry": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"carePlanEntryId": {
"type": "integer",
"format": "int64"
},
"demand": {
"$ref": "#/components/schemas/dossier.Demand"
},
"demandId": {
"type": "integer",
"format": "int64"
},
"comment": {
"type": "string"
}
},
"description": "Zorgplan \"aandachtspunt\" entry",
"example": {
"updatedAt": "2014-04-01T17:00:00.000+02:00",
"createdAt": "2013-12-01T17:00:00.000+01:00",
"createdBy": "user",
"id": 1,
"carePlanEntryId": 2,
"demand": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 1,
"definition": "example",
"protocolUrl": "example",
"hidden": true,
"classificationId": "example"
},
"demandId": 3,
"comment": "Een opmerking"
},
"xml": {
"name": "demandEntry"
}
},
"dossier.Demand": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"domain": {
"$ref": "#/components/schemas/dossier.Domain"
},
"domainId": {
"type": "integer",
"format": "int64"
},
"definition": {
"type": "string"
},
"protocolUrl": {
"type": "string"
},
"hidden": {
"type": "boolean",
"default": false
},
"classificationId": {
"type": "string"
}
},
"description": "Zorgplan \"aandachtspunt\"",
"example": {
"updatedAt": "2014-04-01T17:00:00.000+02:00",
"createdAt": "2013-12-01T17:00:00.000+01:00",
"createdBy": "user",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 2,
"definition": "Definitie",
"protocolUrl": "http://www.nedap.com/",
"hidden": true,
"classificationId": "classification.problem.health.nutrition"
},
"xml": {
"name": "demand"
}
},
"dossier.GoalEntry": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"comment": {
"type": "string"
},
"title": {
"type": "string"
},
"carePlanEntryId": {
"type": "integer",
"format": "int64"
},
"goal": {
"$ref": "#/components/schemas/dossier.Goal"
},
"goalId": {
"type": "integer",
"format": "int64"
},
"targetDate": {
"type": "string",
"format": "date-time"
}
},
"description": "Zorgplan \"doel\" entry.",
"example": {
"updatedAt": "2014-04-01T17:00:00.000+02:00",
"createdAt": "2013-12-01T17:00:00.000+01:00",
"createdBy": "user",
"id": 1,
"comment": "Een opmerking",
"title": "Een titlel",
"carePlanEntryId": 2,
"goal": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 1,
"demandId": 1,
"definition": "example",
"allowTitleOverride": true,
"allowComment": true,
"reportProgress": true,
"hidden": true,
"classificationId": "example"
},
"goalId": 3,
"targetDate": "2014-04-01T17:00:00.000+02:00"
},
"xml": {
"name": "goalEntry"
}
},
"survey.ImportantForCarePlanGroup": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"groupAnswerId": {
"type": "integer",
"format": "int64"
},
"surveyTitle": {
"type": "string"
},
"description": {
"type": "string"
},
"answeredQuestions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/survey.AnsweredQuestion"
},
"xml": {
"wrapped": true
}
}
},
"description": "ImportantForCarePlanGroup model (no description)",
"example": {
"id": 1,
"groupAnswerId": 5,
"surveyTitle": "Mooie vragenlijst",
"description": "Leeftijd vragen",
"answeredQuestions": [
{
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "uw leeftijd?",
"additionalInfo": "vul leeftijd in",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 3,
"groupId": 1,
"answerDefinitionGroup": {
"updatedAt": "2012-08-02T13:48:46.836+02:00",
"createdAt": "2012-08-02T13:48:46.836+02:00",
"id": 1,
"description": "heel oud",
"readOnly": false
},
"updatedAt": "2012-08-02T13:48:46.836+02:00",
"createdAt": "2012-08-02T13:48:46.836+02:00",
"answers": [
{
"updatedAt": "2012-08-02T13:48:46.836+02:00",
"createdAt": "2012-08-02T13:48:46.836+02:00",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "heeeeel oud",
"booleanAnswer": false
}
]
}
]
},
"xml": {
"name": "importantForCarePlanGroup"
}
},
"survey.AnsweredQuestion": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/survey.Question"
}
],
"properties": {
"answers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/survey.Answer"
},
"xml": {
"wrapped": true
}
}
},
"description": "AnsweredQuestion model (no description)",
"example": {
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "uw leeftijd?",
"additionalInfo": "vul leeftijd in",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 3,
"groupId": 1,
"classificationId": "classification.problem.health.nutrition.signs",
"answerDefinitionGroup": {
"updatedAt": "2012-08-02T13:48:46.836+02:00",
"createdAt": "2012-08-02T13:48:46.836+02:00",
"createdBy": "user",
"id": 1,
"description": "heel oud",
"readOnly": false
},
"updatedAt": "2012-08-02T13:48:46.836+02:00",
"createdAt": "2012-08-02T13:48:46.836+02:00",
"createdBy": "user",
"answers": [
{
"updatedAt": "2012-08-02T13:48:46.836+02:00",
"createdAt": "2012-08-02T13:48:46.836+02:00",
"createdBy": "user",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "heeeeel oud",
"booleanAnswer": false
}
]
}
},
"survey.Question": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"sequenceNumber": {
"type": "integer",
"format": "int32",
"default": 0
},
"answerType": {
"type": "integer",
"format": "int32",
"default": 0
},
"text": {
"type": "string"
},
"additionalInfo": {
"type": "string"
},
"defaultAnswer": {
"type": "integer",
"format": "int32"
},
"skipOnYes": {
"type": "boolean"
},
"active": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"answerMaxLength": {
"type": "integer",
"format": "int32"
},
"groupId": {
"type": "integer",
"format": "int64"
},
"classificationId": {
"type": "string"
},
"answerDefinitionGroup": {
"$ref": "#/components/schemas/survey.AnswerDefinitionGroup"
}
},
"description": "Question model (no description)",
"example": {
"updatedAt": "2012-08-02T13:48:46.836+02:00",
"createdAt": "2012-08-02T13:48:46.836+02:00",
"createdBy": "user",
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "uw leeftijd?",
"additionalInfo": "vul leeftijd in",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 3,
"groupId": 1,
"classificationId": "classification.problem.health.nutrition.signs",
"answerDefinitionGroup": {
"updatedAt": "2012-08-02T13:48:46.836+02:00",
"createdAt": "2012-08-02T13:48:46.836+02:00",
"id": 1,
"description": "heel oud",
"readOnly": false
}
},
"xml": {
"name": "question"
}
},
"survey.AnswerDefinitionGroup": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"description": {
"type": "string"
},
"readOnly": {
"type": "boolean"
},
"answerDefinitions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/survey.AnswerDefinition"
},
"xml": {
"wrapped": true
}
},
"questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/survey.Question"
},
"xml": {
"wrapped": true
}
},
"classificationId": {
"type": "string"
}
},
"description": "AnswerDefinitionGroup model (no description)",
"example": {
"updatedAt": "2012-08-02T13:48:46.836+02:00",
"createdAt": "2012-08-02T13:48:46.836+02:00",
"createdBy": "user",
"id": 1,
"description": "heel oud",
"readOnly": false,
"answerDefinitions": [],
"questions": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example"
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example"
}
],
"classificationId": "classification.problem.health.nutrition"
},
"xml": {
"name": "answerDefinitionGroup"
}
},
"survey.AnswerDefinition": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"definition": {
"type": "string"
},
"sequenceNumber": {
"type": "integer",
"format": "int32"
},
"hasInput": {
"type": "boolean"
},
"active": {
"type": "boolean"
},
"score": {
"type": "integer",
"format": "int32"
},
"answers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/survey.Answer"
},
"xml": {
"wrapped": true
}
},
"classificationId": {
"type": "string"
},
"answerDefinitionGroupId": {
"type": "integer",
"format": "int32"
}
},
"description": "AnswerDefinition model (no description)",
"example": {
"updatedAt": "2012-08-02T13:48:46.836+02:00",
"createdAt": "2012-08-02T13:48:46.836+02:00",
"createdBy": "user",
"id": 1,
"definition": "heel oud",
"sequenceNumber": 1,
"hasInput": false,
"active": false,
"score": 12,
"answers": [],
"classificationId": "classification.reach_modifier.individual",
"answerDefinitionGroupId": 1
},
"xml": {
"name": "answerDefinition"
}
},
"survey.Answer": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"surveyResultObjectId": {
"type": "integer",
"format": "int64"
},
"questionObjectId": {
"type": "integer",
"format": "int64"
},
"answerDefinitionObjectId": {
"type": "integer",
"format": "int64"
},
"text": {
"type": "string"
},
"important": {
"type": "boolean"
},
"booleanAnswer": {
"type": "boolean"
}
},
"description": "Answer model (no description)",
"example": {
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"text": "heeeeel oud",
"answerDefinitionObjectId": 1,
"important": false,
"booleanAnswer": false,
"createdAt": "2012-08-02T13:48:46.836+02:00",
"updatedAt": "2012-08-02T13:48:46.836+02:00",
"createdBy": "user"
},
"xml": {
"name": "answer"
}
},
"dossier.CreateCarePlanEntry": {
"type": "object",
"properties": {
"carePlanEntry": {
"$ref": "#/components/schemas/dossier.CarePlanEntry"
},
"actionEntries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.ActionEntry"
},
"xml": {
"wrapped": true
}
},
"demandEntry": {
"$ref": "#/components/schemas/dossier.DemandEntry"
},
"goalEntry": {
"$ref": "#/components/schemas/dossier.GoalEntry"
}
},
"description": "@deprecated This class is deprecated, at the moment of writing this class there is no way in Cupido to create\na model that depends on creations of other models.",
"example": {
"carePlanEntry": {
"id": 1,
"carePlanId": 6,
"percentageRealized": 20,
"percentageTarget": 0
},
"actionEntries": [
{
"actionId": 3,
"title": "Een titel"
}
],
"demandEntry": {
"id": 2,
"demandId": 3,
"comment": "Een opmerking"
},
"goalEntry": {
"id": 3,
"comment": "Een opmerking",
"title": "Een titlel",
"goalId": 3
}
},
"deprecated": true,
"xml": {
"name": "createCarePlanEntry"
},
"x-deprecated-since": "10-07-2014"
},
"dossier.CarePlan": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"clientId": {
"type": "integer",
"format": "int64"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"carePlanEntries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.CarePlanEntry"
},
"xml": {
"wrapped": true
}
},
"status": {
"$ref": "#/components/schemas/dossier.CarePlanStatus"
},
"beginDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
}
},
"description": "\"Zorgplan\"",
"example": {
"updatedAt": "2014-04-01T17:00:00.000+02:00",
"createdAt": "2013-12-01T17:00:00.000+01:00",
"createdBy": "user",
"id": 1,
"clientId": 1,
"employeeId": 1,
"carePlanEntries": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"carePlanId": 1,
"demandEntry": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"carePlanEntryId": 1,
"demand": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 1,
"definition": "example",
"protocolUrl": "example",
"hidden": true,
"classificationId": "example"
},
"demandId": 1,
"comment": "example"
},
"demandEntryId": 1,
"goalEntry": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"comment": "example",
"title": "example",
"carePlanEntryId": 1,
"goal": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 1,
"demandId": 1,
"definition": "example",
"allowTitleOverride": true,
"allowComment": true,
"reportProgress": true,
"hidden": true,
"classificationId": "example"
},
"goalId": 1,
"targetDate": "2014-12-29T00:00:00.000+01:00"
},
"goalEntryId": 1,
"actionEntries": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"carePlanEntryId": 1,
"action": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 1,
"goal": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 1,
"demandId": 1,
"definition": "example",
"allowTitleOverride": true,
"allowComment": true,
"reportProgress": true,
"hidden": true,
"classificationId": "example"
},
"goalId": 1,
"definition": "example",
"instructionUrl": "example",
"allowTitleOverride": true,
"allowComment": true,
"hidden": true,
"classificationId": "example"
},
"actionId": 1,
"carePlanPersistentActionId": 1,
"comment": "example",
"title": "example"
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"carePlanEntryId": 1,
"action": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 1,
"goal": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 1,
"demandId": 1,
"definition": "example",
"allowTitleOverride": true,
"allowComment": true,
"reportProgress": true,
"hidden": true,
"classificationId": "example"
},
"goalId": 1,
"definition": "example",
"instructionUrl": "example",
"allowTitleOverride": true,
"allowComment": true,
"hidden": true,
"classificationId": "example"
},
"actionId": 1,
"carePlanPersistentActionId": 1,
"comment": "example",
"title": "example"
}
],
"percentageRealized": 1,
"percentageTarget": 1,
"importantForCarePlanGroupId": 1,
"importantForCarePlanGroup": {
"id": 1,
"groupAnswerId": 1,
"surveyTitle": "example",
"description": "example",
"answeredQuestions": [
{
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example",
"answerDefinitionGroup": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"description": "example",
"readOnly": true,
"answerDefinitions": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"definition": "example",
"sequenceNumber": 1,
"hasInput": true,
"active": true,
"score": 1,
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
],
"classificationId": "example",
"answerDefinitionGroupId": 1
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"definition": "example",
"sequenceNumber": 1,
"hasInput": true,
"active": true,
"score": 1,
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
],
"classificationId": "example",
"answerDefinitionGroupId": 1
}
],
"questions": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example"
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example"
}
],
"classificationId": "example"
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
]
},
{
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example",
"answerDefinitionGroup": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"description": "example",
"readOnly": true,
"answerDefinitions": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"definition": "example",
"sequenceNumber": 1,
"hasInput": true,
"active": true,
"score": 1,
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
],
"classificationId": "example",
"answerDefinitionGroupId": 1
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"definition": "example",
"sequenceNumber": 1,
"hasInput": true,
"active": true,
"score": 1,
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
],
"classificationId": "example",
"answerDefinitionGroupId": 1
}
],
"questions": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example"
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example"
}
],
"classificationId": "example"
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
]
}
]
}
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"carePlanId": 1,
"demandEntry": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"carePlanEntryId": 1,
"demand": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 1,
"definition": "example",
"protocolUrl": "example",
"hidden": true,
"classificationId": "example"
},
"demandId": 1,
"comment": "example"
},
"demandEntryId": 1,
"goalEntry": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"comment": "example",
"title": "example",
"carePlanEntryId": 1,
"goal": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 1,
"demandId": 1,
"definition": "example",
"allowTitleOverride": true,
"allowComment": true,
"reportProgress": true,
"hidden": true,
"classificationId": "example"
},
"goalId": 1,
"targetDate": "2014-12-29T00:00:00.000+01:00"
},
"goalEntryId": 1,
"actionEntries": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"carePlanEntryId": 1,
"action": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 1,
"goal": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 1,
"demandId": 1,
"definition": "example",
"allowTitleOverride": true,
"allowComment": true,
"reportProgress": true,
"hidden": true,
"classificationId": "example"
},
"goalId": 1,
"definition": "example",
"instructionUrl": "example",
"allowTitleOverride": true,
"allowComment": true,
"hidden": true,
"classificationId": "example"
},
"actionId": 1,
"carePlanPersistentActionId": 1,
"comment": "example",
"title": "example"
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"carePlanEntryId": 1,
"action": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 1,
"goal": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"domain": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"name": "example",
"hidden": true,
"classificationId": "example"
},
"domainId": 1,
"demandId": 1,
"definition": "example",
"allowTitleOverride": true,
"allowComment": true,
"reportProgress": true,
"hidden": true,
"classificationId": "example"
},
"goalId": 1,
"definition": "example",
"instructionUrl": "example",
"allowTitleOverride": true,
"allowComment": true,
"hidden": true,
"classificationId": "example"
},
"actionId": 1,
"carePlanPersistentActionId": 1,
"comment": "example",
"title": "example"
}
],
"percentageRealized": 1,
"percentageTarget": 1,
"importantForCarePlanGroupId": 1,
"importantForCarePlanGroup": {
"id": 1,
"groupAnswerId": 1,
"surveyTitle": "example",
"description": "example",
"answeredQuestions": [
{
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example",
"answerDefinitionGroup": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"description": "example",
"readOnly": true,
"answerDefinitions": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"definition": "example",
"sequenceNumber": 1,
"hasInput": true,
"active": true,
"score": 1,
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
],
"classificationId": "example",
"answerDefinitionGroupId": 1
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"definition": "example",
"sequenceNumber": 1,
"hasInput": true,
"active": true,
"score": 1,
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
],
"classificationId": "example",
"answerDefinitionGroupId": 1
}
],
"questions": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example"
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example"
}
],
"classificationId": "example"
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
]
},
{
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example",
"answerDefinitionGroup": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"description": "example",
"readOnly": true,
"answerDefinitions": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"definition": "example",
"sequenceNumber": 1,
"hasInput": true,
"active": true,
"score": 1,
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
],
"classificationId": "example",
"answerDefinitionGroupId": 1
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"definition": "example",
"sequenceNumber": 1,
"hasInput": true,
"active": true,
"score": 1,
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
],
"classificationId": "example",
"answerDefinitionGroupId": 1
}
],
"questions": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example"
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example"
}
],
"classificationId": "example"
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
]
}
]
}
}
],
"status": "OLD",
"beginDate": "2014-01-01T08:00:00.000+01:00",
"endDate": "2014-05-01T17:00:00.000+02:00"
},
"xml": {
"name": "carePlan"
}
},
"dossier.CarePlanStatus": {
"enum": [
"DRAFT",
"ACTIVE",
"OLD"
],
"type": "string",
"description": "CarePlanStatus enum (no description)",
"example": "DRAFT"
},
"dossier.ClientNote": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dossier.BaseNote"
}
],
"properties": {
"clientId": {
"type": "integer",
"format": "int64"
}
},
"description": "ClientNote model (no description)",
"example": {
"id": 1,
"content": "Dummy",
"visibleOnWorksheet": true,
"deleted": true,
"startDate": "2014-06-16",
"endDate": "2014-06-16",
"updatedByAuthorId": 1,
"authorId": 1,
"updatedAt": "2014-06-16T02:00:00.000+02:00",
"createdAt": "2014-06-16T02:00:00.000+02:00",
"createdBy": "Dummy",
"clientId": 1
},
"xml": {
"name": "clientNote"
}
},
"dossier.BaseNote": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"content": {
"type": "string"
},
"visibleOnWorksheet": {
"type": "boolean"
},
"deleted": {
"type": "boolean"
},
"startDate": {
"type": "string",
"format": "date"
},
"endDate": {
"type": "string",
"format": "date"
},
"updatedByAuthorId": {
"type": "integer",
"format": "int64"
},
"authorId": {
"type": "integer",
"format": "int64"
}
},
"description": "BaseNote model (no description)",
"example": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"content": "example",
"visibleOnWorksheet": true,
"deleted": true,
"startDate": "2014-12-29",
"endDate": "2014-12-29",
"updatedByAuthorId": 1,
"authorId": 1
}
},
"dossier.MedicalNote": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dossier.BaseNote"
}
],
"properties": {
"clientId": {
"type": "integer",
"format": "int64"
}
},
"description": "MedicalNote model (no description)",
"example": {
"id": 1,
"content": "Dummy",
"visibleOnWorksheet": true,
"deleted": true,
"startDate": "2014-06-16",
"endDate": "2014-06-16",
"updatedByAuthorId": 1,
"authorId": 1,
"updatedAt": "2014-06-16T02:00:00.000+02:00",
"createdAt": "2014-06-16T02:00:00.000+02:00",
"createdBy": "Dummy",
"clientId": 1
},
"xml": {
"name": "medicalNote"
}
},
"dossier.ReportType": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"name": {
"type": "string"
},
"valueType": {
"type": "string"
},
"format": {
"type": "string"
},
"unit": {
"type": "string"
},
"defaultValue": {
"type": "integer",
"format": "int32"
},
"hasTime": {
"type": "boolean"
},
"iconSrc": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
},
"description": "ReportType model (no description)",
"example": {
"updatedAt": "2014-04-01T17:00:00.000+02:00",
"createdAt": "2013-12-01T17:00:00.000+01:00",
"createdBy": "user",
"id": 1,
"name": "Rapportage",
"valueType": "Comment",
"format": "%s",
"unit": "mm[Hg]",
"defaultValue": 0,
"hasTime": false,
"iconSrc": "heartbleed.gif",
"enabled": true
},
"xml": {
"name": "reportType"
}
},
"dossier.Report": {
"required": [
"reportTypeId"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"uuid": {
"type": "string"
},
"reportingDate": {
"type": "string",
"format": "date-time"
},
"comment": {
"type": "string"
},
"flagged": {
"type": "boolean"
},
"confidential": {
"type": "boolean",
"description": "Signals whether a report is only visible to certain disciplines (listed in reportAuthorizations)\nIn the case of SOEP-reports (reportType 315), this flag is only true when ALL reportEntries are\nconfidential."
},
"hidden": {
"type": "boolean"
},
"hidingReason": {
"type": "string"
},
"parentId": {
"type": "integer",
"format": "int64"
},
"parentType": {
"type": "string"
},
"carenId": {
"type": "integer",
"format": "int64"
},
"carenName": {
"type": "string"
},
"carenRole": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
},
"clientId": {
"type": "integer",
"format": "int64"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"reportTypeId": {
"type": "integer",
"description": "The report type, the objectId of {@link com.nedap.healthcare.domain.dossier.ReportType}\nWhich should be one of the following values:\n\n101 Rapportage\n102 Gewicht\n103 Bloeddruk\n104 Temperatuur\n105 Bloedsuiker\n106 Vocht inname\n107 Vocht uitscheiding\n108 Defecatie\n109 Medisch\n110 Voortgang\n111 Familie communicatie\n112 Keten communicatie\n309 Stemming\n310 Omaha\n311 Saturatie\n314 Pijnscore\n315 SOEP\n316 Bristol-stoelgangschaal\n317 Klinimetrie\n
",
"format": "int64"
},
"carePlanEntryId": {
"type": "integer",
"format": "int64"
},
"reportEntries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.ReportEntry"
},
"xml": {
"wrapped": true
}
},
"expertiseProfile": {
"$ref": "#/components/schemas/ExpertiseProfile"
},
"reportActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.ReportAction"
},
"xml": {
"wrapped": true
}
},
"reportAuthorizations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.ReportAuthorization"
},
"xml": {
"wrapped": true
}
},
"soapReportEntries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.SoapReportEntry"
},
"xml": {
"wrapped": true
}
},
"episodeId": {
"type": "integer",
"description": "Deprecated since: 14-03-2019 -- use episodeIds",
"format": "int64",
"deprecated": true
},
"episodeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64",
"xml": {
"name": "episodeId"
}
},
"xml": {
"wrapped": true
}
},
"restrictiveMeasureId": {
"type": "integer",
"format": "int64"
},
"reportLinkId": {
"type": "integer",
"format": "int64"
},
"reportLinkType": {
"$ref": "#/components/schemas/dossier.ReportLinkType"
}
},
"description": "The report for which this report right applies",
"example": {
"updatedAt": "2011-09-05T08:28:25.000+02:00",
"createdAt": "2011-09-05T08:28:25.000+02:00",
"createdBy": "user",
"id": 1,
"uuid": "12345234900234",
"reportingDate": "2011-09-05T08:28:25.000+02:00",
"comment": "Mevrouw rook vanmiddag naar alocohol, blijkbaar weet ze toch aan drank te komen. Kamer nalopen op verborgen drank.",
"flagged": false,
"confidential": false,
"hidden": false,
"hidingReason": "unknown",
"parentId": 1,
"parentType": "careplanreport",
"carenId": 1,
"carenName": "zusje",
"carenRole": "nurse",
"status": 1,
"clientId": 212,
"employeeId": 1402,
"reportTypeId": 101,
"carePlanEntryId": 8351,
"reportEntries": [
{
"name": "systolicPressure",
"value": "120",
"format": "%.1f",
"unit": "mm[Hg]",
"displayName": "Systolic pressure"
}
],
"expertiseProfile": {
"id": 11889,
"description": "Specialist ouderen",
"visible": true
},
"reportActions": [
{
"expertiseProfileId": 3,
"expertiseGroupObjectId": 2,
"employeeId": 4085,
"dateFinished": "2011-09-05T08:52:48.000+02:00"
}
],
"reportAuthorizations": [
{
"id": 1,
"carePlanId": 1,
"expertiseProfileId": 1,
"expertiseGroupObjectId": 1
},
{
"id": 1,
"carePlanId": 1,
"expertiseProfileId": 1,
"expertiseGroupObjectId": 1
}
],
"soapReportEntries": [
{
"soapPart": "Subjective",
"confidential": true,
"content": "Text about the subjective experiences of the client",
"expertiseProfileIds": [
1,
2,
3
],
"expertiseGroupIds": [
4,
5,
6
]
},
{
"soapPart": "Objective",
"confidential": false,
"content": "Text about the objective experiences of the client"
}
],
"episodeId": 22,
"episodeIds": [
22,
23
],
"restrictiveMeasureId": 24,
"reportLinkId": 123,
"reportLinkType": "NEXT_DOSSIER"
},
"xml": {
"name": "report"
}
},
"dossier.ReportEntry": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Explicitly supported values for well-known report types are:\n- decimalValue\n- systolicPressure\n- diastolicPressure\n- heartRate\n- weight\n- size\n- bmi\n- subjective\n- objective\n- assessment\n- plan"
},
"value": {
"type": "string"
},
"format": {
"type": "string"
},
"unit": {
"type": "string"
},
"displayName": {
"type": "string"
}
},
"description": "ReportEntry model (no description)",
"example": {
"name": "systolicPressure",
"value": "120",
"format": "%.1f",
"unit": "mm[Hg]",
"displayName": "Systolic pressure"
},
"xml": {
"name": "reportEntry"
}
},
"dossier.ReportAction": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dossier.ReportAuthorization"
}
],
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"dateFinished": {
"type": "string",
"format": "date-time"
}
},
"description": "ReportAction model (no description)",
"example": {
"id": 1,
"carePlanId": 1,
"expertiseProfileId": 1,
"expertiseGroupObjectId": 2,
"employeeId": 1,
"dateFinished": "2014-07-24T02:00:00.000+02:00"
},
"xml": {
"name": "reportAction"
}
},
"dossier.ReportAuthorization": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"carePlanId": {
"type": "integer",
"description": "Deprecated since: 14-03-2019",
"format": "int64",
"deprecated": true
},
"expertiseProfileId": {
"type": "integer",
"format": "int64"
},
"expertiseGroupObjectId": {
"type": "integer",
"format": "int64"
}
},
"description": "Only present when dossier.Report.confidential == true, then:\n- In the case of SOEP-reports (reportType 315), contains all disciplines that can see any of the \nSOEP-report's reportEntries. Which discipline can see which entry is defined on the reportEntries themselves.\n- For other reports, contains which discipline can see the report.",
"example": {
"id": 1,
"carePlanId": 1,
"expertiseProfileId": 1,
"expertiseGroupObjectId": 1
},
"xml": {
"name": "reportAuthorization"
}
},
"dossier.SoapReportEntry": {
"type": "object",
"properties": {
"soapPart": {
"type": "string"
},
"confidential": {
"type": "boolean",
"description": "When this is true this SOAP entry is shown regardless of the attached rights",
"default": false
},
"content": {
"type": "string"
},
"expertiseProfileIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64",
"xml": {
"name": "expertiseProfileId"
}
},
"xml": {
"wrapped": true
}
},
"expertiseGroupIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64",
"xml": {
"name": "expertiseGroupId"
}
},
"xml": {
"wrapped": true
}
}
},
"description": "SoapReportEntry model (no description)",
"example": {
"soapPart": "Subjective",
"confidential": true,
"content": "Text about the subjective experiences of the client",
"expertiseProfileIds": [
1,
2,
3
],
"expertiseGroupIds": [
4,
5,
6
]
},
"xml": {
"name": "soapReportEntry"
}
},
"dossier.SystemNote": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dossier.BaseNote"
}
],
"description": "SystemNote model (no description)",
"example": {
"id": 1,
"content": "Dummy",
"visibleOnWorksheet": true,
"deleted": true,
"startDate": "2014-06-16",
"endDate": "2014-06-16",
"updatedByAuthorId": 1,
"authorId": 1,
"updatedAt": "2014-06-16T02:00:00.000+02:00",
"createdAt": "2014-06-16T02:00:00.000+02:00",
"createdBy": "Dummy"
}
},
"EmployeeAddress": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Address"
}
],
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
}
},
"description": "EmployeeAddress model (no description)",
"example": {
"id": 1,
"beginDate": "2010-02-16",
"endDate": "2010-02-17",
"homeNumber": 4,
"homeNumberExtension": "a",
"poBoxNumber": "123a",
"street": "Parallelweg",
"city": "Enschede",
"zipcode": "7513KC",
"municipality": "Enschede",
"country": "Netherlands",
"telephoneNumber": "053-1234567",
"telephoneCountryCode": "+31",
"telephoneNumber2": "053-1234567",
"telephoneCountryCode2": "+31",
"faxNumber": "053-1234567",
"email": "mike.wazowski@nedap.com",
"type": "residence address",
"typeString": "temporary",
"residentType": "0",
"personType": "client",
"personTypeString": "birthname",
"roomNumber": "1",
"locationDescription": "Afdeling noord",
"updatedAt": "2016-01-01T12:00:00.000+01:00",
"createdAt": "2016-01-01T12:00:00.000+01:00",
"latitude": 52.1,
"longitude": 6.9,
"employeeId": 2,
"situationDescription": "Test",
"residenceAccessInfo": "Test"
},
"xml": {
"name": "employeeAddress"
}
},
"Employee": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Person"
}
],
"properties": {
"contractId": {
"type": "string",
"description": "Deprecated, this field is never set, use Contract APIs.",
"deprecated": true
},
"mobilePhoneNumber": {
"type": "string",
"description": "Deprecated, this field is never set.",
"deprecated": true
},
"authenticationMobilePhone": {
"type": "string",
"description": "The mobile phone number used for two-factor authentication messages."
},
"workMobilePhone": {
"type": "string",
"description": "The work mobile phone number of the employee."
},
"privateMobilePhone": {
"type": "string",
"description": "The private mobile phone number of the employee."
},
"homePhone": {
"type": "string",
"description": "The home phone number of the employee."
},
"homeEmailAddress": {
"type": "string",
"description": "The private email address of the employee."
},
"fixedHoursPerWeek": {
"type": "number",
"description": "Deprecated, this field is never set, use Contract APIs.",
"format": "double",
"deprecated": true
},
"varHoursPerWeek": {
"type": "number",
"description": "Deprecated, this field is never set, use Contract APIs.",
"format": "double",
"deprecated": true
},
"unknownEmployee": {
"type": "boolean",
"description": "Indicates if this employee is the unknown employee."
},
"verifiedUntilDate": {
"type": "string",
"description": "Date up to which the presence logs of this employee are verfied.",
"format": "date"
},
"limitedEmployee": {
"type": "boolean",
"description": "Deprecated, this field is never set.",
"deprecated": true
},
"uuid": {
"type": "string",
"description": "Type 4 Universally Unique Identifier of the employee."
},
"employeePrivacySettings": {
"$ref": "#/components/schemas/EmployeePrivacySettings"
},
"type": {
"type": "integer",
"description": "Type of the employee. Allowed values:\n0: Regular\n1: External",
"format": "int32"
},
"teamName": {
"type": "string",
"description": "Name of the team the employee belongs to."
}
},
"description": "Employee model (no description)",
"example": {
"id": 1,
"firstName": "Mike",
"birthName": "Wazowski",
"name": "Dhr Mike Wazowski",
"identificationNo": "wazo",
"dateOfBirth": "1982-01-01",
"preferredNameType": "0",
"lastName": "Wazowski",
"partnerName": "none",
"initials": "W",
"prefix": "ir",
"birthNamePrefix": "ir",
"partnerNamePrefix": "none",
"gender": "M",
"emailAddress": "mike.wazowski@nedap.com",
"contractId": "1",
"mobilePhone": "0612345678",
"mobilePhoneNumber": "0612345678",
"authenticationMobilePhone": "0612345678",
"workMobilePhone": "0612345678",
"privateMobilePhone": "0612345678",
"homePhone": "0612345678",
"homeEmailAddress": "john.doe@home.com",
"fixedHoursPerWeek": 39.5,
"varHoursPerWeek": 0.5,
"unknownEmployee": false,
"verifiedUntilDate": "2012-01-01",
"limitedEmployee": false,
"uuid": "abca58ed-0138-4aec-87c6-5d391e98161b",
"freeField1": "Free field 1 description",
"freeField2": "Free field 2 description",
"freeField3": "Free field 3 description",
"freeField4": "Free field 4 description",
"updatedAt": "2016-01-01T12:00:00.000+01:00",
"createdAt": "2016-01-01T12:00:00.000+01:00",
"type": 0,
"teamName": "Best Team Ever",
"employeePrivacySettings": {
"employeeObjectId": 1,
"shareBirthDay": true,
"sharePrivateEmailAddress": true,
"sharePrivateTelephoneNumber": true,
"shareResidence": true
}
},
"xml": {
"name": "employee"
}
},
"EmployeePrivacySettings": {
"type": "object",
"properties": {
"employeeObjectId": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"shareBirthDay": {
"type": "boolean"
},
"sharePrivateEmailAddress": {
"type": "boolean"
},
"sharePrivateTelephoneNumber": {
"type": "boolean"
},
"shareResidence": {
"type": "boolean"
}
},
"description": "EmployeePrivacySettings model (no description)",
"example": {
"employeeObjectId": 1,
"shareBirthDay": true,
"sharePrivateEmailAddress": true,
"sharePrivateTelephoneNumber": true,
"shareResidence": true
},
"xml": {
"name": "employeePrivacySettings"
}
},
"PractitionerAgbCode": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"employeeObjectId": {
"type": "integer",
"format": "int64"
},
"code": {
"type": "string"
},
"beginDate": {
"type": "string",
"description": "The date at which the agbcode is beginning",
"format": "date"
},
"endDate": {
"type": "string",
"description": "The date at which the agbcode is ending. Null means no ending.",
"format": "date"
},
"primary": {
"type": "boolean",
"description": "Indicates if this is the primary agbcode for the employee"
}
},
"description": "PractitionerAgbCode model (no description)",
"example": {
"id": 1,
"employeeObjectId": 1,
"code": "12345678",
"beginDate": "2022-01-01",
"endDate": "2022-12-31",
"primary": true
}
},
"PractitionerBigCode": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"employeeObjectId": {
"type": "integer",
"format": "int64"
},
"code": {
"type": "string"
}
},
"description": "PractitionerBigCode model (no description)",
"example": {
"id": 1,
"employeeObjectId": 1,
"code": "12345678"
}
},
"PractitionerProfession": {
"required": [
"beginDate"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"employeeObjectId": {
"type": "integer",
"description": "Id referring to the Employee object",
"format": "int64"
},
"code": {
"type": "string",
"description": "Profession code from the code list indicated in typeCode."
},
"name": {
"type": "string",
"description": "Abbreviated name for the profession"
},
"info": {
"type": "string",
"description": "Full description for the profession"
},
"type": {
"type": "string",
"description": "Indicates the codelist this profession orginates from\nPlease use #professionType instead",
"deprecated": true
},
"professionType": {
"allOf": [
{
"$ref": "#/components/schemas/PractitionerProfessionType"
}
],
"description": "Indicates the codelist this profession orginates from"
},
"beginDate": {
"type": "string",
"description": "The date at which the profession is beginning",
"format": "date"
},
"endDate": {
"type": "string",
"description": "The date at which the profession is ending. Null means no ending.",
"format": "date"
}
},
"description": "Practioner profession returned from Cupido for an Employee.\n\nWhen PUT-ing or POST-ing PractitionerProfessions, the combination of code and professionType is used to uniquely identify the profession.",
"example": {
"id": 1,
"employeeObjectId": 1,
"code": "9992",
"name": "VK.OB.overig",
"info": "Overig",
"type": "COD878_GZ_BEROEPZORGVERLENER",
"professionType": 0,
"beginDate": "2018-01-01",
"endDate": "2018-12-31"
}
},
"PractitionerProfessionType": {
"type": "integer",
"oneOf": [
{
"title": "COD878_GZ_BEROEPZORGVERLENER",
"enum": [
0
]
},
{
"title": "COD016_PEZ_GRZ_SUBBEROEPSGROEP",
"enum": [
1
]
},
{
"title": "ZPM_BEROEP",
"enum": [
2
]
}
],
"description": "Indicates the codelist this profession orginates from",
"example": 0
},
"TeamAssignment": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"beginDate": {
"type": "string",
"format": "date"
},
"endDate": {
"type": "string",
"format": "date"
},
"employeeObjectId": {
"type": "integer",
"format": "int64"
},
"teamObjectId": {
"type": "integer",
"format": "int64"
}
},
"description": "Team assignment.",
"example": {
"id": 1,
"beginDate": "2012-08-02",
"endDate": "2012-08-02",
"employeeObjectId": 8948,
"teamObjectId": 337
},
"xml": {
"name": "teamAssignment"
}
},
"ons_administration.WorkdayNormSettingsModel": {
"required": [
"employeeObjectId",
"startDate"
],
"type": "object",
"properties": {
"claDefault": {
"type": "boolean",
"description": "If true, these settings are the default from the collective labour agreement",
"readOnly": true
},
"employeeObjectId": {
"type": "integer",
"description": "The employee object id",
"format": "int64"
},
"endDate": {
"type": "string",
"description": "The end date of the period during which this setting is valid",
"format": "date"
},
"id": {
"type": "integer",
"description": "The object id of the settings, required for UPDATE",
"format": "int64"
},
"normPeriod": {
"type": "integer",
"description": "The measurement period in weeks to evaluate if the workday norm is breached. Required when optOut is false",
"format": "int32"
},
"optOut": {
"type": "boolean",
"description": "If true, the employee is opted out of the workday norm"
},
"startDate": {
"type": "string",
"description": "The start date of the period during which this setting is valid",
"format": "date"
},
"workdayNorm": {
"type": "integer",
"description": "DEPRECATED: use workdayNormTotal instead. The maximum number of workdays the employee has to work in a week",
"format": "int32",
"deprecated": true,
"x-deprecated-since": "20-01-2026"
},
"workdayNormTotal": {
"type": "integer",
"description": "The total number of workdays the employee has to work in the whole measurement period. Required when optOut is false",
"format": "int32"
}
},
"description": "Workday norm settings model. This model describes the maximum workdays a given\nemployee has to work per week during a given measurement period.\n",
"example": {
"id": 7,
"employeeObjectId": 42,
"startDate": "2025-12-29",
"endDate": "2026-12-27",
"workdayNormTotal": 20,
"normPeriod": 4,
"optOut": false
}
},
"ons_administration.ExtendedEmployeeModel": {
"required": [
"firstName",
"gender",
"initials"
],
"type": "object",
"properties": {
"addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ons_administration.EmployeeAddressModel"
},
"description": "List of employee addresses"
},
"authenticationMobilePhoneNumber": {
"maxLength": 20,
"type": "string",
"description": "Authentication mobile phone number"
},
"birthName": {
"maxLength": 100,
"type": "string",
"description": "Birth name of the employee"
},
"birthNamePrefix": {
"maxLength": 20,
"type": "string",
"description": "Prefix for the birth name"
},
"collectiveAgreements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ons_administration.EmployeeCollectiveAgreementModel"
},
"description": "List of collective agreement assignments"
},
"contracts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ons_administration.EmployeeContractModel"
},
"description": "List of employee contracts"
},
"dateOfBirth": {
"type": "string",
"description": "Date of birth of the employee",
"format": "date"
},
"emailAddress": {
"maxLength": 255,
"type": "string",
"description": "Email address"
},
"employeeNumber": {
"type": "string",
"description": "User defined identifier for the employee, must be unique in combination with the employment number"
},
"employmentNumber": {
"type": "string",
"description": "Employment number for the employee, must be unique in combination with the employee number"
},
"expertises": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ons_administration.EmployeeExpertiseModel"
},
"description": "List of expertise profile assignments"
},
"firstName": {
"maxLength": 50,
"type": "string",
"description": "First name of the employee"
},
"gender": {
"$ref": "#/components/schemas/ons_administration.Gender"
},
"homeEmailAddress": {
"maxLength": 255,
"type": "string",
"description": "Home email address"
},
"homePhoneNumber": {
"maxLength": 20,
"type": "string",
"description": "Home phone number"
},
"hourlyWages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ons_administration.EmployeeHourlyWageModel"
},
"description": "List of hourly wages"
},
"initials": {
"maxLength": 10,
"type": "string",
"description": "Initials of the employee"
},
"lastName": {
"type": "string",
"description": "Printable last name of the employee, including prefixes, based on preferred name type",
"readOnly": true
},
"id": {
"type": "integer",
"description": "Unique identifier for the employee used within the Ons suite as primary key",
"format": "int64"
},
"partnerName": {
"maxLength": 100,
"type": "string",
"description": "Name of the partner"
},
"partnerNamePrefix": {
"maxLength": 20,
"type": "string",
"description": "Prefix for the partner name"
},
"preferredNameType": {
"$ref": "#/components/schemas/ons_administration.NameType"
},
"privateMobilePhoneNumber": {
"maxLength": 20,
"type": "string",
"description": "Private mobile phone number"
},
"registrationProfiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ons_administration.EmployeeRegistrationProfileModel"
},
"description": "List of registration profile assignments"
},
"teamAssignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ons_administration.EmployeeTeamModel"
},
"description": "List of team assignments"
},
"workMobilePhoneNumber": {
"maxLength": 20,
"type": "string",
"description": "Work mobile phone number"
},
"workdayNormSettings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ons_administration.EmployeeWorkdayNormSettingsModel"
},
"description": "List of workday norm settings"
}
},
"description": "Extended employee model containing detailed employee information",
"example": {
"id": 12345,
"employeeNumber": "100042",
"employmentNumber": "1",
"initials": "J.D.",
"firstName": "John",
"lastName": "Doe",
"birthName": "Doe",
"gender": "M",
"dateOfBirth": "1980-01-01",
"emailAddress": "john.doe@work.com",
"homeEmailAddress": "john.doe@private.com",
"workMobilePhoneNumber": "0612345678",
"privateMobilePhoneNumber": "0687654321",
"homePhoneNumber": "0101234567",
"contracts": [
{
"fixed": 24.5,
"var": 8.5,
"contractTypeCode": "Fixed",
"beginDate": "2024-01-01"
}
],
"hourlyWages": [
{
"wageInCents": 5450,
"beginDate": "2024-01-01"
}
],
"expertises": [
{
"expertiseProfileCode": "Verpleegkundige",
"beginDate": "2024-01-01"
}
],
"addresses": [
{
"street": "Main Street",
"homeNumber": "10",
"zipcode": "1234 AB",
"city": "Amsterdam",
"country": "NL",
"beginDate": "2024-01-01"
}
],
"teamAssignments": [
{
"teamId": "TEAM-A",
"beginDate": "2024-01-01"
}
],
"collectiveAgreements": [
{
"collectiveAgreementType": "VVT",
"beginDate": "2024-01-01"
}
],
"registrationProfiles": [
{
"registrationProfileName": "Profile A",
"beginDate": "2024-01-01"
}
]
}
},
"ons_administration.Gender": {
"enum": [
"M",
"F",
"X",
"U"
],
"type": "string",
"description": "Gender of the person:\n - M: Male\n - F: Female\n - X: Other\n - U: Unknown\n",
"example": "M"
},
"ons_administration.NameType": {
"enum": [
"OWN",
"PARTNER",
"OWN_PARTNER",
"PARTNER_OWN"
],
"type": "string",
"description": "Printable format for the name of a person",
"example": "OWN"
},
"ons_administration.EmployeeAddressModel": {
"required": [
"beginDate"
],
"type": "object",
"properties": {
"beginDate": {
"type": "string",
"description": "Begin date of the address",
"format": "date"
},
"city": {
"maxLength": 30,
"type": "string",
"description": "The city of the employee's address"
},
"country": {
"maxLength": 2,
"type": "string",
"description": "The country of the employee's address, ISO 3166-1 alpha-2"
},
"employeeNumber": {
"type": "string",
"description": "User defined identifier for the employee, must be unique in combination with the employment number"
},
"employeeObjectId": {
"type": "integer",
"description": "Unique identifier for the employee used within the Ons suite as primary key",
"format": "int64"
},
"employmentNumber": {
"type": "string",
"description": "Employment number for the employee, must be unique in combination with the employee number"
},
"endDate": {
"type": "string",
"description": "End date of the address",
"format": "date"
},
"homeNumber": {
"maxLength": 6,
"type": "string",
"description": "The home number of the employee's address"
},
"homeNumberExtension": {
"maxLength": 6,
"type": "string",
"description": "Optional extension of the home number of the employee's address"
},
"municipality": {
"maxLength": 50,
"type": "string",
"description": "The municipality of the employee's address"
},
"id": {
"type": "integer",
"description": "Unique identifier for the address used within the Ons suite as primary key",
"format": "int64"
},
"poBoxNumber": {
"maxLength": 10,
"type": "string",
"description": "The optional PO-box number of the employee's address"
},
"street": {
"maxLength": 50,
"type": "string",
"description": "The street of the employee's address"
},
"zipcode": {
"type": "string",
"description": "The zipcode of the employee's address. Maximum length of 6 characters for addresses with country NL"
}
},
"description": "Address model for an employee. This model can be used on its own or as part of an extended employee model.\nWhen used on its own, either an employeeObjectId or employeeNumber must be provided. Note that the employeeNumber\nis not necessarily unique on its own, but might require an employmentNumber for uniqueness.\n",
"example": {
"id": 12345,
"employeeObjectId": 6789,
"employeeNumber": "100042",
"employmentNumber": "1",
"street": "Main Street",
"homeNumber": "10",
"homeNumberExtension": "A",
"zipcode": "1234 AB",
"city": "Amsterdam",
"country": "NL",
"beginDate": "2024-01-01",
"endDate": "2024-12-31"
}
},
"ons_administration.EmployeeCollectiveAgreementModel": {
"required": [
"beginDate"
],
"type": "object",
"properties": {
"beginDate": {
"type": "string",
"description": "Begin date of the collective agreement assignment",
"format": "date"
},
"collectiveAgreementType": {
"$ref": "#/components/schemas/ons_administration.CollectiveAgreementType"
},
"employeeNumber": {
"type": "string",
"description": "User defined identifier for the employee, must be unique in combination with the employment number"
},
"employeeObjectId": {
"type": "integer",
"description": "Unique identifier for the employee used within the Ons suite as primary key",
"format": "int64"
},
"employmentNumber": {
"type": "string",
"description": "Employment number for the employee, must be unique in combination with the employee number"
},
"endDate": {
"type": "string",
"description": "End date of the collective agreement assignment",
"format": "date"
},
"id": {
"type": "integer",
"description": "Unique identifier for the collective agreement assignment used within the Ons suite as primary key. Required for updates and deletes",
"format": "int64"
},
"settings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payroll.CollectiveAgreementSetting"
},
"description": "Settings for the collective agreement assignment"
}
},
"description": "Collective agreement assignment model for an employee. This model can be used on its own or as part of an extended employee model.\nWhen used on its own, either an employeeObjectId or employeeNumber must be provided. Note that the employeeNumber\nis not necessarily unique on its own, but might require an employmentNumber for uniqueness.\n\nMultiple collective agreement assignments can be associated with an employee, but they cannot overlap in time.\n",
"example": {
"id": 12345,
"employeeObjectId": 6789,
"employeeNumber": "100042",
"employmentNumber": "1",
"collectiveAgreementType": "VVT",
"beginDate": "2024-01-01",
"endDate": "2024-12-31"
}
},
"ons_administration.CollectiveAgreementType": {
"enum": [
"VVT",
"GHZ",
"GGZ",
"SW",
"ZH",
"HA",
"JZ"
],
"type": "string",
"description": "Type of collective labour agreement:\n- VVT: Verpleeg-, Verzorgingshuizen, Thuiszorg en Jeugdgezondheidszorg\n- GHZ: Gehandicaptenzorg\n- GGZ: Geestelijke gezondheidszorg\n- SW: Sociaal Werk, Welzijn & Maatschappelijke Dienstverlening\n- ZH: Ziekenhuizen\n- HA: Huisartsenzorg\n- JZ: Jeugdzorg\n",
"example": "VVT"
},
"ons_administration.EmployeeContractModel": {
"required": [
"beginDate"
],
"type": "object",
"properties": {
"beginDate": {
"type": "string",
"description": "Begin date of the contract",
"format": "date"
},
"contractTypeCode": {
"type": "string",
"description": "User defined identifier for the contract type (also know as importCode). Either the contractTypeObjectId or contractTypeCode must be provided"
},
"contractTypeObjectId": {
"type": "integer",
"description": "Unique identifier for the contract type used within the Ons suite as primary key. Either the contractTypeObjectId or contractTypeCode must be provided",
"format": "int64"
},
"employeeNumber": {
"type": "string",
"description": "User defined identifier for the employee, must be unique in combination with the employment number"
},
"employeeObjectId": {
"type": "integer",
"description": "Unique identifier for the employee used within the Ons suite as primary key",
"format": "int64"
},
"employmentNumber": {
"type": "string",
"description": "Employment number for the employee, must be unique in combination with the employee number"
},
"endDate": {
"type": "string",
"description": "End date of the contract",
"format": "date"
},
"fixed": {
"maximum": 168,
"type": "number",
"description": "Fixed hours per week",
"format": "double"
},
"id": {
"type": "integer",
"description": "Unique identifier for the contract used within the Ons suite as primary key",
"format": "int64"
},
"var": {
"maximum": 168,
"type": "number",
"description": "Variable hours per week",
"format": "double"
}
},
"description": "Contract model for an employee. This model can be used on its own or as part of an extended employee model.\nWhen used on its own, either an employeeObjectId or employeeNumber must be provided. Note that the employeeNumber\nis not necessarily unique on its own, but might require an employmentNumber for uniqueness.\n\nMultiple contracts can be associated with an employee, but they cannot overlap in time.\n",
"example": {
"id": 12345,
"employeeObjectId": 6789,
"employeeNumber": "100042",
"employmentNumber": "1",
"fixed": 24.5,
"var": 8.5,
"contractTypeObjectId": 1,
"contractTypeCode": "Fixed",
"beginDate": "2024-01-01",
"endDate": "2024-12-31"
}
},
"ons_administration.EmployeeExpertiseModel": {
"required": [
"beginDate"
],
"type": "object",
"properties": {
"beginDate": {
"type": "string",
"description": "Begin date and time of the expertise profile assignment",
"format": "date"
},
"employeeNumber": {
"type": "string",
"description": "User defined identifier for the employee, must be unique in combination with the employment number"
},
"employeeObjectId": {
"type": "integer",
"description": "Unique identifier for the employee used within the Ons suite as primary key",
"format": "int64"
},
"employmentNumber": {
"type": "string",
"description": "Employment number for the employee, must be unique in combination with the employee number"
},
"endDate": {
"type": "string",
"description": "End date and time of the expertise profile assignment",
"format": "date"
},
"expertiseProfileCode": {
"type": "string",
"description": "User defined identifier for the expertise profile (also known as importCode). Either the expertiseProfileObjectId or expertiseProfileCode must be provided"
},
"expertiseProfileObjectId": {
"type": "integer",
"description": "Unique identifier for the expertise profile used within the Ons suite as primary key. Either the expertiseProfileObjectId or expertiseProfileCode must be provided",
"format": "int64"
},
"id": {
"type": "integer",
"description": "Unique identifier for the expertise profile assignment used within the Ons suite as primary key",
"format": "int64"
}
},
"description": "Expertise profile assignment model for an employee. This model can be used on its own or as part of an extended employee model.\nWhen used on its own, either an employeeObjectId or employeeNumber must be provided. Note that the employeeNumber\nis not necessarily unique on its own, but might require an employmentNumber for uniqueness.\n\nMultiple expertise profiles can be associated with an employee, but they cannot overlap in time.\n",
"example": {
"id": 12345,
"employeeObjectId": 6789,
"employeeNumber": "100042",
"employmentNumber": "1",
"expertiseProfileObjectId": 1011,
"expertiseProfileCode": "Verpleegkundige",
"beginDate": "2024-01-01",
"endDate": "2024-12-31"
}
},
"ons_administration.EmployeeHourlyWageModel": {
"required": [
"beginDate"
],
"type": "object",
"properties": {
"beginDate": {
"type": "string",
"description": "Begin date of the hourly wage",
"format": "date"
},
"employeeNumber": {
"type": "string",
"description": "User defined identifier for the employee, must be unique in combination with the employment number"
},
"employeeObjectId": {
"type": "integer",
"description": "Unique identifier for the employee used within the Ons suite as primary key",
"format": "int64"
},
"employmentNumber": {
"type": "string",
"description": "Employment number for the employee, must be unique in combination with the employee number"
},
"endDate": {
"type": "string",
"description": "End date of the hourly wage",
"format": "date"
},
"id": {
"type": "integer",
"description": "Unique identifier for the hourly wage used within the Ons suite as primary key",
"format": "int64"
},
"wageInCents": {
"minimum": 0,
"type": "integer",
"description": "The hourly wage in cents",
"format": "int32"
}
},
"description": "Hourly wage model for an employee. This model can be used on its own or as part of an extended employee model.\nWhen used on its own, either an employeeObjectId or employeeNumber must be provided. Note that the employeeNumber\nis not necessarily unique on its own, but might require an employmentNumber for uniqueness.\n\nMultiple hourly wages can be associated with an employee, but they cannot overlap in time.\n",
"example": {
"id": 12345,
"employeeObjectId": 6789,
"employeeNumber": "100042",
"employmentNumber": "1",
"wageInCents": 1500,
"beginDate": "2024-01-01",
"endDate": "2024-12-31"
}
},
"ons_administration.EmployeeRegistrationProfileModel": {
"required": [
"beginDate"
],
"type": "object",
"properties": {
"beginDate": {
"type": "string",
"description": "Start date of the registration profile assignment",
"format": "date"
},
"employeeNumber": {
"type": "string",
"description": "User defined identifier for the employee, must be unique in combination with the employment number"
},
"employeeObjectId": {
"type": "integer",
"description": "Unique identifier for the employee used within the Ons suite as primary key",
"format": "int64"
},
"employmentNumber": {
"type": "string",
"description": "Employment number for the employee, must be unique in combination with the employee number"
},
"endDate": {
"type": "string",
"description": "End date of the registration profile assignment",
"format": "date"
},
"id": {
"type": "integer",
"description": "Unique identifier for the expertise profile assignment used within the Ons suite as primary key",
"format": "int64"
},
"registrationProfileName": {
"type": "string",
"description": "User defined identifier for the registration profile. Either the registrationProfileObjectId or registrationProfileName must be provided"
},
"registrationProfileObjectId": {
"type": "integer",
"description": "Unique identifier for the registration profile used within the Ons suite as primary key. Either the registrationProfileObjectId or registrationProfileName must be provided",
"format": "int64"
}
},
"description": "Registration profile assignment model for an employee. This model can be used on its own or as part of an extended employee model.\nWhen used on its own, either an employeeObjectId or employeeNumber must be provided. Note that the employeeNumber\nis not necessarily unique on its own, but might require an employmentNumber for uniqueness.\n\n**IMPORTANT!**\nCurrently, the registration profile assignment is not time dependent within the Ons suite. This model has been added for when\nthis might change in the future. When providing this model, the specified profile will be assigned to the employee if the assignment\nis valid on the day of submitting the model, based on the provided begin and end dates.\n",
"example": {
"id": 12345,
"employeeObjectId": 6789,
"employeeNumber": "100042",
"employmentNumber": "1",
"registrationProfileObjectId": 16,
"registrationProfileName": "Verpleegkunde",
"beginDate": "2024-01-01",
"endDate": "2024-12-31"
}
},
"ons_administration.EmployeeTeamModel": {
"required": [
"beginDate"
],
"type": "object",
"properties": {
"beginDate": {
"type": "string",
"description": "Begin date of the team assignment",
"format": "date"
},
"employeeNumber": {
"type": "string",
"description": "User defined identifier for the employee, must be unique in combination with the employment number"
},
"employeeObjectId": {
"type": "integer",
"description": "Unique identifier for the employee used within the Ons suite as primary key",
"format": "int64"
},
"employmentNumber": {
"type": "string",
"description": "Employment number for the employee, must be unique in combination with the employee number"
},
"endDate": {
"type": "string",
"description": "End date of the team assignment",
"format": "date"
},
"id": {
"type": "integer",
"description": "Unique identifier for the team assignment used within the Ons suite as primary key",
"format": "int64"
},
"teamId": {
"type": "string",
"description": "User defined unique identifier for the team. Either the teamObjectId or teamId must be provided"
},
"teamObjectId": {
"type": "integer",
"description": "Unique identifier for the team used within the Ons suite as primary key. Either the teamObjectId or teamId must be provided",
"format": "int64"
}
},
"description": "Team assignment model for an employee. This model can be used on its own or as part of an extended employee model.\nWhen used on its own, either an employeeObjectId or employeeNumber must be provided. Note that the employeeNumber\nis not necessarily unique on its own, but might require an employmentNumber for uniqueness.\n\nMultiple team assignments can be associated with an employee, but they cannot overlap in time.\n",
"example": {
"id": 67890,
"employeeObjectId": 12345,
"employeeNumber": "100042",
"employmentNumber": "1",
"teamObjectId": 54321,
"teamId": "TEAM-A",
"beginDate": "2024-01-01",
"endDate": "2024-12-31"
}
},
"ons_administration.EmployeeWorkdayNormSettingsModel": {
"required": [
"beginDate"
],
"type": "object",
"properties": {
"beginDate": {
"type": "string",
"description": "The begin date of the period during which this setting is valid",
"format": "date"
},
"claDefault": {
"type": "boolean",
"description": "If true, these settings are the default from the collective labour agreement. When set during an UPSERT, this setting will be ignored",
"readOnly": true
},
"employeeNumber": {
"type": "string",
"description": "User defined identifier for the employee, must be unique in combination with the employment number"
},
"employeeObjectId": {
"type": "integer",
"description": "Unique identifier for the employee used within the Ons suite as primary key",
"format": "int64"
},
"employmentNumber": {
"type": "string",
"description": "Employment number for the employee, must be unique in combination with the employee number"
},
"endDate": {
"type": "string",
"description": "The end date of the period during which this setting is valid",
"format": "date"
},
"normPeriod": {
"type": "integer",
"description": "The measurement period in weeks to evaluate if the workday norm is exceeded. Required when optOut is false",
"format": "int32"
},
"id": {
"type": "integer",
"description": "Unique identifier for the workday norm settings used within the Ons suite as primary key",
"format": "int64"
},
"optOut": {
"type": "boolean",
"description": "If true, the employee is opted out of the workday norm"
},
"workdayNorm": {
"type": "integer",
"description": "The total number of workdays the employee has to work in the measurement period. Required when optOut is false",
"format": "int32"
}
},
"description": "Workday norm settings model. This model can be used on its own or as part of an extended employee model.\nThis model describes the maximum workdays a given employee has to work in total during a given measurement period.\nWhen used on its own, either an employeeObjectId or employeeNumber must be provided. Note that the employeeNumber\nis not necessarily unique on its own, but might require an employmentNumber for uniqueness.\n\nMultiple workday norms can be associated with an employee, but they cannot overlap in time.\n",
"example": {
"id": 12345,
"employeeObjectId": 6789,
"employeeNumber": "100042",
"employmentNumber": "1",
"beginDate": "2025-12-29",
"endDate": "2026-12-27",
"workdayNorm": 20,
"normPeriod": 4,
"optOut": false
}
},
"evs.ResponseMessage": {
"required": [
"uuid"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "UUID identifying this Evs response across applications",
"x-cupido-id": true
},
"originalMessageTag": {
"type": "string",
"description": "link to the orignal message where this response belongs to"
},
"status": {
"type": "string",
"description": "possible values:\nACKED: when the hl7 message was received correctly by the external EVS provider\nNACKED: when the hl7 was denied by the external EVS provider"
},
"externalMessage": {
"type": "string",
"description": "The textual message from the external EVS provider.\nIn case of status NACKED, this will given an indication of the reason why."
}
},
"description": "ResponseMessage model (no description)",
"example": {
"uuid": "Dummy",
"originalMessageTag": "OriginalDummy",
"status": "ACKED",
"externalMessage": "ok"
},
"xml": {
"name": "responseMessage"
}
},
"expense.Expense": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"expenseDate": {
"type": "string",
"description": "The date on which the expense was made (or booked)",
"format": "date"
},
"verifyDate": {
"type": "string",
"description": "The date on which the expense was verified (through an approval process)",
"format": "date"
},
"expenseTypeObjectId": {
"type": "integer",
"description": "Reference to the expense type that underlies the expense. This id is guaranteed not to change within an customer\nenvironment. There is no API object available.",
"format": "int64"
},
"employeeObjectId": {
"type": "integer",
"description": "Id of the employee to which the expense belongs.",
"format": "int64"
},
"amount": {
"type": "number",
"description": "The expense amount. This can kilometers, hours, or money.\n\nHOME\nOFFICE\n
"
},
"departureClusterObjectId": {
"type": "integer",
"format": "int64"
}
},
"description": "An expense is a value of some kind (determined) by its type, that an employee will be compensated for (usually via\nher payroll).\nnull.",
"nullable": true
},
"homeNumber": {
"type": "integer",
"description": "The home number of the position. Can be null.",
"format": "int32",
"nullable": true
},
"homeNumberExtension": {
"type": "string",
"description": "The possible extension the #homeNumber. Can be null.",
"nullable": true
},
"street": {
"type": "string",
"description": "The position's street name. Can be null",
"nullable": true
},
"zipCode": {
"type": "string",
"description": "Zipcode part of the position. Can be null",
"nullable": true
},
"country": {
"type": "string",
"description": "The two-letter country code. Examples are 'NL' and 'BE'."
},
"longitude": {
"type": "number",
"description": "Longitude part of the position.",
"format": "double",
"nullable": true
},
"latitude": {
"type": "number",
"description": "Latitude part of the position.",
"format": "double",
"nullable": true
},
"usedGoogleAddress": {
"type": "string"
}
},
"description": "A Position denotes a physical location on a map. This position can either consist of address information, a\nlongitude/latitude pair or both. Not all fields are guaranteed to be present.",
"example": {
"city": "Enschede",
"homeNumber": 5,
"homeNumberExtension": "",
"street": "Bomenlaan",
"zipCode": "6521YH",
"country": "NL",
"longitude": 52.665171,
"latitude": 5.215021,
"usedGoogleAddress": "Bovenlaan 5, 6521YH Enschede, Netherlands"
},
"xml": {
"name": "position"
}
},
"ExpertiseProfileAssignmentUpdateModel": {
"type": "object",
"properties": {
"expertiseProfileObjectId": {
"type": "integer",
"format": "int64"
},
"beginDate": {
"type": "string",
"format": "date-time"
}
},
"description": "Expertise profile assignment model for creating and modifying.",
"example": {
"expertiseProfileObjectId": 4,
"beginDate": "2012-08-02T13:48:46.836+02:00"
}
},
"finance.CareOrderProduct": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"careOrderId": {
"type": "integer",
"description": "ID of the care order this care order product belongs to.",
"format": "int64"
},
"userIdentifier": {
"type": "string"
},
"quantity": {
"type": "integer",
"description": "Deprecated since: 14-03-2019",
"format": "int32",
"deprecated": true
},
"quantityUnit": {
"type": "string",
"description": "Deprecated since: 14-03-2019",
"deprecated": true
},
"magnitudeQuantityValue": {
"type": "integer",
"description": "Care order products have a magnitude of the form: [quantityValue] of [unitQuantity] [unitType] per [frequency].\nFor example 30 * 1 minute per week. This value represents the quantityValue part and is mandatory.",
"format": "int32"
},
"magnitudeUnitQuantity": {
"type": "integer",
"description": "Care order products have a magnitude of the form: [quantityValue] of [unitQuantity] [unitType] per [frequency].\nFor example 30 * 1 minute per week. This value represents the unitQuantity part and it can be omitted.\nIn most cases this is 1.",
"format": "int32"
},
"magnitudeUnitType": {
"type": "string",
"description": "Care order products have a magnitude of the form: [quantityValue] of [unitQuantity] [unitType] per [frequency].\nFor example 30 * 1 minute per week. This value represents the unitType part and it can be omitted.\nThe following values are supported:\n - EURO_CENT\n - PIECE\n - MINUTE\n - HOUR"
},
"magnitudeFrequency": {
"type": "string",
"description": "Care order products have a magnitude of the form: [quantityValue] of [unitQuantity] [unitType] per [frequency].\nFor example 30 * 1 minute per week. This value represents the frequency part and it can be omitted.\nThe following values are supported:\n - PER_DAG\n - PER_WEEK\n - PER_VIER_WEKEN\n - PER_MAAND\n - PER_JAAR\n - PER_TRAJECT"
},
"comments": {
"type": "string",
"description": "Comments, generally only used by old pre-2015 AWBZ care order products."
},
"productId": {
"type": "integer",
"description": "ID of the product that this care order product is for",
"format": "int64"
},
"financeTypeId": {
"type": "integer",
"description": "ID of the finance type this care order product belongs to.",
"format": "int64"
},
"instellingsCode": {
"type": "string",
"description": "AGB code of the care provider responsible for handling this care order product"
},
"functietype": {
"type": "string",
"description": "Deprecated: field was never set.",
"deprecated": true,
"x-deprecated-since": "14-10-2021"
},
"debtorId": {
"type": "integer",
"description": "ID of the debtor that this care order product belongs to.",
"format": "int64"
},
"beginDate": {
"type": "string",
"description": "Original begin date of the care order product, the time component is ignored, and considered to be 00:00:00.",
"format": "date-time"
},
"endDate": {
"type": "string",
"description": "Original end date of the care order product, the time component is ignored, and considered to be 23:59:59.",
"format": "date-time"
},
"clippedBeginDate": {
"type": "string",
"description": "Begin date of the care order product after clipping (vegen), the time component is ignored, and considered to be 00:00:00.",
"format": "date-time"
},
"clippedEndDate": {
"type": "string",
"description": "End date of the care order product after clipping (vegen), the time component is ignored, and considered to be 23:59:59.",
"format": "date-time"
}
},
"description": "CareOrderProduct model (no description)",
"example": {
"id": 1,
"careOrderId": 1,
"userIdentifier": "1",
"quantity": 1,
"quantityUnit": "MinutesPerWeek",
"magnitudeQuantityValue": 1,
"magnitudeUnitQuantity": 1,
"magnitudeUnitType": "MINUTE",
"magnitudeFrequency": "PER_WEEK",
"comments": "comments",
"productId": 1,
"financeTypeId": 1,
"instellingsCode": "ABCD",
"functietype": "ZZP",
"debtorId": 1,
"beginDate": "2014-12-29T00:00:00.000+01:00",
"endDate": "2014-12-29T00:00:00.000+01:00",
"clippedBeginDate": "2014-12-29T00:00:00.000+01:00",
"clippedEndDate": "2014-12-29T00:00:00.000+01:00"
},
"xml": {
"name": "careOrderProduct"
}
},
"finance.CareOrder": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"userIdentifier": {
"type": "string",
"description": "Identification number of this care order, provided by the user, or in some cases derived from the lawIdentification."
},
"clientIdentifier": {
"type": "string",
"description": "Legal identifier of the client this care order belongs to. This is not necessarily the same as the client number of the client."
},
"beschikkingsNummer": {
"type": "string",
"description": "Deprecated since: 23-07-2021 use lawIdentification instead",
"deprecated": true
},
"lawIdentification": {
"type": "string",
"description": "Identification number of this care order, provided by the authority that issued this care order."
},
"indicatieorgaanCode": {
"type": "string",
"description": "Code of the indicatieorgaan that issued this care order, only used by old pre-2015 AWBZ care orders."
},
"aanvraagNummer": {
"type": "string",
"description": "Request number for the care order (if applicable)."
},
"issueDate": {
"type": "string",
"description": "Date and time this care order was issued. In particular important for the clipping (veeg) mechanism.",
"format": "date-time"
},
"contactPerson": {
"type": "string",
"description": "Contact person, only used by old pre-2015 AWBZ care orders."
},
"comments": {
"type": "string",
"description": "Comments, generally only used by old pre-2015 AWBZ care orders."
},
"beginDate": {
"type": "string",
"description": "Begin date of the care order, the time component is ignored, and considered to be 00:00:00.",
"format": "date-time"
},
"endDate": {
"type": "string",
"description": "End date of the care order, the time component is ignored, and considered to be 23:59:59.",
"format": "date-time"
},
"clientId": {
"type": "integer",
"description": "ID of the client this care order belongs to.",
"format": "int64"
},
"financeTypeId": {
"type": "integer",
"description": "ID of the finance type this care order belongs to.",
"format": "int64"
},
"debtorId": {
"type": "integer",
"description": "ID of the debtor that this care order belongs to.",
"format": "int64"
},
"careOrderProducts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/finance.CareOrderProduct"
},
"xml": {
"wrapped": true
}
}
},
"description": "CareOrder model (no description)",
"example": {
"id": 1,
"userIdentifier": "Dummy",
"clientIdentifier": "Dummy",
"beschikkingsNummer": "Dummy",
"lawIdentification": "Dummy",
"indicatieorgaanCode": "Dummy",
"aanvraagNummer": "Dummy",
"issueDate": "2014-12-29T00:00:00.000+01:00",
"contactPerson": "Dummy",
"comments": "Dummy",
"beginDate": "2014-12-29T00:00:00.000+01:00",
"endDate": "2014-12-29T00:00:00.000+01:00",
"clientId": 1,
"financeTypeId": 1,
"debtorId": 1,
"careOrderProducts": [
{
"id": 2,
"careOrderId": 1,
"userIdentifier": "1",
"quantity": 1,
"quantityUnit": "MinutesPerWeek",
"magnitudeQuantityValue": 1,
"magnitudeUnitQuantity": 1,
"magnitudeUnitType": "MINUTE",
"magnitudeFrequency": "PER_WEEK",
"comments": "comments",
"productId": 1,
"financeTypeId": 1,
"instellingsCode": "ABCD",
"functietype": "ZZP",
"debtorId": 1,
"beginDate": "2014-12-29T00:00:00.000+01:00",
"endDate": "2014-12-29T00:00:00.000+01:00",
"clippedBeginDate": "2014-12-29T00:00:00.000+01:00",
"clippedEndDate": "2014-12-29T00:00:00.000+01:00"
}
]
},
"xml": {
"name": "careOrder"
}
},
"finance.DeclarationRule": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "the id of this object",
"format": "int64",
"x-cupido-id": true
},
"clientObjectId": {
"type": "integer",
"description": "the Id of the Client pertaining to this DeclarationRule",
"format": "int64"
},
"beginDate": {
"type": "string",
"description": "the begindate of this DeclarationRule; INCLUSIVE",
"format": "date"
},
"endDate": {
"type": "string",
"description": "the enddate of this DeclarationRule; INCLUSIVE",
"format": "date"
},
"createdAt": {
"type": "string",
"description": "the date when this Rule was created",
"format": "date"
},
"updatedAt": {
"type": "string",
"description": "the last time this DeclarationRule was updated",
"format": "date"
},
"tariff": {
"type": "integer",
"description": "the tariff for this DeclarationRule, in cents",
"format": "int32"
},
"priority": {
"type": "integer",
"description": "this rule's priority",
"format": "int32"
},
"employeeObjectId": {
"type": "integer",
"description": "the objectId of the {@link com.nedap.healthcare.domain.Employee} pertaining to this DeclarationRule",
"format": "int64"
},
"productObjectId": {
"type": "integer",
"description": "the objectId of the {@link Product} pertaining to this DeclarationRule",
"format": "int64"
},
"indicatieBesluitObjectId": {
"type": "integer",
"description": "the objectId of the {@link CareOrder} pertaining to this DeclarationRule",
"format": "int64"
},
"source": {
"type": "string",
"description": "this Rule's source ('automatic' or 'manual')"
},
"instellingscode": {
"type": "string",
"description": "the agbCode of the instelling"
},
"zorgkantoorcode": {
"type": "string",
"description": "the UZOVI code of the zorgkantoor"
},
"weekday1": {
"type": "integer",
"description": "amount for weekday 1",
"format": "int32"
},
"weekday2": {
"type": "integer",
"description": "amount for weekday 2",
"format": "int32"
},
"weekday3": {
"type": "integer",
"description": "amount for weekday 3",
"format": "int32"
},
"weekday4": {
"type": "integer",
"description": "amount for weekday 4",
"format": "int32"
},
"weekday5": {
"type": "integer",
"description": "amount for weekday 5",
"format": "int32"
},
"weekday6": {
"type": "integer",
"description": "amount for weekday 6",
"format": "int32"
},
"weekday7": {
"type": "integer",
"description": "amount for weekday 7",
"format": "int32"
},
"declareOnResidence": {
"type": "boolean",
"description": "Declare only when client resides on a location\nwhen null it will auto set true if the product is a residence-product else false"
},
"zzpType": {
"type": "string",
"description": "zzptype ('zzp declaration') or 'zzp as functions declaration')"
},
"type": {
"type": "integer",
"description": "type",
"format": "int32"
},
"careOrderProductObjectId": {
"type": "integer",
"description": "the objectId of the {@link CareOrderProduct} pertaining to this DeclarationRule",
"format": "int64"
},
"clientScheduleObjectId": {
"type": "integer",
"description": "the objectId of the ClientSchedule pertaining to this DeclarationRule",
"format": "int64"
},
"amount": {
"type": "integer",
"description": "the amount of units of this DeclarationRule",
"format": "int32"
},
"costTeamObjectId": {
"type": "integer",
"description": "the objectId of the Team to be used as the cost center for this DeclarationRule. Only one of costTeamObjectId or costLocationObjectId can be filled.",
"format": "int64"
},
"costLocationObjectId": {
"type": "integer",
"description": "the objectId of the Location to be used as the cost center for this DeclarationRule. Only one of costTeamObjectId or costLocationObjectId can be filled.",
"format": "int64"
},
"declarablePeriods": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/Period"
}
],
"xml": {
"name": "period"
}
},
"description": "the periods that are declarable for this DeclarationRule. One DeclarationRule can have multiple periods, because they can be split by absences for example.\nthis list is calculated on-the-fly and not persisted in a database. Therefore this is not taken into account when POSTing this a DeclarationRule.",
"xml": {
"wrapped": true
}
}
},
"description": "Declaration Rule retrieved from OnsAdmin.",
"example": {
"id": 1,
"clientObjectId": 1,
"beginDate": "2017-06-06",
"endDate": "2017-06-06",
"createdAt": "2017-06-06",
"updatedAt": "2017-06-06",
"tariff": 1,
"priority": 1,
"employeeObjectId": 1,
"productObjectId": 1,
"indicatieBesluitObjectId": 1,
"source": "manual",
"instellingscode": "42420993",
"zorgkantoorcode": "5521",
"weekday1": 1,
"weekday2": 1,
"weekday3": 1,
"weekday4": 1,
"weekday5": 1,
"weekday6": 1,
"weekday7": 1,
"declareOnResidence": true,
"zzpType": "zzp declaration",
"type": 1,
"careOrderProductObjectId": 1,
"clientScheduleObjectId": 1,
"amount": 1,
"costTeamObjectId": 1,
"costLocationObjectId": 1,
"declarablePeriods": [
{
"start": "2017-06-06",
"end": "2017-06-06"
}
]
},
"xml": {
"name": "declarationRule"
}
},
"Period": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "Starting time with inclusive boundary",
"format": "date"
},
"end": {
"type": "string",
"description": "End time with inclusive boundary, if not ongoing",
"format": "date"
}
},
"description": "Based on http://hl7.org/fhir/STU3/datatypes.html#period",
"example": {
"start": "2018-03-26",
"end": "2018-04-02"
}
},
"finance.ForensicCareOrder": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Object identifier",
"format": "int64",
"x-cupido-id": true
},
"clientObjectId": {
"type": "integer",
"description": "The object identifier of the Client",
"format": "int64"
},
"careOrderObjectId": {
"type": "integer",
"description": "The object identifier of the CareOrder",
"format": "int64"
},
"plaatsingsbesluitnummer": {
"type": "string",
"description": "9 digit number"
},
"forensischeZorgtitel": {
"type": "string",
"description": "Codelijst https://www.vektis.nl/streams/standaardisatie/codelijsten/COD706-MVJ"
},
"strafrechtketennummer": {
"type": "string",
"description": "7 or 8 digits"
},
"beginDate": {
"type": "string",
"description": "Begin date",
"format": "date"
},
"endDate": {
"type": "string",
"description": "End date. May be null if the forensic care order has not been 'closed'",
"format": "date"
},
"type": {
"type": "string",
"description": "Empty or 'DBBC'\nDeprecated since 18-02-2020, ForensicCareOrder no longer contains dbbc records, retrieve this data directly from ons-dbc",
"deprecated": true
}
},
"description": "ForensicCareOrder model (no description)",
"example": {
"id": 123,
"clientObjectId": 333,
"careOrderObjectId": 666,
"plaatsingsbesluitnummer": "999999999",
"forensischeZorgtitel": "151",
"strafrechtketennummer": "9999999",
"beginDate": "2019-01-01",
"endDate": "2019-01-01",
"type": "DBBC"
},
"xml": {
"name": "forensicCareOrder"
}
},
"Insurance": {
"required": [
"clientObjectId",
"debtorObjectId",
"sourceType",
"insuranceType",
"comments",
"beginDate"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"registrationNumber": {
"type": "string",
"description": "Registration number, required if sourceType is other than SYSTEM."
},
"clientObjectId": {
"type": "integer",
"description": "Client objectId.",
"format": "int64"
},
"debtorObjectId": {
"type": "integer",
"description": "Debtor objectId.",
"format": "int64"
},
"insurer": {
"allOf": [
{
"$ref": "#/components/schemas/Debtor"
}
],
"description": "insurer."
},
"sourceType": {
"type": "integer",
"description": "Source type. Possible values:\n\n0 (System defined)\n1 (Manual)\n2 (Third parties)\n3 (Vecozo)\n4 (XML import)\n
",
"format": "int32"
},
"insuranceType": {
"allOf": [
{
"$ref": "#/components/schemas/InsuranceType"
}
],
"description": "Insurance type. Possible values:\n\nBV (Basis Verzekering)\nAV (Aanvullende Verzekering)\nTV (Tand Verzekering)\nHV (Hoofd Verzekering)\n
"
},
"packageCode": {
"type": "string",
"description": "Package code, required if sourceType is VECOZO."
},
"packageName": {
"type": "string",
"description": "Package name, required if sourceType is VECOZO."
},
"labelCode": {
"type": "string",
"description": "Label code, must be a label of debtor. Required if sourceType is VECOZO."
},
"labelName": {
"type": "string",
"description": "Label name, must be a label of debtor. Required if sourceType is VECOZO."
},
"requestedDate": {
"type": "string",
"description": "Requested date, required if sourceType is VECOZO.",
"format": "date"
},
"clientIsDead": {
"type": "boolean",
"description": "Indicates client is deceased."
},
"comments": {
"type": "string",
"description": "Comments.",
"default": ""
},
"beginDate": {
"type": "string",
"description": "Begin date.",
"format": "date-time"
},
"endDate": {
"type": "string",
"description": "End date.",
"format": "date-time"
},
"careProviderObjectId": {
"type": "integer",
"description": "Care provider objectId.",
"format": "int64"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"description": "Insurance entry for a Client.",
"example": {
"id": 1,
"registrationNumber": "1",
"clientObjectId": 1234,
"debtorObjectId": 4321,
"sourceType": 1,
"insuranceType": "AV",
"packageCode": "001T0",
"packageName": "Top geen Tandarts",
"labelCode": "001",
"labelName": "Salland Zorgverzekeringen",
"requestedDate": "2012-08-02",
"clientIsDead": false,
"comments": "comments",
"beginDate": "2014-08-02T11:48:46.836+02:00",
"endDate": "2015-08-02T11:48:46.836+02:00",
"careProviderObjectId": 5678,
"createdAt": "2012-08-02T11:48:46.836+02:00",
"updatedAt": "2012-08-02T11:48:46.836+02:00"
},
"xml": {
"name": "insurance"
}
},
"Debtor": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"type": {
"type": "string",
"description": "Possible values:\nORGANISATIE(0, \"Organisatie\")\nASIELZOEKERSCENTRUM(1, \"Asielzoekerscentrum\")\nZORGKANTOOR(2, \"Zorgkantoor\")\nZORGVERZEKERAAR(3, \"Verzekeraar\")\nGEMEENTE(4, \"Gemeente\")\nONDERAANNEMER(5, \"Onderaannemer\")\nCLIENT(6, \"Cliënt\")\nCLIENT_EN_ZORGVERZEKERAAR(7, \"Cliënt en verzekeraar\")"
},
"uzoviCode": {
"type": "string"
},
"beginDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
},
"phone1": {
"type": "string"
},
"phone2": {
"type": "string"
},
"phone3": {
"type": "string"
},
"fax": {
"type": "string"
},
"email": {
"type": "string"
},
"gender": {
"type": "string"
},
"debtorNumber": {
"type": "string"
},
"organizationName": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"lastNameOwn": {
"type": "string"
},
"streetName": {
"type": "string"
},
"addressNumber": {
"type": "integer",
"format": "int32"
},
"addressNumberExt": {
"type": "string"
},
"poBoxNumber": {
"type": "string"
},
"zipCode": {
"type": "string"
},
"city": {
"type": "string"
},
"sourceType": {
"type": "string"
},
"clientObjectId": {
"type": "integer",
"format": "int64"
},
"bankAccount": {
"$ref": "#/components/schemas/BankAccount"
},
"paymentMethod": {
"type": "string",
"description": "Possible values:\nCASH,\nBANK,\nGIRO,\nCOLLECT,\nACCEPTGIRO,\nCHEQUES,\nBACS,\nREMITTANCE,\nBILLOFEXCHANGE,\nBILLOFEXCHANGEBANK"
},
"closedAt": {
"type": "string",
"format": "date-time"
},
"hidden": {
"type": "boolean"
},
"invoicePerEmail": {
"type": "boolean"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"insurances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insurance"
},
"xml": {
"wrapped": true
}
},
"gemeentecode": {
"type": "string"
},
"externalCode": {
"type": "string"
},
"manualInvoiceRetourHandling": {
"type": "boolean"
},
"waitForReturnMessage": {
"type": "boolean"
},
"usePreviousInsuranceForMutationDaysAfterClientDied": {
"type": "boolean"
},
"invoiceHeaderExportPeriod": {
"type": "string"
},
"uuid": {
"type": "string"
},
"zvwSplitOnCareOrderStartDate": {
"type": "string",
"format": "date-time"
},
"splitReistoeslagGzsp": {
"type": "boolean"
},
"splitIntegralProductsInSeparatePrestaties": {
"type": "boolean"
},
"practitionerAgbTravelGzspStartDate": {
"type": "string",
"format": "date-time"
},
"systemDefined": {
"type": "boolean"
},
"creditOnToewijzingnummerChangeStartDate": {
"type": "string",
"format": "date-time"
}
},
"description": "Debtor entry returned from Cupido.",
"example": {
"id": 1,
"type": "2",
"uzoviCode": "3",
"beginDate": "2012-08-02T11:48:46.836+02:00",
"endDate": "2012-08-02T11:48:46.836+02:00",
"phone1": "4",
"phone2": "5",
"phone3": "6",
"fax": "7",
"email": "8",
"gender": "9",
"debtorNumber": "10",
"organizationName": "11",
"firstName": "12",
"lastName": "13",
"lastNameOwn": "13",
"streetName": "14",
"addressNumber": 15,
"addressNumberExt": "16",
"poBoxNumber": "1234",
"zipCode": "17",
"city": "18",
"sourceType": "19",
"clientObjectId": 20,
"bankAccount": {
"id": 1,
"number": "NL27TRIO0207182531",
"nameOfOwner": "Pietje Puk",
"cityOfOwner": "Lutjebroek"
},
"paymentMethod": "26",
"closedAt": "2012-08-02T11:48:46.836+02:00",
"hidden": true,
"invoicePerEmail": false,
"updatedAt": "2016-01-01T12:00:00.000+01:00",
"createdAt": "2016-01-01T12:00:00.000+01:00",
"insurances": [
{
"id": 1,
"registrationNumber": "1",
"clientObjectId": 1234,
"debtorObjectId": 4321,
"sourceType": 1,
"insuranceType": "AV",
"packageCode": "001T0",
"packageName": "Top geen Tandarts",
"labelCode": "001",
"labelName": "Salland Zorgverzekeringen",
"requestedDate": "2012-08-02",
"clientIsDead": false,
"comments": "comments",
"beginDate": "2014-08-02T11:48:46.836+02:00",
"endDate": "2015-08-02T11:48:46.836+02:00",
"createdAt": "2012-08-02T11:48:46.836+02:00",
"updatedAt": "2012-08-02T11:48:46.836+02:00"
}
],
"gemeentecode": "0153",
"externalCode": "1111",
"manualInvoiceRetourHandling": true,
"waitForReturnMessage": true,
"usePreviousInsuranceForMutationDaysAfterClientDied": true,
"invoiceHeaderExportPeriod": "Use the entire exported period.",
"uuid": "d9a856df-8f9a-49a7-90f0-0570a2bde4c0",
"zvwSplitOnCareOrderStartDate": "2015-08-02T11:48:46.836+02:00",
"splitReistoeslagGzsp": true,
"splitIntegralProductsInSeparatePrestaties": true,
"practitionerAgbTravelGzspStartDate": "2015-08-02T11:48:46.836+02:00",
"systemDefined": true,
"creditOnToewijzingnummerChangeStartDate": "2015-08-02T11:48:46.836+02:00"
},
"xml": {
"name": "debtor"
}
},
"BankAccount": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"number": {
"type": "string"
},
"nameOfOwner": {
"type": "string"
},
"cityOfOwner": {
"type": "string"
},
"iban": {
"type": "string"
},
"bic": {
"type": "string"
},
"creditBankAccount": {
"type": "boolean"
},
"authorizationDate": {
"type": "string",
"format": "date"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"description": "BankAccount model (no description)",
"example": {
"id": 1,
"number": "Dummy",
"nameOfOwner": "Dummy",
"cityOfOwner": "Dummy",
"iban": "Dummy",
"bic": "Dummy",
"creditBankAccount": false,
"authorizationDate": "2016-01-01",
"createdAt": "2016-01-01T12:00:00.000+01:00",
"updatedAt": "2016-01-01T12:00:00.000+01:00"
},
"xml": {
"name": "bankAccount"
}
},
"InsuranceType": {
"enum": [
"BV",
"AV",
"TV",
"HV"
],
"type": "string",
"description": "Insurance type. Possible values:\n\nBV (Basis Verzekering)\nAV (Aanvullende Verzekering)\nTV (Tand Verzekering)\nHV (Hoofd Verzekering)\n
",
"example": "BV"
},
"jw.JwZorglegitimatie": {
"required": [
"id",
"client",
"berichten"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The id for the import",
"format": "int64",
"x-cupido-id": true
},
"client": {
"type": "integer",
"description": "The client",
"format": "int64"
},
"berichten": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/lz.Bericht"
}
],
"xml": {
"name": "bericht"
}
},
"description": "A list with messages",
"xml": {
"wrapped": true
}
}
},
"description": "JwZorglegitimatie model (no description)",
"example": {
"id": 1,
"client": 1,
"berichten": [
{
"content": "test"
}
]
},
"xml": {
"name": "jwZorglegitimatie"
}
},
"lz.Bericht": {
"required": [
"content"
],
"type": "object",
"properties": {
"content": {
"type": "string",
"description": "The content of the messages, surrounded with CDATA tags.\nThe content needs to be a valid AW33 / AW35 or AW39 message."
}
},
"description": "Bericht model (no description)",
"example": {
"content": "Dummy"
},
"xml": {
"name": "bericht"
}
},
"LocationAssignmentResidence": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/LocationAssignment"
}
],
"properties": {
"careOrderObjectId": {
"type": "integer",
"description": "The careorder where this locationassignment belongs to.\nThis is needed to be able to create a declaration based on locationassignments",
"format": "int64"
},
"hourTypeObjectId": {
"type": "integer",
"description": "The kind of care that is given using this locationassignment. Example: GGZ verblijf licht\nThis is needed to be able to create a declaration based on locationassignments",
"format": "int64"
},
"productObjectId": {
"type": "integer",
"description": "Deprecated since: 14-03-2019 - use hourTypeObjectId instead.",
"format": "int64",
"deprecated": true
}
},
"description": "LocationAssignmentResidence model (no description)",
"example": {
"id": 1,
"beginDate": "2012-08-02",
"beginTime": "10:11:00.000",
"endDate": "2012-08-02",
"endTime": "12:13:00.000",
"clientObjectId": 1,
"locationObjectId": 1,
"moveDate": "2012-08-02",
"locationAssignmentType": "MAIN",
"residence": false,
"mainLocation": true,
"medicineLocation": true,
"careOrderObjectId": 1,
"hourTypeObjectId": 1,
"productObjectId": 1
},
"xml": {
"name": "locationAssignmentResidence"
}
},
"LocationAssignment": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"beginDate": {
"type": "string",
"format": "date"
},
"beginTime": {
"type": "string",
"format": "time"
},
"endDate": {
"type": "string",
"format": "date"
},
"endTime": {
"type": "string",
"format": "time"
},
"clientObjectId": {
"type": "integer",
"format": "int64"
},
"locationObjectId": {
"type": "integer",
"format": "int64"
},
"moveDate": {
"type": "string",
"format": "date"
},
"locationAssignmentType": {
"$ref": "#/components/schemas/LocationAssignmentType"
},
"residence": {
"type": "boolean",
"description": "Indicates if the client resides at this location"
},
"mainLocation": {
"type": "boolean",
"description": "Deprecated since: 14-03-2019 - use locationAssignmentType instead",
"deprecated": true
},
"medicineLocation": {
"type": "boolean",
"description": "Deprecated since: 14-03-2019 - use locationAssignmentType instead",
"deprecated": true
}
},
"description": "LocationAssignment model (no description)",
"example": {
"id": 1,
"beginDate": "2012-08-02",
"beginTime": "10:11:00.000",
"endDate": "2012-08-02",
"endTime": "12:13:00.000",
"clientObjectId": 2,
"locationObjectId": 3,
"moveDate": "2012-08-02",
"locationAssignmentType": "MAIN",
"residence": false,
"mainLocation": true,
"medicineLocation": false
},
"xml": {
"name": "locationAssignment"
}
},
"LocationAssignmentType": {
"enum": [
"STANDARD",
"MAIN",
"MEDICINE",
"GGZ",
"WAITING_LIST"
],
"type": "string",
"description": "LocationAssignmentType enum (no description)",
"example": "STANDARD"
},
"LocationAssignmentWaitingList": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/LocationAssignment"
}
],
"properties": {
"waitingFor": {
"type": "string",
"description": "Description field for what event/resources the client is waiting for.\nPossible values are defined by the care organisation"
},
"status": {
"type": "string",
"description": "Wachtstatus (urgentie)\nPossible values are defined by the care organisation"
},
"description": {
"type": "string",
"description": "Description\nPossible values are defined by the care organisation"
},
"classification": {
"type": "string",
"description": "optional field used for financetype 'WLZ'.\nhttps://assets.zn.nl/p/32768/none/Langdurige%20zorg/Wachtlijsten%20langdurige%20zorg/ZN-Infographic.pdf"
},
"closingReason": {
"type": "string",
"description": "Indication of under what circumstances the client is taken off the waiting list\nAssumed use: BI tooling\nPossible values are defined by the care organisation"
}
},
"description": "Developed as a (temporary) solution to enable (GGZ) customers to indicate a client is on a 'waiting list'",
"example": {
"id": 1,
"beginDate": "2012-08-02",
"beginTime": "10:11:00.000",
"endDate": "2012-08-02",
"endTime": "12:13:00.000",
"clientObjectId": 2,
"locationObjectId": 3,
"moveDate": "2012-08-02",
"locationAssignmentType": "WAITING_LIST",
"residence": false,
"mainLocation": false,
"medicineLocation": false,
"waitingFor": "BESCHIKBARE_PLEK",
"status": "ACTIEF_PLAATSEN",
"description": "Client wacht met smart. Contact direct met client, niet via ouders.",
"classification": "DREIGENDE_CRISIS_THUIS",
"closingReason": "GEPLAATST"
},
"xml": {
"name": "locationAssignmentWaitingList"
}
},
"Location": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"beginDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
},
"identificationNo": {
"type": "string"
},
"name": {
"type": "string"
},
"agbCode": {
"type": "string",
"description": "Deprecated since: 14-03-2019 - nationally issued unique identifying code for organisations and persons that have a registration in the agb register",
"deprecated": true
},
"agbcodeId": {
"type": "integer",
"format": "int64"
},
"materializedPath": {
"type": "string",
"description": "automatically calculated field"
},
"wzaCode": {
"type": "string",
"description": "unique identifying code. Used by municipalities"
},
"intramuralLocation": {
"type": "boolean"
},
"locationType": {
"type": "string"
},
"capacity": {
"type": "integer",
"format": "int32",
"default": 0
},
"costCenter": {
"type": "string"
},
"roomType": {
"type": "string"
},
"parentObjectId": {
"type": "integer",
"description": "location objectid of the parent where this location belongs to",
"format": "int64"
},
"icon": {
"type": "integer",
"format": "int32",
"default": 0
},
"medicineAllowed": {
"type": "boolean",
"description": "Indication whether this location can be used as a medication location"
},
"ggzAllowed": {
"type": "boolean",
"description": "Indication whether this location can be used as a mental healthcare residence location"
},
"waitingListAllowed": {
"type": "boolean",
"description": "Indication whether this location can be used as a waiting list"
},
"registeredLocationNumber": {
"type": "string",
"description": "The location as registered for Wzd / Wvggz purposes"
},
"correspondenceName": {
"type": "string",
"description": "Correspondence name for use in mail correspondence when location name is not fit for mail correspondence (e.g. 'K PS fys 03'). Default correspondence name is the location name, unless set otherwise"
},
"hideCorrespondenceName": {
"type": "boolean",
"description": "Whether the correspondence name should be hidden"
},
"addressObjectId": {
"type": "integer",
"format": "int64"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"description": "Location model (no description)",
"example": {
"id": 1,
"beginDate": "2012-08-02T11:48:46.836+02:00",
"endDate": "2012-08-02T11:48:46.836+02:00",
"identificationNo": "1",
"name": "Nedap Demo",
"agbCode": "75750535",
"agbcodeId": 1,
"materializedPath": "1.2",
"wzaCode": "690535",
"intramuralLocation": false,
"locationType": "Locatie",
"capacity": 0,
"costCenter": "costCenter",
"roomType": "1",
"parentObjectId": 0,
"medicineAllowed": true,
"ggzAllowed": true,
"waitingListAllowed": true,
"addressObjectId": 1,
"registeredLocationNumber": "123456789012",
"updatedAt": "2012-08-02T11:48:46.836+02:00",
"createdAt": "2012-08-02T11:48:46.836+02:00",
"icon": 1,
"correspondenceName": "Pretty correspondence name",
"hideCorrespondenceName": false
},
"xml": {
"name": "location"
}
},
"dossier.omaha.OmahaClassification": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "string",
"x-cupido-id": true
},
"clientId": {
"type": "integer",
"description": "Object id of the related client",
"format": "int64"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.omaha.ClassificationStatus"
}
],
"description": "Status of this omaha classification"
},
"beginDate": {
"type": "string",
"format": "date"
},
"endDate": {
"type": "string",
"format": "date"
},
"careplanId": {
"type": "integer",
"description": "Object id of the related careplan\n(nl) Object id van het gerelateerde zorgplan",
"format": "int64"
},
"surveyResultId": {
"type": "integer",
"description": "Object id of the related survey\n(nl) Object id van de gerelateerde vragenlijst",
"format": "int64"
},
"omahaClassifiedProblems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.omaha.ClassifiedProblem"
},
"description": "(nl) Gerelateerde Omaha 'gebieden'",
"xml": {
"wrapped": true
}
},
"viewAllowed": {
"type": "boolean",
"description": "Used for rights"
},
"editAllowed": {
"type": "boolean",
"description": "Used for rights"
},
"copyAllowed": {
"type": "boolean",
"description": "Used for rights"
},
"changeStatusAllowed": {
"type": "boolean",
"description": "Used for rights"
},
"printAllowed": {
"type": "boolean",
"description": "Used for rights"
},
"quantifyAllowed": {
"type": "boolean",
"description": "Used for rights"
},
"intakeQuestions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/survey.AnsweredQuestion"
},
"description": "(nl) Aanleiding",
"xml": {
"wrapped": true
}
}
},
"description": "represents a full Omaha classification for one client, including both problem and intervention classification",
"example": {
"updatedAt": "2014-04-01T17:00:00.000+02:00",
"createdAt": "2013-12-01T17:00:00.000+01:00",
"createdBy": "user",
"id": "care_plan:23",
"clientId": 300,
"status": "DRAFT",
"beginDate": "2015-01-01",
"endDate": "2016-12-31",
"careplanId": 23,
"surveyResultId": 500,
"omahaClassifiedProblems": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": "example",
"omahaClassificationId": "example",
"clientId": 1,
"ratingKnowledgeStart": 1,
"ratingBehaviorStart": 1,
"ratingStatusSignalsStart": 1,
"ratingKnowledgeTarget": 1,
"ratingBehaviorTarget": 1,
"ratingStatusSignalsTarget": 1,
"modifierReach": "Individual",
"modifierProblemLevel": "HealthPromotion",
"additionalInfo": "example",
"omahaProblem": {
"classificationId": "example",
"name": "example",
"omahaDomain": {
"classificationId": "example",
"name": "example"
},
"omahaSignsAndSymptoms": [
{
"classificationId": "example",
"name": "example",
"problemId": "example",
"textAllowed": true
},
{
"classificationId": "example",
"name": "example",
"problemId": "example",
"textAllowed": true
}
]
},
"omahaClassifiedSignsAndSymptoms": [
{
"text": "example",
"omahaSignOrSymptom": {
"classificationId": "example",
"name": "example",
"problemId": "example",
"textAllowed": true
}
},
{
"text": "example",
"omahaSignOrSymptom": {
"classificationId": "example",
"name": "example",
"problemId": "example",
"textAllowed": true
}
}
],
"omahaClassifiedInterventions": [
{
"id": 1,
"omahaInterventionCategory": {
"classificationId": "example",
"name": "example"
},
"omahaInterventionTarget": {
"classificationId": "example",
"name": "example"
},
"specification": "example",
"carePlanEntryId": 1,
"actionEntryId": 1
},
{
"id": 1,
"omahaInterventionCategory": {
"classificationId": "example",
"name": "example"
},
"omahaInterventionTarget": {
"classificationId": "example",
"name": "example"
},
"specification": "example",
"carePlanEntryId": 1,
"actionEntryId": 1
}
]
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": "example",
"omahaClassificationId": "example",
"clientId": 1,
"ratingKnowledgeStart": 1,
"ratingBehaviorStart": 1,
"ratingStatusSignalsStart": 1,
"ratingKnowledgeTarget": 1,
"ratingBehaviorTarget": 1,
"ratingStatusSignalsTarget": 1,
"modifierReach": "Individual",
"modifierProblemLevel": "HealthPromotion",
"additionalInfo": "example",
"omahaProblem": {
"classificationId": "example",
"name": "example",
"omahaDomain": {
"classificationId": "example",
"name": "example"
},
"omahaSignsAndSymptoms": [
{
"classificationId": "example",
"name": "example",
"problemId": "example",
"textAllowed": true
},
{
"classificationId": "example",
"name": "example",
"problemId": "example",
"textAllowed": true
}
]
},
"omahaClassifiedSignsAndSymptoms": [
{
"text": "example",
"omahaSignOrSymptom": {
"classificationId": "example",
"name": "example",
"problemId": "example",
"textAllowed": true
}
},
{
"text": "example",
"omahaSignOrSymptom": {
"classificationId": "example",
"name": "example",
"problemId": "example",
"textAllowed": true
}
}
],
"omahaClassifiedInterventions": [
{
"id": 1,
"omahaInterventionCategory": {
"classificationId": "example",
"name": "example"
},
"omahaInterventionTarget": {
"classificationId": "example",
"name": "example"
},
"specification": "example",
"carePlanEntryId": 1,
"actionEntryId": 1
},
{
"id": 1,
"omahaInterventionCategory": {
"classificationId": "example",
"name": "example"
},
"omahaInterventionTarget": {
"classificationId": "example",
"name": "example"
},
"specification": "example",
"carePlanEntryId": 1,
"actionEntryId": 1
}
]
}
],
"viewAllowed": true,
"editAllowed": false,
"copyAllowed": true,
"changeStatusAllowed": false,
"printAllowed": true,
"quantifyAllowed": true,
"intakeQuestions": [
{
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example",
"answerDefinitionGroup": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"description": "example",
"readOnly": true,
"answerDefinitions": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"definition": "example",
"sequenceNumber": 1,
"hasInput": true,
"active": true,
"score": 1,
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
],
"classificationId": "example",
"answerDefinitionGroupId": 1
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"definition": "example",
"sequenceNumber": 1,
"hasInput": true,
"active": true,
"score": 1,
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
],
"classificationId": "example",
"answerDefinitionGroupId": 1
}
],
"questions": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example"
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example"
}
],
"classificationId": "example"
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
]
},
{
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example",
"answerDefinitionGroup": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"description": "example",
"readOnly": true,
"answerDefinitions": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"definition": "example",
"sequenceNumber": 1,
"hasInput": true,
"active": true,
"score": 1,
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
],
"classificationId": "example",
"answerDefinitionGroupId": 1
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"definition": "example",
"sequenceNumber": 1,
"hasInput": true,
"active": true,
"score": 1,
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
],
"classificationId": "example",
"answerDefinitionGroupId": 1
}
],
"questions": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example"
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"sequenceNumber": 1,
"answerType": 1,
"text": "example",
"additionalInfo": "example",
"defaultAnswer": 1,
"skipOnYes": true,
"active": true,
"required": true,
"answerMaxLength": 1,
"groupId": 1,
"classificationId": "example"
}
],
"classificationId": "example"
},
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
]
}
]
},
"xml": {
"name": "omahaClassification"
}
},
"dossier.omaha.ClassifiedProblem": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "string",
"x-cupido-id": true
},
"omahaClassificationId": {
"type": "string"
},
"clientId": {
"type": "integer",
"format": "int64"
},
"ratingKnowledgeStart": {
"type": "integer",
"description": "(nl) Huidige score kennis",
"format": "int32"
},
"ratingBehaviorStart": {
"type": "integer",
"description": "(nl) Huidige score gedrag",
"format": "int32"
},
"ratingStatusSignalsStart": {
"type": "integer",
"description": "(nl) Huidige score status signaal",
"format": "int32"
},
"ratingKnowledgeTarget": {
"type": "integer",
"description": "(nl) Streef score kennis",
"format": "int32"
},
"ratingBehaviorTarget": {
"type": "integer",
"description": "(nl) Streef score gedrag",
"format": "int32"
},
"ratingStatusSignalsTarget": {
"type": "integer",
"description": "(nl) Streef score status signaal",
"format": "int32"
},
"modifierReach": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.omaha.ModifierReach"
}
],
"description": "(nl) Omaha kenmerken (1/2)"
},
"modifierProblemLevel": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.omaha.ModifierProblemLevel"
}
],
"description": "(nl) Omaha kenmerken (2/2)"
},
"additionalInfo": {
"type": "string",
"description": "(nl) Toelichting"
},
"omahaProblem": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.omaha.Problem"
}
],
"description": "Problem definition"
},
"omahaClassifiedSignsAndSymptoms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.omaha.ClassifiedSignOrSymptom"
},
"description": "(nl) Bijbehorende omaha 'signalen en symptomen'",
"xml": {
"wrapped": true
}
},
"omahaClassifiedInterventions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.omaha.ClassifiedIntervention"
},
"description": "(nl) Bijbehorende omaha 'acties'",
"xml": {
"wrapped": true
}
}
},
"description": "(nl) Omaha Gebieden ",
"example": {
"updatedAt": "2014-04-01T17:00:00.000+02:00",
"createdAt": "2013-12-01T17:00:00.000+01:00",
"createdBy": "user",
"id": "1:some.classification.id",
"omahaClassificationId": "care_plan:23",
"clientId": 3,
"ratingKnowledgeStart": 0,
"ratingBehaviorStart": 0,
"ratingStatusSignalsStart": 0,
"ratingKnowledgeTarget": 0,
"ratingBehaviorTarget": 0,
"ratingStatusSignalsTarget": 0,
"modifierReach": "Family",
"modifierProblemLevel": "Actual",
"additionalInfo": "Extra informatie",
"omahaProblem": {
"classificationId": "example",
"name": "example",
"omahaDomain": {
"classificationId": "example",
"name": "example"
},
"omahaSignsAndSymptoms": [
{
"classificationId": "example",
"name": "example",
"problemId": "example",
"textAllowed": true
},
{
"classificationId": "example",
"name": "example",
"problemId": "example",
"textAllowed": true
}
]
},
"omahaClassifiedSignsAndSymptoms": [
{
"text": "example",
"omahaSignOrSymptom": {
"classificationId": "example",
"name": "example",
"problemId": "example",
"textAllowed": true
}
},
{
"text": "example",
"omahaSignOrSymptom": {
"classificationId": "example",
"name": "example",
"problemId": "example",
"textAllowed": true
}
}
],
"omahaClassifiedInterventions": [
{
"id": 1,
"omahaInterventionCategory": {
"classificationId": "example",
"name": "example"
},
"omahaInterventionTarget": {
"classificationId": "example",
"name": "example"
},
"specification": "example",
"carePlanEntryId": 1,
"actionEntryId": 1
},
{
"id": 1,
"omahaInterventionCategory": {
"classificationId": "example",
"name": "example"
},
"omahaInterventionTarget": {
"classificationId": "example",
"name": "example"
},
"specification": "example",
"carePlanEntryId": 1,
"actionEntryId": 1
}
]
},
"xml": {
"name": "omahaClassifiedProblem"
}
},
"dossier.omaha.ClassifiedSignOrSymptom": {
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "(nl) Toelichting bij signalen en symptomen"
},
"omahaSignOrSymptom": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.omaha.SignOrSymptom"
}
],
"description": "(nl) Definitie van dit signaal/symptoom"
}
},
"description": "(nl) Omaha 'Signalen en symptomen' ",
"example": {
"text": "Some text",
"omahaSignOrSymptom": {
"classificationId": "example",
"name": "example",
"problemId": "example",
"textAllowed": true
}
},
"xml": {
"name": "omahaClassifiedSignOrSymptom"
}
},
"dossier.omaha.SignOrSymptom": {
"type": "object",
"properties": {
"classificationId": {
"type": "string",
"x-cupido-id": true
},
"name": {
"type": "string",
"description": "(nl) Naam van dit signaal/symptoom"
},
"problemId": {
"type": "string",
"description": "Object id of the related problem"
},
"textAllowed": {
"type": "boolean",
"description": "Indicates the presence of an extra textfield\n(nl) Geeft aan of er een extra tekstveld aanwezig is"
}
},
"description": "Omaha definitie van 'signalen en symptomen' ",
"example": {
"classificationId": "Dummy",
"name": "Dummy",
"problemId": "some.classification.id",
"textAllowed": true
},
"xml": {
"name": "omahaSignOrSymptom"
}
},
"dossier.omaha.ClassifiedIntervention": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"omahaInterventionCategory": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.omaha.InterventionCategory"
}
],
"description": "(nl) Soort actie"
},
"omahaInterventionTarget": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.omaha.InterventionTarget"
}
],
"description": "(nl) Actievlak"
},
"specification": {
"type": "string",
"description": "(nl) Specificatie"
},
"carePlanEntryId": {
"type": "integer",
"description": "Object id of the corresponding carePlanEntry",
"format": "int64"
},
"actionEntryId": {
"type": "integer",
"description": "Object id of the corresponding actionEntry",
"format": "int64"
}
},
"description": "(nl) Omaha Acties ",
"example": {
"id": 1,
"omahaInterventionCategory": {
"classificationId": "example",
"name": "example"
},
"omahaInterventionTarget": {
"classificationId": "example",
"name": "example"
},
"specification": "Dummy",
"carePlanEntryId": 13,
"actionEntryId": 14
},
"xml": {
"name": "omahaClassifiedIntervention"
}
},
"dossier.omaha.InterventionCategory": {
"type": "object",
"properties": {
"classificationId": {
"type": "string",
"x-cupido-id": true
},
"name": {
"type": "string",
"description": "(nl) Naam van deze actie"
}
},
"description": "Omaha soort actie ",
"example": {
"classificationId": "Dummy",
"name": "Dummy"
},
"xml": {
"name": "omahaInterventionCategory"
}
},
"dossier.omaha.InterventionTarget": {
"type": "object",
"properties": {
"classificationId": {
"type": "string",
"x-cupido-id": true
},
"name": {
"type": "string",
"description": "(nl) Naam van dit actievlak"
}
},
"description": "Omaha Actievlak ",
"example": {
"classificationId": "Dummy",
"name": "Dummy"
},
"xml": {
"name": "omahaInterventionTarget"
}
},
"dossier.omaha.ModifierReach": {
"type": "string",
"oneOf": [
{
"title": "Individual",
"enum": [
"Individual"
]
},
{
"title": "Family",
"enum": [
"Family"
]
},
{
"title": "Community",
"enum": [
"Community"
]
}
],
"description": "(nl) Omaha kenmerken (1/2)",
"example": "Individual"
},
"dossier.omaha.ModifierProblemLevel": {
"type": "string",
"oneOf": [
{
"title": "HealthPromotion",
"enum": [
"HealthPromotion"
]
},
{
"title": "Potential",
"enum": [
"Potential"
]
},
{
"title": "Actual",
"enum": [
"Actual"
]
}
],
"description": "(nl) Omaha kenmerken (2/2)",
"example": "HealthPromotion"
},
"dossier.omaha.Problem": {
"type": "object",
"properties": {
"classificationId": {
"type": "string",
"x-cupido-id": true
},
"name": {
"type": "string",
"description": "(nl) Naam van dit gebied"
},
"omahaDomain": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.omaha.Domain"
}
],
"description": "(nl) Domein van dit gebied"
},
"omahaSignsAndSymptoms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.omaha.SignOrSymptom"
},
"description": "(nl) Gerelateerde signalen en symptomen",
"xml": {
"wrapped": true
}
}
},
"description": "Omaha definitie van 'gebied' ",
"example": {
"classificationId": "Dummy",
"name": "Dummy",
"omahaDomain": {
"classificationId": "example",
"name": "example"
},
"omahaSignsAndSymptoms": [
{
"classificationId": "example",
"name": "example",
"problemId": "example",
"textAllowed": true
},
{
"classificationId": "example",
"name": "example",
"problemId": "example",
"textAllowed": true
}
]
},
"xml": {
"name": "omahaProblem"
}
},
"dossier.omaha.Domain": {
"type": "object",
"properties": {
"classificationId": {
"type": "string",
"x-cupido-id": true
},
"name": {
"type": "string",
"description": "(nl) Naam van dit domein"
}
},
"description": "Omaha Domein ",
"example": {
"classificationId": "Dummy",
"name": "Dummy"
},
"xml": {
"name": "omahaDomain"
}
},
"dossier.omaha.ClassificationStatus": {
"enum": [
"DRAFT",
"ACTIVE",
"OLD"
],
"type": "string",
"description": "Status of this omaha classification",
"example": "DRAFT"
},
"Referral": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"clientId": {
"type": "integer",
"format": "int64"
},
"documentId": {
"type": "integer",
"format": "int64"
},
"date": {
"type": "string",
"format": "date"
},
"referrerType": {
"type": "string"
},
"referrerCategory": {
"type": "string"
},
"agbCode": {
"type": "string"
},
"referrer": {
"type": "string"
},
"specialism": {
"type": "string"
},
"institution": {
"type": "integer",
"description": "Institution type for the referral. Can be\n\n
",
"format": "int32"
}
},
"description": "Referral model (no description)",
"example": {
"id": 1,
"clientId": 2,
"documentId": 1,
"date": "2017-01-01",
"referrerType": "01",
"referrerCategory": "02",
"agbCode": "12345678",
"referrer": "naam",
"specialism": "0100",
"institution": 2
},
"xml": {
"name": "referral"
}
},
"survey.SurveyResult": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"surveyObjectId": {
"type": "integer",
"format": "int64"
},
"clientObjectId": {
"type": "integer",
"format": "int64"
},
"employeeObjectId": {
"type": "integer",
"format": "int64"
},
"status": {
"$ref": "#/components/schemas/survey.SurveyResultStatus"
},
"version": {
"type": "integer",
"format": "int64"
},
"title": {
"type": "string"
},
"linkedToActiveCarePlan": {
"type": "boolean"
},
"isAnyCarePlanUsingThisResult": {
"type": "boolean"
},
"duplicateSurveyResultAbility": {
"$ref": "#/components/schemas/Ability"
},
"editSurveyResultAbility": {
"$ref": "#/components/schemas/Ability"
},
"statusBumpSurveyResultAbility": {
"$ref": "#/components/schemas/Ability"
},
"viewSurveyResultAbility": {
"$ref": "#/components/schemas/Ability"
},
"answers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/survey.Answer"
},
"xml": {
"wrapped": true
}
},
"groupAnswers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/survey.GroupAnswer"
},
"xml": {
"wrapped": true
}
},
"completedAt": {
"type": "string",
"format": "date-time"
}
},
"description": "SurveyResult model (no description)",
"example": {
"id": 111,
"surveyObjectId": 555,
"clientObjectId": 333,
"employeeObjectId": 444,
"version": 1,
"linkedToActiveCarePlan": true,
"isAnyCarePlanUsingThisResult": true,
"createdAt": "2012-08-02T13:48:46.836+02:00",
"updatedAt": "2012-08-02T13:48:46.836+02:00",
"createdBy": "user",
"completedAt": "2012-08-02T13:48:46.836+02:00",
"status": "Draft",
"title": "test",
"duplicateSurveyResultAbility": {
"enabled": true,
"possible": true
},
"editSurveyResultAbility": {
"enabled": true,
"possible": true
},
"statusBumpSurveyResultAbility": {
"enabled": true,
"possible": true
},
"viewSurveyResultAbility": {
"enabled": true,
"possible": true
},
"answers": [],
"groupAnswers": []
},
"xml": {
"name": "surveyResult"
}
},
"survey.SurveyResultStatus": {
"type": "string",
"oneOf": [
{
"title": "New",
"enum": [
"New"
]
},
{
"title": "Draft",
"enum": [
"Draft"
]
},
{
"title": "Review",
"enum": [
"Review"
]
},
{
"title": "Current",
"enum": [
"Current"
]
},
{
"title": "Archived",
"enum": [
"Archived"
]
}
],
"description": "SurveyResultStatus model (no description)",
"example": "New"
},
"Ability": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"possible": {
"type": "boolean"
},
"message": {
"type": "string"
}
},
"description": "Ability model (no description)",
"example": {
"enabled": true,
"possible": false,
"message": "message"
}
},
"survey.GroupAnswer": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"groupId": {
"type": "integer",
"format": "int64"
},
"surveyResultId": {
"type": "integer",
"format": "int64"
},
"score": {
"type": "integer",
"format": "int32"
},
"importantForCareplan": {
"type": "boolean"
}
},
"description": "GroupAnswer model (no description)",
"example": {
"id": 1,
"surveyResultId": 1,
"groupId": 1,
"score": 7,
"createdAt": "2012-08-02T13:48:46.836+02:00",
"updatedAt": "2012-08-02T13:48:46.836+02:00",
"createdBy": "user",
"importantForCareplan": true
},
"xml": {
"name": "groupAnswer"
}
},
"survey.Survey": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"description": {
"type": "string"
},
"title": {
"type": "string"
},
"active": {
"type": "boolean"
},
"useWorkflow": {
"type": "boolean"
},
"useStrictEditAuthorization": {
"type": "boolean"
},
"copyingAllowed": {
"type": "boolean"
},
"signalNonClosed": {
"type": "boolean",
"description": "Setting no longer provided by Ons Administratie 2016.5.0+\nInstances of this questionaire need to be signaled on the dashboard when incomplete\n",
"deprecated": true
},
"signalTitle": {
"type": "string",
"description": "Setting no longer provided by Ons Administratie 2016.5.0+\nTitle of the dashboard signal\n",
"deprecated": true
},
"daysToExpiration": {
"type": "integer",
"description": "Setting no longer provided by Ons Administratie 2016.5.0+\nNumber of days the survey is valid\n",
"format": "int32",
"deprecated": true
},
"classificationId": {
"type": "string"
},
"surveyResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/survey.SurveyResult"
},
"xml": {
"wrapped": true
}
},
"categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/survey.Category"
},
"xml": {
"wrapped": true
}
},
"allowedToCreateExpertiseProfiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpertiseProfile"
},
"xml": {
"wrapped": true
}
},
"allowedToEditExpertiseProfiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpertiseProfile"
},
"xml": {
"wrapped": true
}
},
"allowedToViewExpertiseProfiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpertiseProfile"
},
"xml": {
"wrapped": true
}
},
"expertiseProfilesAllowedToCreateSurvey": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/ExpertiseProfile"
}
],
"xml": {
"name": "expertiseProfile"
}
},
"description": "Use allowedToCreateExpertiseProfiles instead",
"deprecated": true,
"xml": {
"wrapped": true
}
},
"expertiseProfilesAllowedToEditSurvey": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/ExpertiseProfile"
}
],
"xml": {
"name": "expertiseProfile"
}
},
"description": "Use allowedToEditExpertiseProfiles instead",
"deprecated": true,
"xml": {
"wrapped": true
}
},
"expertiseProfilesAllowedToViewSurvey": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/ExpertiseProfile"
}
],
"xml": {
"name": "expertiseProfile"
}
},
"description": "Use allowedToViewExpertiseProfiles instead",
"deprecated": true,
"xml": {
"wrapped": true
}
}
},
"description": "Survey model (no description)",
"example": {
"updatedAt": "2012-08-02T13:48:46.836+02:00",
"createdAt": "2012-08-02T13:48:46.836+02:00",
"createdBy": "jan-willem mooij",
"id": 11,
"description": "vragenlijst omschr",
"title": "intake",
"active": true,
"useWorkflow": true,
"useStrictEditAuthorization": true,
"copyingAllowed": true,
"signalNonClosed": true,
"signalTitle": "let op niet afgehandeld",
"daysToExpiration": 30,
"classificationId": "omaha",
"surveyResults": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyObjectId": 1,
"clientObjectId": 1,
"employeeObjectId": 1,
"status": "New",
"version": 1,
"title": "example",
"linkedToActiveCarePlan": true,
"isAnyCarePlanUsingThisResult": true,
"duplicateSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"editSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"statusBumpSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"viewSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
],
"groupAnswers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"groupId": 1,
"surveyResultId": 1,
"score": 1,
"importantForCareplan": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"groupId": 1,
"surveyResultId": 1,
"score": 1,
"importantForCareplan": true
}
],
"completedAt": "2014-12-29T00:00:00.000+01:00"
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyObjectId": 1,
"clientObjectId": 1,
"employeeObjectId": 1,
"status": "New",
"version": 1,
"title": "example",
"linkedToActiveCarePlan": true,
"isAnyCarePlanUsingThisResult": true,
"duplicateSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"editSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"statusBumpSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"viewSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
],
"groupAnswers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"groupId": 1,
"surveyResultId": 1,
"score": 1,
"importantForCareplan": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"groupId": 1,
"surveyResultId": 1,
"score": 1,
"importantForCareplan": true
}
],
"completedAt": "2014-12-29T00:00:00.000+01:00"
}
],
"categories": [],
"allowedToCreateExpertiseProfiles": [
{
"id": 5,
"description": "Helpenden",
"visible": true,
"beginDate": "2015-01-01T12:00:00.000+01:00",
"endDate": "2020-01-01T12:00:00.000+01:00",
"allowDossierActions": true,
"allowDossierConfidential": false
}
],
"allowedToEditExpertiseProfiles": [
{
"id": 5,
"description": "Helpenden",
"visible": true,
"beginDate": "2015-01-01T12:00:00.000+01:00",
"endDate": "2020-01-01T12:00:00.000+01:00",
"allowDossierActions": true,
"allowDossierConfidential": false
}
],
"allowedToViewExpertiseProfiles": [
{
"id": 5,
"description": "Helpenden",
"visible": true,
"beginDate": "2015-01-01T12:00:00.000+01:00",
"endDate": "2020-01-01T12:00:00.000+01:00",
"allowDossierActions": true,
"allowDossierConfidential": false
}
],
"expertiseProfilesAllowedToCreateSurvey": [
{
"id": 5,
"description": "Helpenden",
"visible": true,
"beginDate": "2015-01-01T12:00:00.000+01:00",
"endDate": "2020-01-01T12:00:00.000+01:00",
"allowDossierActions": true,
"allowDossierConfidential": false
}
],
"expertiseProfilesAllowedToEditSurvey": [
{
"id": 5,
"description": "Helpenden",
"visible": true,
"beginDate": "2015-01-01T12:00:00.000+01:00",
"endDate": "2020-01-01T12:00:00.000+01:00",
"allowDossierActions": true,
"allowDossierConfidential": false
}
],
"expertiseProfilesAllowedToViewSurvey": [
{
"id": 5,
"description": "Helpenden",
"visible": true,
"beginDate": "2015-01-01T12:00:00.000+01:00",
"endDate": "2020-01-01T12:00:00.000+01:00",
"allowDossierActions": true,
"allowDossierConfidential": false
}
]
},
"xml": {
"name": "survey"
}
},
"survey.Category": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"title": {
"type": "string"
},
"sequenceNumber": {
"type": "integer",
"format": "int32"
},
"classificationId": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/survey.Group"
},
"xml": {
"wrapped": true
}
},
"surveyId": {
"type": "integer",
"format": "int32"
}
},
"description": "Category model (no description)",
"example": {
"updatedAt": "2012-08-02T13:48:46.836+02:00",
"createdAt": "2012-08-02T13:48:46.836+02:00",
"createdBy": "user",
"id": 1,
"title": "cat1",
"sequenceNumber": 1,
"classificationId": "classification.domain.health",
"groups": [],
"surveyId": 1
},
"xml": {
"name": "category"
}
},
"survey.Group": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"description": {
"type": "string"
},
"sequenceNumber": {
"type": "integer",
"format": "int32"
},
"maxScore": {
"type": "integer",
"format": "int32"
},
"thresholdScore": {
"type": "integer",
"format": "int32"
},
"questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/survey.Question"
},
"xml": {
"wrapped": true
}
},
"demandDefinitionId": {
"type": "integer",
"format": "int64"
},
"classificationId": {
"type": "string"
}
},
"description": "Group model (no description)",
"example": {
"updatedAt": "2012-08-02T13:48:46.836+02:00",
"createdAt": "2012-08-02T13:48:46.836+02:00",
"createdBy": "user",
"id": 1,
"description": "beschrijving",
"sequenceNumber": 1,
"maxScore": 10,
"thresholdScore": 5,
"questions": [],
"demandDefinitionId": 1,
"classificationId": "classification.problem.health.nutrition"
},
"xml": {
"name": "group"
}
},
"TeamAddress": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Address"
}
],
"properties": {
"teamId": {
"type": "integer",
"format": "int64"
}
},
"description": "The address of a team",
"example": {
"id": 1,
"beginDate": "2010-02-16",
"endDate": "2010-02-17",
"homeNumber": 4,
"homeNumberExtension": "a",
"poBoxNumber": "123a",
"street": "Parallelweg",
"city": "Enschede",
"zipcode": "7513KC",
"municipality": "Enschede",
"country": "Netherlands",
"telephoneNumber": "053-1234567",
"telephoneCountryCode": "+31",
"telephoneNumber2": "053-1234567",
"telephoneCountryCode2": "+31",
"faxNumber": "053-1234567",
"email": "mike.wazowski@nedap.com",
"type": "98",
"typeString": "Other address",
"residentType": "0",
"personType": "6",
"personTypeString": "cluster",
"roomNumber": "1",
"locationDescription": "Afdeling noord",
"updatedAt": "2016-01-01T12:00:00.000+01:00",
"createdAt": "2016-01-01T12:00:00.000+01:00",
"latitude": 52.1,
"longitude": 6.9,
"teamId": 2,
"situationDescription": "Test",
"residenceAccessInfo": "Test"
},
"xml": {
"name": "teamAddress"
}
},
"User": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"uuid": {
"type": "string"
},
"userName": {
"type": "string"
},
"activeSession": {
"type": "boolean"
},
"employeeObjectId": {
"type": "integer",
"format": "int64"
},
"employeeName": {
"type": "string"
},
"teamObjectId": {
"type": "integer",
"description": "read only, corresponds with the team.id of the active team for the employee related to this user",
"format": "int64"
},
"teamName": {
"type": "string"
},
"mobilePhone": {
"type": "string",
"description": "read only, corresponds with employee.mobilePhoneNumber"
},
"mobilePhoneNumber": {
"type": "string",
"description": "read only, corresponds with employee.authenticationMobilePhone"
},
"passwordChange": {
"type": "boolean"
},
"emailAddress": {
"type": "string",
"description": "Deprecated since: 14-03-2019",
"deprecated": true
},
"administrationEnabled": {
"type": "boolean",
"description": "Deprecated since: 14-03-2019 - Replaced by the `AdministrationLogin` right. Determines if a user can log into Administration.",
"deprecated": true
},
"portalEnabled": {
"type": "boolean",
"description": "Deprecated since: 14-03-2019 - Replaced by the `EmployeePortalLogin` right. Determines if a user can log into the Nurse Portal.",
"deprecated": true
},
"accessTestEnvironmentEnabled": {
"type": "boolean",
"description": "Deprecated since: 14-03-2019 - Replaced by the `AdministrationTestLogin` right. Determines if a user can log into development / staging environments",
"deprecated": true
},
"shieldEnabled": {
"type": "boolean",
"description": "Deprecated since: 11-11-2019 - Shield is now always enabled.",
"deprecated": true
},
"ssoEnabled": {
"type": "boolean"
},
"ssoId": {
"type": "string"
},
"ssoProviderId": {
"type": "string"
},
"forceSmsAuthentication": {
"type": "boolean"
},
"roles": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
},
"description": "Deprecated since: 14-03-2019\nDo not use. Shield will not support it. See https://github.com/nedap/shield/issues/3207#issuecomment-635947346",
"deprecated": true,
"xml": {
"wrapped": true
}
},
"allLocationsViewable": {
"type": "boolean",
"description": "Deprecated since: 14-03-2019\nDo not use. Shield will not support it. See https://github.com/nedap/shield/issues/3207#issuecomment-635947346",
"deprecated": true
},
"limitLocationView": {
"type": "boolean",
"description": "Deprecated since: 14-03-2019\nDo not use. Shield will not support it. See https://github.com/nedap/shield/issues/3207#issuecomment-635947346",
"deprecated": true
},
"teamAccess": {
"type": "string",
"description": "Deprecated since: 14-03-2019\nDo not use. Shield will not support it. See https://github.com/nedap/shield/issues/3207#issuecomment-635947346",
"deprecated": true
},
"locationAccess": {
"type": "string",
"description": "Deprecated since: 14-03-2019\nDo not use. Shield will not support it. See https://github.com/nedap/shield/issues/3207#issuecomment-635947346",
"deprecated": true
},
"contractRequiredAtLogin": {
"type": "boolean",
"description": "Indicates if the user should have an active contract during login (if this functionality is enabled)",
"default": false
},
"dashboardProfileObjectId": {
"type": "integer",
"description": "Object id of the dashboard profile to use for this User. If not set when creating a user, the default dashboard profile is used.",
"format": "int64"
}
},
"description": "User model (no description)",
"example": {
"employeeObjectId": 334,
"userName": "mike.wazowski",
"id": 348,
"employeeName": "Dhr. Mike Wazowski",
"activeSession": true,
"teamObjectId": 209,
"teamName": "Team wijkzorg",
"mobilePhone": "0655130353",
"mobilePhoneNumber": "0653238787",
"passwordChange": false,
"emailAddress": "mike.wazowski@nedap.com",
"teamAccess": "All",
"locationAccess": "All",
"administrationEnabled": true,
"portalEnabled": true,
"shieldEnabled": true,
"ssoEnabled": true,
"ssoId": "user@domain.com",
"ssoProviderId": "12345",
"forceSmsAuthentication": false,
"accessTestEnvironmentEnabled": true,
"contractRequiredAtLogin": true,
"uuid": "129347091234",
"allLocationsViewable": true,
"limitLocationView": false,
"roles": [],
"dashboardProfileObjectId": 1
},
"xml": {
"name": "user"
}
},
"Role": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"x-cupido-id": true
},
"name": {
"type": "string"
}
},
"description": "Role model (no description)",
"example": {
"id": 24,
"name": "iO Me gebruiker"
},
"xml": {
"name": "role"
}
},
"PasswordChange": {
"type": "object",
"properties": {
"userId": {
"type": "integer",
"format": "int64"
},
"newPassword": {
"type": "string"
}
},
"description": "PasswordChange model (no description)",
"example": {
"userId": 1,
"newPassword": "newPassword"
}
},
"wlz.WlzZorglegitimatie": {
"required": [
"id",
"client",
"berichten"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The id for the import",
"format": "int64",
"x-cupido-id": true
},
"client": {
"type": "integer",
"description": "The client",
"format": "int64"
},
"berichten": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/lz.Bericht"
}
],
"xml": {
"name": "bericht"
}
},
"description": "A list with messages",
"xml": {
"wrapped": true
}
}
},
"description": "WlzZorglegitimatie model (no description)",
"example": {
"id": 1,
"client": 1,
"berichten": [
{
"content": "test"
}
]
},
"xml": {
"name": "wlzZorglegitimatie"
}
},
"wmo.WmoZorglegitimatie": {
"required": [
"id",
"client",
"berichten"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The id for the import",
"format": "int64",
"x-cupido-id": true
},
"client": {
"type": "integer",
"description": "The client",
"format": "int64"
},
"berichten": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/lz.Bericht"
}
],
"xml": {
"name": "bericht"
}
},
"description": "A list with messages",
"xml": {
"wrapped": true
}
}
},
"description": "WmoZorglegitimatie model (no description)",
"example": {
"id": 1,
"client": 1,
"berichten": [
{
"content": "test"
}
]
},
"xml": {
"name": "wmoZorglegitimatie"
}
},
"zpm.CareOrderZpmDetails": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"careOrderObjectId": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"zorgtrajectStartDate": {
"type": "string",
"description": "Zorgtraject(nummer) startdate.",
"format": "date"
},
"zpmSettings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zpm.CareOrderZpmSetting"
},
"xml": {
"wrapped": true
}
},
"zpmZorglabels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zpm.CareOrderZpmZorglabel"
},
"xml": {
"wrapped": true
}
},
"zpmGbggzProfielen": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/zpm.CareOrderZpmGbggzProfiel"
}
],
"xml": {
"name": "zpmGbggzProfiel"
}
},
"xml": {
"wrapped": true
}
},
"zpmReferrals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zpm.CareOrderZpmReferral"
},
"xml": {
"wrapped": true
}
},
"zpmRegiebehandelaars": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zpm.CareOrderZpmRegiebehandelaar"
},
"xml": {
"wrapped": true
}
},
"zpmTariefniveaus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zpm.CareOrderZpmTariefniveau"
},
"xml": {
"wrapped": true
}
},
"zpmForensischeZorgtitels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zpm.CareOrderZpmForensischeZorgtitel"
},
"xml": {
"wrapped": true
}
},
"zpmPlaatsingsbesluitnummers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zpm.CareOrderZpmPlaatsingsbesluitnummer"
},
"xml": {
"wrapped": true
}
},
"zpmTreatmentLocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zpm.CareOrderZpmTreatmentLocation"
},
"xml": {
"wrapped": true
}
},
"zpmMachtigingsnummers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zpm.CareOrderZpmMachtigingsnummer"
},
"xml": {
"wrapped": true
}
}
},
"description": "Contains ZPM specific details belonging to a {@link com.nedap.healthcare.domain.finance.CareOrder}.",
"example": {
"updatedAt": "2021-09-21T13:52:09.000+02:00",
"createdAt": "2021-09-21T13:52:09.000+02:00",
"createdBy": "user",
"careOrderObjectId": 345,
"zorgtrajectStartDate": "2021-09-21",
"zpmSettings": [
{
"updatedAt": "2021-09-21T13:52:09.000+02:00",
"createdAt": "2021-09-21T13:52:09.000+02:00",
"createdBy": "user",
"id": 13,
"beginDate": "2022-10-01",
"endDate": "2022-12-31",
"careOrderObjectId": 345,
"zpmSettingObjectId": 5
}
],
"zpmZorglabels": [
{
"updatedAt": "2021-09-21T13:52:09.000+02:00",
"createdAt": "2021-09-21T13:52:09.000+02:00",
"createdBy": "user",
"id": 23,
"beginDate": "2022-01-01",
"value": "Talentolk",
"careOrderObjectId": 345,
"zpmZorglabelObjectId": 4
}
],
"zpmGbggzProfielen": [
{
"updatedAt": "2021-09-21T13:52:09.000+02:00",
"createdAt": "2021-09-21T13:52:09.000+02:00",
"createdBy": "user",
"id": 23,
"beginDate": "2022-03-01",
"endDate": "2022-12-31",
"careOrderObjectId": 345,
"zpmGbggzProfielObjectId": 4
}
],
"zpmReferrals": [
{
"updatedAt": "2021-09-21T13:52:09.000+02:00",
"createdAt": "2021-09-21T13:52:09.000+02:00",
"createdBy": "user",
"id": 6,
"beginDate": "2022-01-01",
"endDate": "2022-01-31",
"careOrderObjectId": 345,
"referralObjectId": 21
}
],
"zpmRegiebehandelaars": [
{
"updatedAt": "2021-09-21T13:52:09.000+02:00",
"createdAt": "2021-09-21T13:52:09.000+02:00",
"createdBy": "user",
"id": 6,
"beginDate": "2022-01-01",
"endDate": "2022-01-31",
"careOrderObjectId": 345,
"employeeObjectId": 56
}
],
"zpmTariefniveaus": [
{
"updatedAt": "2021-09-21T13:52:09.000+02:00",
"createdAt": "2021-09-21T13:52:09.000+02:00",
"createdBy": "user",
"id": 9,
"beginDate": "2022-07-01",
"careOrderObjectId": 345,
"zpmTariefniveau": "Laag"
}
],
"zpmForensischeZorgtitels": [
{
"updatedAt": "2021-09-21T13:52:09.000+02:00",
"createdAt": "2021-09-21T13:52:09.000+02:00",
"createdBy": "user",
"id": 9,
"beginDate": "2022-07-01",
"endDate": "2022-12-31",
"careOrderObjectId": 345,
"forensischeZorgtitel": "123"
}
],
"zpmPlaatsingsbesluitnummers": [
{
"updatedAt": "2021-09-21T13:52:09.000+02:00",
"createdAt": "2021-09-21T13:52:09.000+02:00",
"createdBy": "user",
"id": 9,
"beginDate": "2022-07-01",
"endDate": "2022-12-31",
"careOrderObjectId": 345,
"plaatsingsbesluitnummer": "012345678"
}
],
"zpmTreatmentLocations": [
{
"updatedAt": "2021-09-21T13:52:09.000+02:00",
"createdAt": "2021-09-21T13:52:09.000+02:00",
"createdBy": "user",
"id": 9,
"beginDate": "2022-07-01",
"endDate": "2022-12-31",
"careOrderObjectId": 345,
"treatmentLocationObjectId": 124
}
],
"zpmMachtigingsnummers": [
{
"updatedAt": "2021-09-21T13:52:09.000+02:00",
"createdAt": "2021-09-21T13:52:09.000+02:00",
"createdBy": "user",
"id": 9,
"beginDate": "2022-07-01",
"endDate": "2022-12-31",
"careOrderObjectId": 345,
"machtigingsnummer": "0123987654"
}
]
},
"xml": {
"name": "careOrderZpmDetails"
}
},
"zpm.CareOrderZpmSetting": {
"required": [
"beginDate",
"zpmSettingObjectId"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"description": "Object identifier.",
"format": "int64",
"x-cupido-id": true
},
"beginDate": {
"type": "string",
"description": "Validity begin date.",
"format": "date"
},
"endDate": {
"type": "string",
"description": "Validity end date.",
"format": "date"
},
"careOrderObjectId": {
"type": "integer",
"description": "Care order object id.",
"format": "int64"
},
"zpmSettingObjectId": {
"type": "integer",
"description": "ZPM setting object id.",
"format": "int64"
}
},
"description": "Describes which {@link ZpmSetting} is applicable to a {@link com.nedap.healthcare.domain.finance.CareOrder}\nover a period of time.",
"example": {
"updatedAt": "2021-09-21T13:52:09.000+02:00",
"createdAt": "2021-09-21T13:52:09.000+02:00",
"createdBy": "user",
"id": 13,
"beginDate": "2022-10-01",
"endDate": "2022-12-31",
"careOrderObjectId": 345,
"zpmSettingObjectId": 5
}
},
"zpm.CareOrderZpmZorglabel": {
"required": [
"beginDate",
"zpmZorglabelObjectId"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"description": "Object identifier.",
"format": "int64",
"x-cupido-id": true
},
"beginDate": {
"type": "string",
"description": "Validity begin date.",
"format": "date"
},
"endDate": {
"type": "string",
"description": "Validity end date.",
"format": "date"
},
"value": {
"type": "string",
"description": "Specific value for the zorglabel assignment."
},
"careOrderObjectId": {
"type": "integer",
"description": "Care order object id.",
"format": "int64"
},
"zpmZorglabelObjectId": {
"type": "integer",
"description": "ZPM zorglabel object id.",
"format": "int64"
}
},
"description": "Describes which {@link ZpmZorglabel} is applicable to a {@link com.nedap.healthcare.domain.finance.CareOrder}\nover a period of time.",
"example": {
"updatedAt": "2021-09-21T13:52:09.000+02:00",
"createdAt": "2021-09-21T13:52:09.000+02:00",
"createdBy": "user",
"id": 23,
"beginDate": "2022-01-01",
"endDate": "2022-12-31",
"value": "Talentolk",
"careOrderObjectId": 345,
"zpmZorglabelObjectId": 4
}
},
"zpm.CareOrderZpmReferral": {
"required": [
"beginDate",
"referralObjectId"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"description": "Object identifier.",
"format": "int64",
"x-cupido-id": true
},
"beginDate": {
"type": "string",
"description": "Validity begin date.",
"format": "date"
},
"endDate": {
"type": "string",
"description": "Validity end date.",
"format": "date"
},
"careOrderObjectId": {
"type": "integer",
"description": "Care order object id.",
"format": "int64"
},
"referralObjectId": {
"type": "integer",
"description": "Referral object id.",
"format": "int64"
}
},
"description": "Describes which {@link com.nedap.healthcare.domain.Referral} is applicable to a {@link com.nedap.healthcare.domain.finance.CareOrder}\nover a period of time.",
"example": {
"updatedAt": "2021-09-21T13:52:09.000+02:00",
"createdAt": "2021-09-21T13:52:09.000+02:00",
"createdBy": "user",
"id": 6,
"beginDate": "2022-01-01",
"endDate": "2022-01-31",
"careOrderObjectId": 345,
"referralObjectId": 21
}
},
"zpm.CareOrderZpmRegiebehandelaar": {
"required": [
"beginDate",
"employeeObjectId"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"description": "Object identifier.",
"format": "int64",
"x-cupido-id": true
},
"beginDate": {
"type": "string",
"description": "Validity begin date.",
"format": "date"
},
"endDate": {
"type": "string",
"description": "Validity end date.",
"format": "date"
},
"careOrderObjectId": {
"type": "integer",
"description": "Care order object id.",
"format": "int64"
},
"employeeObjectId": {
"type": "integer",
"description": "Regiebehandelaar (employee) object id.",
"format": "int64"
}
},
"description": "Describes which {@link com.nedap.healthcare.domain.Employee ZPM regiebehandelaar} is applicable to a {@link com.nedap.healthcare.domain.finance.CareOrder}\nover a period of time.",
"example": {
"updatedAt": "2021-09-21T13:52:09.000+02:00",
"createdAt": "2021-09-21T13:52:09.000+02:00",
"createdBy": "user",
"id": 6,
"beginDate": "2022-01-01",
"endDate": "2022-01-31",
"careOrderObjectId": 345,
"employeeObjectId": 56
}
},
"zpm.CareOrderZpmTariefniveau": {
"required": [
"beginDate",
"zpmTariefniveau"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"description": "Object identifier.",
"format": "int64",
"x-cupido-id": true
},
"beginDate": {
"type": "string",
"description": "Validity begin date.",
"format": "date"
},
"endDate": {
"type": "string",
"description": "Validity end date.",
"format": "date"
},
"careOrderObjectId": {
"type": "integer",
"description": "Care order object id.",
"format": "int64"
},
"zpmTariefniveau": {
"type": "string",
"description": "Tariefniveau, can be Laag or Hoog."
}
},
"description": "Describes which ZPM tariefniveau is applicable to a {@link com.nedap.healthcare.domain.finance.CareOrder}\nover a period of time.",
"example": {
"updatedAt": "2021-09-21T13:52:09.000+02:00",
"createdAt": "2021-09-21T13:52:09.000+02:00",
"createdBy": "user",
"id": 9,
"beginDate": "2022-07-01",
"endDate": "2022-12-31",
"careOrderObjectId": 345,
"zpmTariefniveau": "Laag"
}
},
"zpm.CareOrderZpmForensischeZorgtitel": {
"required": [
"beginDate",
"forensischeZorgtitel"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"description": "Object identifier.",
"format": "int64",
"x-cupido-id": true
},
"beginDate": {
"type": "string",
"description": "Validity begin date.",
"format": "date"
},
"endDate": {
"type": "string",
"description": "Validity end date.",
"format": "date"
},
"careOrderObjectId": {
"type": "integer",
"description": "Care order object id.",
"format": "int64"
},
"forensischeZorgtitel": {
"type": "string",
"description": "Forensische zorgtitel, see\nhttps://www.vektis.nl/streams/standaardisatie/codelijsten/COD706-MVJ"
}
},
"description": "Describes which ZPM forensische zorgtitel is applicable to a {@link com.nedap.healthcare.domain.finance.CareOrder}\nover a period of time.",
"example": {
"updatedAt": "2021-09-21T13:52:09.000+02:00",
"createdAt": "2021-09-21T13:52:09.000+02:00",
"createdBy": "user",
"id": 9,
"beginDate": "2022-07-01",
"endDate": "2022-12-31",
"careOrderObjectId": 345,
"forensischeZorgtitel": "123"
}
},
"zpm.CareOrderZpmPlaatsingsbesluitnummer": {
"required": [
"beginDate",
"plaatsingsbesluitnummer"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"description": "Object identifier.",
"format": "int64",
"x-cupido-id": true
},
"beginDate": {
"type": "string",
"description": "Validity begin date.",
"format": "date"
},
"endDate": {
"type": "string",
"description": "Validity end date.",
"format": "date"
},
"careOrderObjectId": {
"type": "integer",
"description": "Care order object id.",
"format": "int64"
},
"plaatsingsbesluitnummer": {
"type": "string",
"description": "Plaatsingsbesluitnummer, a 9 digit number."
},
"fpt": {
"type": "boolean",
"description": "Indicates a plaatsingsbesluitnummer for Forensisch psychiatrisch toezicht (fpt)."
}
},
"description": "Describes which ZPM plaatsingsbesluitnummer is applicable to a {@link com.nedap.healthcare.domain.finance.CareOrder}\nover a period of time.",
"example": {
"updatedAt": "2021-09-21T13:52:09.000+02:00",
"createdAt": "2021-09-21T13:52:09.000+02:00",
"createdBy": "user",
"id": 9,
"beginDate": "2022-07-01",
"endDate": "2022-12-31",
"careOrderObjectId": 345,
"plaatsingsbesluitnummer": "012345678",
"fpt": false
}
},
"zpm.CareOrderZpmTreatmentLocation": {
"required": [
"beginDate",
"treatmentLocationObjectId"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"description": "Object identifier.",
"format": "int64",
"x-cupido-id": true
},
"beginDate": {
"type": "string",
"description": "Validity begin date.",
"format": "date"
},
"endDate": {
"type": "string",
"description": "Validity end date.",
"format": "date"
},
"careOrderObjectId": {
"type": "integer",
"description": "Care order object id.",
"format": "int64"
},
"treatmentLocationObjectId": {
"type": "integer",
"description": "Behandel locatie id.",
"format": "int64"
}
},
"description": "Describes which ZPM treatment location is applicable to a {@link com.nedap.healthcare.domain.finance.CareOrder}\nover a period of time.",
"example": {
"updatedAt": "2021-09-21T13:52:09.000+02:00",
"createdAt": "2021-09-21T13:52:09.000+02:00",
"createdBy": "user",
"id": 9,
"beginDate": "2022-07-01",
"endDate": "2022-12-31",
"careOrderObjectId": 345,
"treatmentLocationObjectId": 124
}
},
"zpm.CareOrderZpmMachtigingsnummer": {
"required": [
"beginDate",
"machtigingsnummer"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"description": "Object identifier.",
"format": "int64",
"x-cupido-id": true
},
"beginDate": {
"type": "string",
"description": "Validity begin date.",
"format": "date"
},
"endDate": {
"type": "string",
"description": "Validity end date.",
"format": "date"
},
"careOrderObjectId": {
"type": "integer",
"description": "Care order object id.",
"format": "int64"
},
"machtigingsnummer": {
"type": "string",
"description": "Machtigings nummer."
}
},
"description": "Describes which ZPM machtigingsnummer is applicable to a {@link com.nedap.healthcare.domain.finance.CareOrder}\nover a period of time.",
"example": {
"updatedAt": "2021-09-21T13:52:09.000+02:00",
"createdAt": "2021-09-21T13:52:09.000+02:00",
"createdBy": "user",
"id": 9,
"beginDate": "2022-07-01",
"endDate": "2022-12-31",
"careOrderObjectId": 345,
"machtigingsnummer": "0123987654"
}
},
"zpm.CareOrderZpmGbggzProfiel": {
"required": [
"beginDate",
"zpmGbggzProfielObjectId"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"description": "Object identifier.",
"format": "int64",
"x-cupido-id": true
},
"beginDate": {
"type": "string",
"description": "Validity begin date.",
"format": "date"
},
"endDate": {
"type": "string",
"description": "Validity end date.",
"format": "date"
},
"careOrderObjectId": {
"type": "integer",
"description": "Care order object id.",
"format": "int64"
},
"zpmGbggzProfielObjectId": {
"type": "integer",
"description": "ZPM GB-ggz profiel object id.",
"format": "int64"
}
},
"description": "Describes which {@link ZpmGbggzProfiel} is applicable to a {@link com.nedap.healthcare.domain.finance.CareOrder}\nover a period of time.",
"example": {
"updatedAt": "2021-09-21T13:52:09.000+02:00",
"createdAt": "2021-09-21T13:52:09.000+02:00",
"createdBy": "user",
"id": 23,
"beginDate": "2022-03-01",
"endDate": "2022-12-31",
"careOrderObjectId": 345,
"zpmGbggzProfielObjectId": 4
},
"xml": {
"name": "careOrderZpmGbggzProfiel"
}
},
"agenda.AgendaOccurrence": {
"title": "EventOccurrence",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Identifier of this occurrence",
"x-cupido-id": true
},
"occurrenceDate": {
"type": "string",
"description": "Date on which this occurrence occurs based on the recurrence rule",
"format": "date",
"nullable": true
},
"uuid": {
"type": "string",
"description": "External reference for `AgendaSeries` to which this occurrence belongs\nExternal parties can use this for their own bookkeeping.\nIs generated if not provided. If provided, it must be unique, will result in 422 otherwise. Every change at one point in a appointment series, results in a new `AgendaSeries` for which the `uuid` must be unique.",
"format": "uuid",
"nullable": true
},
"groupUuid": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"description": "Short summary of the event, like a subject or title",
"nullable": true
},
"comment": {
"type": "string",
"description": "Longer description of the event, like notes",
"nullable": true,
"example": ""
},
"timelineId": {
"type": "integer",
"description": "Identifier of the `AgendaSeries`\n\nExceptions to the series have the same `timelineId` as the series.",
"format": "int32",
"nullable": true
},
"validFrom": {
"type": "string",
"description": "Start date of the appointment series",
"format": "date",
"nullable": true
},
"validTo": {
"type": "string",
"description": "Recurrence end date\n\nIf recurring, the event is recurring up to this date (exclusive)",
"format": "date",
"nullable": true
},
"startTime": {
"type": "string",
"description": "Start time of this occurrence",
"format": "time",
"nullable": true
},
"endTime": {
"type": "string",
"description": "End time of this occurrence",
"format": "time",
"nullable": true
},
"startsAt": {
"type": "string",
"description": "Start datetime of this occurrence.\nIt is currently readonly, but it's recommended to include the field;\ncurrent: When creating or updating an AgendaOccurrence the start_time and end_time fields are used by Ons Agenda.\nThe starts_at and ends_at fields will be deprecated.\nfuture: When creating or updating an AgendaOccurrence the starts_at and ends_at fields are used by Ons Agenda.\nThe start_time and end_time fields will be ignored and eventually be removed.",
"format": "date-time"
},
"endsAt": {
"type": "string",
"description": "End datetime of this occurrence.\nIt is currently readonly, but it's recommended to include the field;\ncurrent: When creating or updating an AgendaOccurrence the start_time and end_time fields are used by Ons Agenda.\nThe starts_at and ends_at fields will be deprecated.\nfuture: When creating or updating an AgendaOccurrence the starts_at and ends_at fields are used by Ons Agenda.\nThe start_time and end_time fields will be ignored and eventually be removed.",
"format": "date-time"
},
"duration": {
"type": "integer",
"description": "Duration in seconds. Read-only.",
"format": "int32",
"default": 0,
"nullable": true
},
"recurrenceType": {
"allOf": [
{
"$ref": "#/components/schemas/RecurrenceType"
}
],
"description": "Frequency of the recurrence"
},
"cycleInterval": {
"type": "integer",
"description": "Interval length of the series\n\nFor a recurrenceType of `monthly`, an interval of `2` means this event happens every 2 months.",
"format": "int32",
"default": 0,
"nullable": true,
"example": 1
},
"customLocation": {
"type": "string",
"nullable": true
},
"registered": {
"type": "boolean",
"description": "Indication if any employee has registered the appointment",
"nullable": true
},
"registrationComplete": {
"type": "boolean",
"description": "Indication that all employees have registered the appointment",
"nullable": true
},
"creatorObjectId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"monday": {
"type": "boolean",
"description": "Weekly event occurs on monday",
"nullable": true
},
"tuesday": {
"type": "boolean",
"description": "Weekly event occurs on tuesday",
"nullable": true
},
"wednesday": {
"type": "boolean",
"description": "Weekly event occurs on wednesday",
"nullable": true
},
"thursday": {
"type": "boolean",
"description": "Weekly event occurs on thursday",
"nullable": true
},
"friday": {
"type": "boolean",
"description": "Weekly event occurs on friday",
"nullable": true
},
"saturday": {
"type": "boolean",
"description": "Weekly event occurs on saturday",
"nullable": true
},
"sunday": {
"type": "boolean",
"description": "Weekly event occurs on sunday",
"nullable": true
},
"hourTypeId": {
"type": "integer",
"description": "Identifier of HourType\n\nWhen using the per-client product selection (part of _uitgebreide workflow_), use the `hourTypeId` field in the client invitations instead",
"format": "int64",
"nullable": true
},
"clientPresent": {
"type": "boolean",
"description": "Whether the client is expected in this event"
},
"private": {
"type": "boolean",
"description": "Whether this event is private"
},
"agendaInvitations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/agenda.AgendaInvitation"
},
"description": "Clients, locations, teams or employees invited to this occurrence\n\nDoes not support clients when using per-client product selection (part of _uitgebreide workflow_). When per-client product selection is enabled, use `agendaClientInvitations` instead to invite clients."
},
"agendaClientInvitations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/agenda.AgendaClientInvitation"
},
"description": "Clients invited to this appointment\n\nWhen _not_ using per-client product selection (part of _uitgebreide workflow_) use `agendaInvitations` instead to invite clients."
},
"labels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/agenda.Label"
},
"nullable": true
}
},
"description": "Agenda series domain model used by Cupido system.",
"example": {
"id": "2@2012-08-02",
"occurrenceDate": "2012-08-02",
"uuid": "abca58ed-0138-4aec-87c6-5d391e98161b",
"groupUuid": "bbca58ed-0138-4aec-87c6-5d391e98161c",
"name": "fysio",
"comment": "no comment",
"timelineId": 12,
"validFrom": "2012-08-02",
"validTo": "2015-08-02",
"startTime": "08:10:00.000",
"endTime": "08:20:00.000",
"startsAt": "2022-08-02T08:10:00.000+02:00",
"endsAt": "2022-08-02T08:20:00.000+02:00",
"duration": 1600,
"recurrenceType": "single",
"cycleInterval": 1,
"customLocation": "Gemeentehuis",
"registered": false,
"registrationComplete": false,
"creatorObjectId": 42,
"monday": true,
"tuesday": false,
"wednesday": true,
"thursday": true,
"friday": false,
"saturday": true,
"sunday": false,
"agendaInvitations": [
{
"employeeId": 4,
"accepted": true
},
{
"employeeId": 5,
"accepted": true
},
{
"teamId": 42,
"accepted": true
},
{
"locationId": 12,
"accepted": true
},
{
"groupId": 12
}
],
"agendaClientInvitations": [
{
"clientId": 1,
"accepted": true,
"hourTypeId": 52,
"careOrderId": 2
}
],
"hourTypeId": 42,
"clientPresent": true,
"private": false,
"labels": []
}
},
"agenda.AgendaInvitation": {
"title": "Invitation",
"type": "object",
"properties": {
"clientId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"locationId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"teamId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"accepted": {
"type": "boolean",
"nullable": true
},
"groupId": {
"type": "integer",
"format": "int64"
}
},
"description": "Agenda invitation domain model used by Cupido system.",
"example": {
"clientId": 1,
"employeeId": 2,
"locationId": 4,
"teamId": 3,
"groupId": 12,
"accepted": true
}
},
"agenda.AgendaClientInvitation": {
"title": "ClientInvitation",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/agenda.AgendaInvitation"
}
],
"properties": {
"hourTypeId": {
"type": "integer",
"description": "Identifier of Hour Type\n\nWhen _not_ using the per-client product selection (part of _uitgebreide workflow_), use the `hourTypeId` field in the appointment instead",
"format": "int64",
"nullable": true
},
"careOrderId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"surchargeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
},
"description": "Agenda client invitation domain model used by Cupido system.",
"example": {
"clientId": 1,
"employeeId": 2,
"locationId": 4,
"teamId": 3,
"groupId": 12,
"accepted": true,
"hourTypeId": 52,
"careOrderId": 2,
"surchargeIds": [
9,
10
]
}
},
"agenda.Label": {
"title": "Label",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"name": {
"type": "string"
}
},
"description": "Domain model for Labels for AgendaOccurrences/AgendaSeries",
"example": {
"id": 1,
"name": "Telefonisch"
}
},
"RecurrenceType": {
"title": "RecurrenceType",
"type": "string",
"oneOf": [
{
"title": "SINGLE",
"enum": [
"single"
]
},
{
"title": "DAILY",
"enum": [
"daily"
]
},
{
"title": "WEEKLY",
"enum": [
"weekly"
]
},
{
"title": "MONTHLY_ON_DAY",
"enum": [
"monthly_on_day"
]
},
{
"title": "MONTHLY_ON_WEEK",
"enum": [
"monthly_on_week"
]
},
{
"title": "YEARLY",
"enum": [
"yearly"
]
}
],
"description": "Frequency of the recurrence",
"default": "single",
"nullable": true,
"example": "single"
},
"agenda.AgendaSeries": {
"title": "EventSeries",
"required": [
"validFrom",
"startTime",
"endTime"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Identifier of this `AgendaSeries`",
"format": "int64",
"nullable": true,
"x-cupido-id": true
},
"timelineId": {
"type": "integer",
"description": "Identifier of the `AgendaSeries`\n\nExceptions to the series have the same `timelineId` as the series.",
"format": "int64",
"nullable": true
},
"uuid": {
"type": "string",
"description": "External reference for AgendaSeries. Optional field. If not needed it is adviced to exclude this; in that\ncase it will be auto-generated. If it is needed, i.e. for own bookkeeping purposes, it must be an unique\nvalue within AgendaSeries and should follow pattern described by \nhttps://dev.mysql.com/doc/refman/8.0/en/miscellaneous-functions.html#function_is-uuid\n",
"format": "uuid",
"nullable": true
},
"groupUuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"type": "string",
"description": "Short summary of the event",
"nullable": true
},
"comment": {
"type": "string",
"description": "Longer description of the event, notes",
"nullable": true
},
"hourTypeId": {
"type": "integer",
"description": "Identifier of HourType\n\nWhen using the per-client product selection (part of _uitgebreide workflow_), use the `hourTypeId` field in the client invitation instead",
"format": "int64",
"nullable": true
},
"validFrom": {
"type": "string",
"description": "Start date of the appointment series",
"format": "date",
"nullable": true
},
"validTo": {
"type": "string",
"description": "Recurrence end date\n\nIf recurring, the event is recurring up to this date (exclusive)",
"format": "date",
"nullable": true
},
"startTime": {
"type": "string",
"description": "Start time of the event",
"format": "time",
"nullable": true
},
"endTime": {
"type": "string",
"description": "End time of the event",
"format": "time",
"nullable": true
},
"duration": {
"type": "integer",
"description": "Duration in seconds",
"format": "int32",
"default": 0,
"nullable": true
},
"recurrenceType": {
"allOf": [
{
"$ref": "#/components/schemas/RecurrenceType"
}
],
"description": "Frequency of the recurrence"
},
"cycleInterval": {
"type": "integer",
"description": "Interval length of the series\n\nFor a recurrenceType of `weekly`, an interval of `2`\nmeans this event happens every 2 weeks.",
"format": "int32",
"default": 0,
"nullable": true,
"example": 1
},
"cycleBase": {
"type": "string",
"description": "Start date of the recurrence, should be equal to `validFrom`",
"format": "date",
"nullable": true
},
"customLocation": {
"type": "string",
"nullable": true
},
"creatorObjectId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"monday": {
"type": "boolean",
"description": "Weekly event occurs on monday",
"nullable": true
},
"tuesday": {
"type": "boolean",
"description": "Weekly event occurs on tuesday",
"nullable": true
},
"wednesday": {
"type": "boolean",
"description": "Weekly event occurs on wednesday",
"nullable": true
},
"thursday": {
"type": "boolean",
"description": "Weekly event occurs on thursday",
"nullable": true
},
"friday": {
"type": "boolean",
"description": "Weekly event occurs on friday",
"nullable": true
},
"saturday": {
"type": "boolean",
"description": "Weekly event occurs on saturday",
"nullable": true
},
"sunday": {
"type": "boolean",
"description": "Weekly event occurs on sunday",
"nullable": true
},
"clientPresent": {
"type": "boolean",
"description": "Whether the client is expected in this event",
"nullable": true
},
"travelTimeBefore": {
"maximum": 1440,
"minimum": 0,
"type": "integer",
"description": "Travel time (in minutes) prior to the event.\n\nThis number must be between 0 and 1440 (range is inclusive). The Agenda setting 'show travel time' must be\nenabled, supplying this field when the setting is disabled will yield an error. When the setting is enabled\nand the field is not supplied, the value will default to 0.",
"format": "int64"
},
"travelTimeAfter": {
"type": "integer",
"description": "Travel time (in minutes) following the event.\n\nThis number must be between 0 and 1440 (range is inclusive). The Agenda setting 'show travel time' must be\nenabled, supplying this field when the setting is disabled will yield an error. When the setting is enabled\nand the field is not supplied, the value will default to 0.",
"format": "int64"
},
"agendaInvitations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/agenda.AgendaInvitation"
},
"description": "Clients, locations, teams or employees invited to this appointment\n\nDoes not support clients when using per-client product selection (part of _uitgebreide workflow_). When per-client product selection is enabled, use `agendaClientInvitations` instead to invite clients.",
"nullable": true
},
"agendaClientInvitations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/agenda.AgendaClientInvitation"
},
"description": "Clients invited to this occurrence\n\nWhen _not_ using per-client product selection (part of _uitgebreide workflow_) use `agendaInvitations` instead to invite clients.",
"nullable": true
},
"labels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/agenda.Label"
},
"nullable": true
}
},
"description": "Agenda series domain model used by Cupido system.",
"example": {
"id": 2,
"timelineId": 1,
"uuid": "abca58ed-0138-4aec-87c6-5d391e98161b",
"groupUuid": "bbca58ed-0138-4aec-87c6-5d391e98161c",
"name": "fysio",
"comment": "no comment",
"hourTypeId": 42,
"validFrom": "2012-08-02",
"validTo": "2012-09-02",
"startTime": "08:10:00.000",
"endTime": "08:20:00.000",
"duration": 600,
"recurrenceType": "single",
"cycleInterval": 1,
"cycleBase": "2012-08-02",
"customLocation": "Gemeentehuis",
"agendaInvitations": [
{
"clientId": 1,
"employeeId": 2,
"locationId": 4,
"teamId": 3,
"accepted": true,
"groupId": 12
}
],
"agendaClientInvitations": [
{
"clientId": 1,
"employeeId": 2,
"locationId": 4,
"teamId": 3,
"accepted": true,
"hourTypeId": 52,
"careOrderId": 2,
"surchargeIds": [
9,
10
]
}
],
"creatorObjectId": 1,
"monday": true,
"tuesday": false,
"wednesday": true,
"thursday": true,
"friday": false,
"saturday": true,
"sunday": false,
"clientPresent": true,
"travelTimeBefore": 15,
"travelTimeAfter": 35,
"labels": []
}
},
"agenda.ReservationCreate": {
"title": "ReservationCreate",
"required": [
"employeeId",
"startsAt",
"endsAt"
],
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"description": "Id of the employee for which the reservation is created.",
"format": "int64"
},
"startsAt": {
"type": "string",
"description": "Start moment of the reservation. Must be on the same day as endsAt and supplied in the Europe/Amsterdam time zone.",
"format": "date-time"
},
"endsAt": {
"type": "string",
"description": "End moment (exclusive) of the reservation. Must be after startsAt, on the same day, and supplied in the Europe/Amsterdam time zone.",
"format": "date-time"
},
"labelIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Ids of the labels to assign to this reservation."
},
"recurrenceRule": {
"$ref": "#/components/schemas/agenda.RecurrenceRule"
}
},
"description": "Request body used to create a reservation. When a recurrenceRule is supplied, startsAt must be on or before its repeatUntil.",
"example": {
"employeeId": 1,
"startsAt": "2025-06-05T08:10:00.000+02:00",
"endsAt": "2025-06-05T08:20:00.000+02:00",
"labelIds": [
1
],
"recurrenceRule": {
"recurrenceType": "weekly",
"interval": 1,
"weekdays": [
1,
3
],
"repeatUntil": "2025-08-02"
}
}
},
"agenda.RecurrenceRule": {
"title": "AgendaRecurrenceRule",
"required": [
"recurrenceType"
],
"type": "object",
"properties": {
"recurrenceType": {
"$ref": "#/components/schemas/agenda.RecurrenceType"
},
"interval": {
"minimum": 1,
"type": "integer",
"description": "Must be >= 1. The interval used in calculating the occurrences. The recurrence rule specifies when an\noccurrence might occur. Then the 'interval' is used to determine which of these occurrences actually occurs.\nA value of 1 means that every occurrence occurs, a value of 2 means that every other occurrence occurs, etc.",
"format": "int64",
"default": 1
},
"weekdays": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "An array containing all days of the week the occurrence should occur. Is only used when the recurrence rule\n'weekly' is selected. Defaults to the `startDate` day integer of the parent event when omitted or null.\nDays of the week are represented as follows:\n * 1: Monday\n * 2: Tuesday\n * 3: Wednesday\n * 4: Thursday\n * 5: Friday\n * 6: Saturday\n * 7: Sunday"
},
"repeatUntil": {
"type": "string",
"description": "Last day on which an occurrence may start (inclusive). When omitted or null, recurs indefinitely.",
"format": "date"
}
},
"description": "Object describing the recurrence. This object may be omitted, in that case a single occurrence is created",
"nullable": true,
"example": {
"recurrenceType": "weekly",
"interval": 1,
"weekdays": [
1,
3
],
"repeatUntil": "2015-08-02"
}
},
"agenda.RecurrenceType": {
"enum": [
"single",
"daily",
"weekly",
"monthly_on_day",
"monthly_on_week",
"yearly"
],
"type": "string",
"description": "When no value is supplied, it defaults to single. Specifies the recurrence rule:\n\n* single: The entry only occurs a single time, no recurrence is used.\n* daily: The entry occurs every day.\n* weekly: The entry occurs every week on the days supplied in the 'weekdays' field.\n* monthly_on_day: The entry occurs every month on the given date. I.e. on the 10th every month.\n* monthly_on_week: The entry occurs every month on the same day of the month. I.e. on the\nfirst Tuesday every month.\n* yearly: The entry occurs every year on the given date.",
"default": "single",
"example": "single"
},
"agenda.ReservationUpdate": {
"title": "ReservationUpdate",
"type": "object",
"properties": {
"startsAt": {
"type": "string",
"description": "Start moment of the reservation. When supplied, must be on the same day as endsAt and in the Europe/Amsterdam time zone.",
"format": "date-time"
},
"endsAt": {
"type": "string",
"description": "End moment (exclusive) of the reservation. When supplied, must be after startsAt, on the same day, and in the Europe/Amsterdam time zone.",
"format": "date-time"
},
"labelIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Ids of the labels to assign to this reservation."
},
"recurrenceRule": {
"$ref": "#/components/schemas/agenda.RecurrenceRule"
}
},
"description": "Request body used to update a reservation. All fields are optional; when a recurrenceRule is supplied, startsAt must be on or before its repeatUntil.",
"example": {
"startsAt": "2025-06-05T08:10:00.000+02:00",
"endsAt": "2025-06-05T08:20:00.000+02:00",
"labelIds": [
1
],
"recurrenceRule": {
"recurrenceType": "weekly",
"interval": 1,
"weekdays": [
1,
3
],
"repeatUntil": "2025-08-02"
}
}
},
"agenda.Unavailability": {
"title": "Unavailability",
"required": [
"title",
"employeeId",
"startDate"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Identifier of this `Unavailability`. Only used when updating an existing model.",
"format": "int64",
"x-cupido-id": true
},
"title": {
"type": "string",
"description": "Title of the unavailability. Max 140 characters allowed."
},
"employeeId": {
"type": "integer",
"description": "Id of the employee for which the unavailability is created",
"format": "int64"
},
"startDate": {
"type": "string",
"description": "The day on which the unavailability occurs. If a recurrence rule is supplied, then the date represents the\nday of the first occurrence. In combination with the time fields, this is used as base for calculating the\nother occurrences. May only be allowed to be created X weeks in the future depending on 'Fixed Weeks' setting of Agenda",
"format": "date"
},
"startTime": {
"type": "string",
"description": "The time the unavailability starts. When both startTime and endTime are omitted or null, an unavailability\nspanning the entire day will be created. Rounded down to the nearest whole minute.",
"format": "time",
"nullable": true
},
"endTime": {
"type": "string",
"description": "The time the unavailability ends. When both startTime and endTime are omitted or null, an unavailability\nspanning the entire day will be created. Rounded down to the nearest whole minute.",
"format": "time",
"nullable": true
},
"recurrenceRule": {
"$ref": "#/components/schemas/agenda.RecurrenceRule"
}
},
"description": "Domain model for the Agenda Unavailabilities",
"example": {
"id": 1,
"title": "Away",
"employeeId": 1,
"startDate": "2022-01-01",
"startTime": "08:00:00.000",
"endTime": "18:00:00.000",
"recurrenceRule": {
"recurrenceType": "single",
"interval": 1,
"weekdays": [],
"repeatUntil": "2022-01-01"
}
}
},
"authorization.provisioning.User": {
"type": "object",
"properties": {
"userUuid": {
"type": "string",
"x-cupido-id": true
},
"source": {
"type": "string"
},
"duties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/authorization.provisioning.Duty"
}
},
"defaultScopedDuties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/authorization.provisioning.Duty"
}
},
"roleScopedDuties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/authorization.provisioning.Duty"
}
}
},
"description": "User model (no description)",
"example": {
"userUuid": "1b9243a9-83b5-4edf-ab93-507f88fdcb01",
"source": "Koppelingnaam",
"duties": [
{
"roleUuid": "ea9e0f20-2232-4087-9a43-8f894e79b6f0",
"locationIds": [
1,
2,
3
],
"teamIds": [
4,
5,
6
],
"myself": true,
"allEmployees": true,
"myPlanning": true,
"myRoster": true,
"clientEmployeeRelationTypeIds": [
7,
8,
9
]
}
],
"defaultScopedDuties": [
{
"roleUuid": "ea9e0f20-2232-4087-9a43-8f894e79b6f0"
}
],
"roleScopedDuties": [
{
"roleUuid": "ea9e0f20-2232-4087-9a43-8f894e79b6f0"
}
]
}
},
"authorization.provisioning.Duty": {
"type": "object",
"properties": {
"roleUuid": {
"type": "string"
},
"validFrom": {
"type": "string",
"format": "date-time"
},
"validTo": {
"type": "string",
"format": "date-time"
},
"locationIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"teamIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"myself": {
"type": "boolean"
},
"allEmployees": {
"type": "boolean"
},
"allClients": {
"type": "boolean"
},
"myPlanning": {
"type": "boolean"
},
"myRoster": {
"type": "boolean"
},
"employeesOnMyRoster": {
"type": "boolean"
},
"clientEmployeeRelationTypeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
"description": "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 be accessible in the context of that role.",
"example": {
"roleUuid": "ea9e0f20-2232-4087-9a43-8f894e79b6f0",
"validFrom": "2018-03-01T00:00:00.000+01:00",
"validTo": "2019-03-01T00:00:00.000+01:00",
"locationIds": [
1,
2,
3
],
"teamIds": [
4,
5,
6
],
"myself": true,
"allEmployees": true,
"allClients": false,
"myPlanning": true,
"myRoster": true,
"employeesOnMyRoster": true,
"clientEmployeeRelationTypeIds": [
7,
8,
9
]
}
},
"authorization.provisioning.UserDuties": {
"type": "object",
"properties": {
"userUuid": {
"type": "string",
"x-cupido-id": true
},
"source": {
"type": "string"
},
"duties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/authorization.provisioning.UserDuty"
}
}
},
"description": "",
"example": {
"userUuid": "1b9243a9-83b5-4edf-ab93-507f88fdcb01",
"source": "Koppelingnaam",
"duties": [
{
"roleUuid": "ea9e0f20-2232-4087-9a43-8f894e79b6f0",
"validFrom": "2018-03-01T00:00:00.000+01:00",
"validTo": "2019-03-01T00:00:00.000+01:00",
"locationIds": [
1,
2,
3
],
"teamIds": [
4,
5,
6
],
"myself": true,
"allEmployees": true,
"allClients": false,
"myPlanning": true,
"myRoster": true,
"myAgendaClients": true,
"myTeams": true,
"myLocations": true,
"roleScope": true,
"employeesOnMyRoster": true,
"clientEmployeeRelationTypeIds": [
7,
8,
9
]
}
]
}
},
"authorization.provisioning.UserDuty": {
"type": "object",
"properties": {
"roleUuid": {
"type": "string"
},
"validFrom": {
"type": "string",
"format": "date-time"
},
"validTo": {
"type": "string",
"format": "date-time"
},
"locationIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"teamIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"myself": {
"type": "boolean"
},
"allEmployees": {
"type": "boolean"
},
"allClients": {
"type": "boolean"
},
"myPlanning": {
"type": "boolean"
},
"myRoster": {
"type": "boolean"
},
"myAgendaClients": {
"type": "boolean"
},
"myTeams": {
"type": "boolean"
},
"myLocations": {
"type": "boolean"
},
"roleScope": {
"type": "boolean"
},
"employeesOnMyRoster": {
"type": "boolean"
},
"clientEmployeeRelationTypeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
"description": "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 be accessible in the context of that role.\n Options myTeams, myLocations, and roleScope are only available within the pilot for the new scoping system.",
"example": {
"roleUuid": "ea9e0f20-2232-4087-9a43-8f894e79b6f0",
"validFrom": "2018-03-01T00:00:00.000+01:00",
"validTo": "2019-03-01T00:00:00.000+01:00",
"locationIds": [
1,
2,
3
],
"teamIds": [
4,
5,
6
],
"myself": true,
"allEmployees": true,
"allClients": false,
"myPlanning": true,
"myRoster": true,
"myAgendaClients": true,
"myTeams": true,
"myLocations": true,
"roleScope": true,
"employeesOnMyRoster": true,
"clientEmployeeRelationTypeIds": [
7,
8,
9
]
}
},
"authorization.provisioning.MyLocations": {
"type": "object",
"properties": {
"locationIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
"description": "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 are accessible. To assign roles with this scoping rule set the `myLocations` flag in `Duty` model.",
"example": {
"locationIds": [
1,
2,
3
]
}
},
"authorization.provisioning.MyTeams": {
"type": "object",
"properties": {
"teamIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
"description": "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 accessible. To assign roles with this scoping rule set the `myTeams` flag in `Duty` model.",
"example": {
"teamIds": [
1,
2,
3
]
}
},
"authorization.provisioning.UserScopeSettings": {
"type": "object",
"properties": {
"legacyAuthScopingOptions": {
"$ref": "#/components/schemas/authorization.provisioning.UserLegacyAuthScopingOptions"
}
},
"description": "",
"example": {
"legacyAuthScopingOptions": {
"myself": true,
"allEmployees": true,
"allClients": true
}
}
},
"authorization.provisioning.UserLegacyAuthScopingOptions": {
"type": "object",
"properties": {
"myself": {
"type": "boolean"
},
"allEmployees": {
"type": "boolean"
},
"allClients": {
"type": "boolean"
}
},
"description": "",
"example": {
"myself": true,
"allEmployees": true,
"allClients": true
}
},
"authorization.provisioning.DefaultScope": {
"type": "object",
"properties": {
"userUuid": {
"type": "string",
"x-cupido-id": true
},
"locationIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"teamIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"myself": {
"type": "boolean"
},
"allEmployees": {
"type": "boolean"
},
"allClients": {
"type": "boolean"
}
},
"description": "The default scope is a set of groups which can be used by role assignments to describe for which clients or employees are accessible.\nTo assign roles with the default scope through provisioning set the `defaultScopedDuties` in the `User` model.",
"example": {
"userUuid": "1b9243a9-83b5-4edf-ab93-507f88fdcb01",
"locationIds": [
1,
2,
3
],
"teamIds": [
4,
5,
6
],
"myself": true,
"allEmployees": true,
"allClients": false
}
},
"kamino.KaminoSetting": {
"type": "object",
"properties": {
"notifyForTeamMessages": {
"type": "boolean",
"nullable": true,
"xml": {
"name": "notifyForTeamMessages"
}
}
},
"description": "KaminoSetting model (no description)",
"example": {
"notifyForTeamMessages": true
},
"xml": {
"name": "kaminoSetting"
}
},
"caretech.OrderStatus": {
"enum": [
"OPEN",
"DECLINED",
"ACCEPTED",
"COMPLETED"
],
"type": "string",
"description": "The status of an order, can be OPEN, DECLINED, ACCEPTED or COMPLETED",
"example": "OPEN"
},
"caretech.OrderStatusUpdate": {
"required": [
"accepted"
],
"type": "object",
"properties": {
"accepted": {
"type": "boolean"
},
"deviceIdentificationNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"orderNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"supplierNote": {
"maxLength": 140,
"minLength": 0,
"type": "string"
},
"trackingUrl": {
"maxLength": 255,
"minLength": 0,
"type": "string"
}
},
"description": "Object for updating a set of fields related to a caretech Order",
"example": {
"accepted": true,
"deviceIdentificationNumber": "DEV0123456",
"orderNumber": "ORD-0123456",
"supplierNote": "The device will be delivered by PostNL (see tracking url)",
"trackingUrl": "www.postnl.nl/some-tracking-url/ORD-0123456"
}
},
"caretech.ProductAllocation": {
"required": [
"clientId",
"productInstance"
],
"type": "object",
"properties": {
"clientId": {
"type": "integer",
"format": "int64"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"employeeUuid": {
"type": "string",
"format": "uuid"
},
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"productInstance": {
"$ref": "#/components/schemas/caretech.ProductInstanceDto"
},
"requestDate": {
"type": "string",
"format": "date"
},
"startDate": {
"type": "string",
"format": "date"
},
"stopDate": {
"type": "string",
"format": "date"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/caretech.Status"
}
],
"description": "The status of a product allocation, can be REQUEST, ACTIVE, INACTIVE or UNKNOWN"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"uuid": {
"type": "string",
"format": "uuid"
}
},
"description": "Caretech product which is allocated by a client",
"example": {
"clientId": 1,
"createdAt": "2017-10-02T21:10:43.000+02:00",
"employeeUuid": "042f53df-37e5-4ad7-af77-16a212763bba",
"id": 4,
"productInstance": {
"createdAt": "2017-10-02T21:10:43.000+02:00",
"externalId": "serial-12345678",
"id": 56,
"product": {
"createdAt": "2017-10-02T21:10:43.000+02:00",
"id": 1,
"manufacturer": "Nedap",
"name": "Nedap Luna",
"updatedAt": "2017-10-02T21:10:43.000+02:00",
"uuid": "042f53df-37e5-4ad7-af77-16a212763bba"
},
"updatedAt": "2017-10-02T21:10:43.000+02:00",
"uuid": "042f53df-37e5-4ad7-af77-16a212763bba"
},
"requestDate": "2024-03-10",
"startDate": "2024-03-11",
"stopDate": "2024-03-12",
"status": "INACTIVE",
"updatedAt": "2017-10-02T21:10:43.000+02:00",
"uuid": "042f53df-37e5-4ad7-af77-16a212763bba"
},
"xml": {
"name": "productAllocation"
}
},
"caretech.ProductInstanceDto": {
"required": [
"product"
],
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time"
},
"externalId": {
"pattern": "^([A-Za-z0-9_., -]{1,50})$",
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
},
"product": {
"$ref": "#/components/schemas/caretech.ProductDto"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"uuid": {
"type": "string",
"format": "uuid"
}
},
"description": "Reference to a caretech product instance",
"example": {
"createdAt": "2017-10-02T21:10:43.000+02:00",
"externalId": "serial-12345678",
"id": 56,
"product": {
"createdAt": "2017-10-02T21:10:43.000+02:00",
"id": 1,
"manufacturer": "Nedap",
"name": "Nedap Luna",
"updatedAt": "2017-10-02T21:10:43.000+02:00",
"uuid": "042f53df-37e5-4ad7-af77-16a212763bba"
},
"updatedAt": "2017-10-02T21:10:43.000+02:00",
"uuid": "042f53df-37e5-4ad7-af77-16a212763bba"
},
"xml": {
"name": "productInstanceDto"
}
},
"caretech.ProductDto": {
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "integer",
"format": "int64"
},
"manufacturer": {
"type": "string"
},
"name": {
"type": "string"
},
"orderable": {
"type": "boolean"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"uuid": {
"type": "string",
"format": "uuid"
},
"startDate": {
"type": "string",
"format": "date"
},
"stopDate": {
"type": "string",
"format": "date"
}
},
"description": "Caretech product",
"example": {
"createdAt": "2017-10-02T21:10:43.000+02:00",
"id": 1,
"manufacturer": "Nedap",
"name": "Nedap Luna",
"orderable": false,
"updatedAt": "2017-10-02T21:10:43.000+02:00",
"uuid": "042f53df-37e5-4ad7-af77-16a212763bba",
"startDate": "2024-01-02",
"stopDate": "2024-04-17"
},
"xml": {
"name": "productDto"
}
},
"caretech.Status": {
"enum": [
"REQUEST",
"ACTIVE",
"INACTIVE",
"UNKNOWN"
],
"type": "string",
"description": "The status of a product allocation, can be REQUEST, ACTIVE, INACTIVE or UNKNOWN",
"example": "ACTIVE"
},
"caretech.ReturnRequestStatus": {
"enum": [
"OPEN",
"DECLINED",
"ACCEPTED",
"COMPLETED"
],
"type": "string",
"description": "The status of a return request, can be OPEN, DECLINED, ACCEPTED or COMPLETED",
"example": "OPEN"
},
"caretech.ReturnRequestUpdate": {
"required": [
"requestStatusUpdate"
],
"type": "object",
"properties": {
"requestStatusUpdate": {
"$ref": "#/components/schemas/caretech.ReturnRequestStatusUpdate"
},
"returnNumber": {
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"supplierNote": {
"maxLength": 140,
"minLength": 0,
"type": "string"
},
"trackingUrl": {
"maxLength": 1024,
"minLength": 0,
"type": "string"
}
},
"description": "ReturnRequestUpdate model (no description)",
"example": {
"requestStatusUpdate": "DECLINED",
"returnNumber": "1234",
"supplierNote": "Device is incomplete",
"trackingUrl": "https://post.nl?trackingNumber=6318638"
}
},
"caretech.ReturnRequestStatusUpdate": {
"enum": [
"DECLINED",
"ACCEPTED",
"COMPLETED"
],
"type": "string",
"description": "The status update of a return request, can be DECLINED, ACCEPTED or COMPLETED",
"example": "ACCEPTED"
},
"client_story.Story": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/client_story.Category"
},
"description": "A list of categories in this client story"
},
"accessLevel": {
"allOf": [
{
"$ref": "#/components/schemas/client_story.AccessLevel"
}
],
"description": "The access level of the story, can be NONE, READ_ONLY, or READ_WRITE"
},
"updatedAt": {
"type": "string",
"description": "When this story was last updated",
"format": "date-time"
},
"updatedSource": {
"type": "string",
"description": "The deployment that last updated this story"
},
"updatedBy": {
"type": "integer",
"description": "Who the story was last updated by",
"format": "int64"
}
},
"description": "Story model (no description)",
"example": {
"id": 1,
"categories": [
{
"id": 1,
"definition": "Interesses",
"description": "Interesses van de client",
"answers": [
{
"id": 1,
"schema": "{\"type\":\"object\",\"properties\":{\"/content[id3]/data[id4]/events[id5]/data[id6]/items[id65]/items[id2]\":{\"title\":\"Mijn favoriete gerecht is\",\"description\":\"\",\"type\":\"string\"}}}",
"data": "{\"/content[id3]/data[id4]/events[id5]/data[id6]/items[id65]/items[id2]\":\"Spare ribs\"}"
}
]
}
],
"accessLevel": "READ_ONLY",
"updatedAt": "2019-05-09T00:00:00.000+02:00",
"updatedSource": "CarenDeployment",
"updatedBy": 1
}
},
"client_story.Category": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"definition": {
"type": "string",
"description": "A short description of this category"
},
"description": {
"type": "string",
"description": "A longer description of this category"
},
"answers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/client_story.Answer"
},
"description": "A list of answers in this category"
}
},
"description": "Category model (no description)",
"example": {
"id": 1,
"definition": "Interesses",
"description": "Interesses van de client",
"answers": [
{
"id": 1,
"schema": "{\"type\":\"object\",\"properties\":{\"/content[id3]/data[id4]/events[id5]/data[id6]/items[id65]/items[id2]\":{\"title\":\"Mijn favoriete gerecht is\",\"description\":\"\",\"type\":\"string\"}}}",
"data": "{\"/content[id3]/data[id4]/events[id5]/data[id6]/items[id65]/items[id2]\":\"Spare ribs\"}"
}
]
}
},
"client_story.Answer": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"schema": {
"type": "string",
"description": "The JsonSchemaForm representation of this answer"
},
"data": {
"type": "string",
"description": "The JsonSchemaForm data for this answer"
}
},
"description": "Answer model (no description)",
"example": {
"id": 1,
"schema": "{\"type\":\"object\",\"properties\":{\"/content[id3]/data[id4]/events[id5]/data[id6]/items[id65]/items[id2]\":{\"title\":\"Mijn favoriete gerecht is\",\"description\":\"\",\"type\":\"string\"}}}",
"data": "{\"/content[id3]/data[id4]/events[id5]/data[id6]/items[id65]/items[id2]\":\"Spare ribs\"}"
}
},
"client_story.AccessLevel": {
"enum": [
"NONE",
"READ_ONLY",
"READ_WRITE"
],
"type": "string",
"description": "The access level of the story, can be NONE, READ_ONLY, or READ_WRITE",
"example": "NONE"
},
"dbc.ggz.Zorgtraject": {
"required": [
"clientId",
"begindatum"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"description": "Object identifier",
"format": "int64",
"x-cupido-id": true
},
"externalId": {
"type": "integer",
"description": "Identifier of care order",
"format": "int64"
},
"beschikkingExternalId": {
"type": "integer",
"description": "Only used for jeugd zorgtrajecten. Object identifier for the beschikking.",
"format": "int64"
},
"clientId": {
"type": "integer",
"description": "The object identifier of the Client.",
"format": "int64"
},
"verwijzingId": {
"type": "integer",
"description": "Unused",
"format": "int64"
},
"jeugd": {
"type": "boolean",
"description": "Whether this Zorgtraject concerns a jeugd (youth) traject.\nNew Zorgtrajecten may not set this to true.",
"deprecated": true,
"x-deprecated-since": "20-11-2023"
},
"privacyBezwaar": {
"type": "boolean",
"description": "Whether the client has signed a document which says for privacy reasons the client\ndata may not be exposed to external parties.",
"deprecated": true,
"x-deprecated-since": "20-11-2023"
},
"identificatienummer": {
"type": "string",
"description": "Filled automatically with a random identifier if left empty."
},
"begindatum": {
"type": "string",
"description": "Start date",
"format": "date"
},
"einddatum": {
"type": "string",
"description": "End date. Set automatically based on the state of the DBCs (Subtraject) contained in this zorgtraject.\nIf this value is null, the Zorgtraject is open. If non-null, it is closed.",
"format": "date"
},
"soortVerwijzer": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.SoortVerwijzer"
}
],
"description": "Soort verwijzer moved to subtraject",
"deprecated": true
},
"verwijzerAgb": {
"type": "string",
"description": "Verwijzer moved to subtraject",
"deprecated": true,
"x-deprecated-since": "23-09-2022"
},
"zorgdomein": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.Zorgdomein"
}
],
"description": "The zorgdomein as specified by the NZA code lists."
},
"uitvoerendeInstellingAgb": {
"type": "string",
"description": "Unused"
},
"primaireDiagnose": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.DiagnoseToekenning"
}
],
"description": "The primary diagnosis for the client"
},
"subtrajecten": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.Subtraject"
}
],
"xml": {
"name": "subtraject"
}
},
"description": "Subtrajecten (DBCs or DBBCs) contained in this Zorgtraject.",
"xml": {
"wrapped": true
}
},
"fzSubtrajecten": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.fz.Subtraject"
}
],
"xml": {
"name": "fzSubtraject"
}
},
"description": "Fz-Subtrajecten (DBBCs) contained in this Zorgtraject.",
"xml": {
"wrapped": true
}
}
},
"description": "The corresponding dbc.ggz.Zorgtraject,\nOnly filled in when possible, can be null",
"example": {
"updatedAt": "2016-08-18T00:00:00.000+02:00",
"createdAt": "2016-08-18T00:00:00.000+02:00",
"createdBy": "Administrator",
"id": 1,
"externalId": 1,
"beschikkingExternalId": 2,
"clientId": 1,
"verwijzingId": 1,
"jeugd": false,
"privacyBezwaar": true,
"identificatienummer": "1",
"begindatum": "2016-08-18",
"einddatum": "2016-08-18",
"soortVerwijzer": {
"id": 1,
"code": "01",
"begindatum": "2016-08-18",
"einddatum": "2016-08-18",
"omschrijving": "huisarts"
},
"verwijzerAgb": "12345678",
"zorgdomein": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example"
},
"uitvoerendeInstellingAgb": "04122827",
"primaireDiagnose": {
"id": 1,
"externalId": 1,
"primair": true,
"trekkenVan": true,
"datum": "2014-12-29",
"diagnoseAs": 1,
"diagnoseCode": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example",
"groepcode": "example",
"element": "example",
"zvzSubscore": 1,
"aanspraakType": "example",
"hierarchieniveau": 1,
"selecteerbaar": "example",
"sorteervolgorde": 1,
"diagnoseAs": 1,
"icd9cm": "example",
"icd10": "example",
"prestatieniveau": "example",
"prestatiecodeNaamgevingGGZ": "example",
"prestatiecodeNaamgevingFZ": "example",
"prestatiecodedeelGGZ": "example",
"prestatiecodedeelFZ": "example",
"parallelliteitscodeGGZ": "example",
"parallelliteitscodeFZ": "example",
"brancheIndicatie": "example"
},
"zorgtrajectId": 1
},
"subtrajecten": [
{
"updatedAt": "2016-08-18T00:00:00.000+02:00",
"createdAt": "2016-08-18T00:00:00.000+02:00",
"createdBy": "Administrator",
"id": 1,
"externalId": 1,
"externalProductToewijzingId": 2,
"identificatienummer": "997881",
"openingsdatum": "2016-08-18",
"sluitdatum": "2016-08-18",
"regiebehandelaar": "12345678",
"regiebehandelaarId": 1,
"medebehandelaar": "87654321",
"medebehandelaarId": 2,
"soortVerwijzer": {
"id": 1,
"code": "01",
"begindatum": "2016-08-18",
"einddatum": "2016-08-18",
"omschrijving": "huisarts"
},
"verwijzerAgb": "12345678",
"debiteurType": "CUSTOM",
"customDebtorId": 1,
"excludeInvoicing": false,
"latestGrouperResultaat": {
"updatedAt": "2016-08-16T00:00:00.000+02:00",
"createdAt": "2016-08-16T00:00:00.000+02:00",
"createdBy": "Administrator",
"id": 1,
"prestatiecode": "101010001230",
"declaratiecode": "25B019",
"productgroep": "00230",
"productGroep": {
"id": 5,
"code": "00230",
"codeBehandeling": "123123",
"omschrijvingBehandeling": "Behandeling",
"setting": "setting",
"categorie": "GEEN",
"lekenvertaling": "Behandeling voor problemen",
"diagnoseBlinderen": false,
"brancheIndicatie": "GGZ"
},
"timestamp": "2016-03-15T00:00:00.000+01:00"
},
"numberOfDirectMinutes": 30,
"numberOfIndirectMinutes": 40,
"numberOfTravelMinutes": 50,
"lastRegistrationDate": "2010-10-10T00:00:00.000+02:00",
"excludeInvoicingReason": "we do not want it anymore",
"invoiced": false
}
],
"fzSubtrajecten": [
{
"id": 1,
"externalId": 1,
"externalProductToewijzingId": 2,
"identificatienummer": "997881",
"openingsdatum": "2016-08-18",
"sluitdatum": "2016-08-18",
"regiebehandelaar": "12345678",
"regiebehandelaarId": 1,
"medebehandelaar": "87654321",
"medebehandelaarId": 2,
"soortVerwijzer": {
"id": 1,
"code": "01",
"begindatum": "2016-08-18",
"einddatum": "2016-08-18",
"omschrijving": "huisarts"
},
"verwijzerAgb": "12345678",
"debiteurType": "CUSTOM",
"customDebtorId": 1,
"excludeInvoicing": false,
"latestGrouperResultaat": {
"updatedAt": "2016-08-16T00:00:00.000+02:00",
"createdAt": "2016-08-16T00:00:00.000+02:00",
"createdBy": "Administrator",
"id": 1,
"prestatiecode": "101010001230",
"declaratiecode": "25B019",
"productgroep": "00230",
"productGroep": {
"id": 5,
"code": "00230",
"codeBehandeling": "123123",
"omschrijvingBehandeling": "Behandeling",
"setting": "setting",
"categorie": "GEEN",
"lekenvertaling": "Behandeling voor problemen",
"diagnoseBlinderen": false,
"brancheIndicatie": "GGZ"
},
"timestamp": "2016-03-15T00:00:00.000+01:00"
},
"numberOfDirectMinutes": 30,
"numberOfIndirectMinutes": 40,
"numberOfTravelMinutes": 50,
"lastRegistrationDate": "2010-10-10T00:00:00.000+02:00",
"excludeInvoicingReason": "we do not want it anymore",
"invoiced": false,
"updatedAt": "2016-08-18T00:00:00.000+02:00",
"createdAt": "2016-08-18T00:00:00.000+02:00",
"createdBy": "Administrator",
"plaatsingsbesluitnummer": "1234",
"strafrechtketennummer": "789789"
}
]
},
"xml": {
"name": "zorgtraject"
}
},
"dbc.ggz.SoortVerwijzer": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dbc.StamData"
}
],
"description": "The type of practitioner of this DBC\nPart of a code list of the NZA",
"example": {
"id": 1,
"code": "01",
"begindatum": "2016-08-18",
"einddatum": "2016-08-18",
"omschrijving": "huisarts"
}
},
"dbc.StamData": {
"required": [
"code"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Object identifier",
"format": "int64",
"x-cupido-id": true
},
"code": {
"type": "string",
"description": "The code taken from NZA code lists."
},
"begindatum": {
"type": "string",
"description": "The first date this value is valid at.",
"format": "date"
},
"einddatum": {
"type": "string",
"description": "The last date this value is valid at.\n\nMay be 9999-12-31 to signify 'valid forever'",
"format": "date"
},
"omschrijving": {
"type": "string",
"description": "A humanly readable description for the value, in Dutch"
}
},
"description": "Base class for a code list of the NZA.\nSee documentation at https://puc.overheid.nl/nza/zorgsectoren/pagina/NZA003b/-/gdlv/1/p/1/",
"example": {
"id": 1,
"code": "example",
"begindatum": "2014-12-29",
"einddatum": "2014-12-29",
"omschrijving": "example"
}
},
"dbc.ggz.Zorgdomein": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dbc.StamData"
}
],
"description": "The zorgdomein as specified by the NZA code lists.",
"example": {
"id": 1,
"code": "01",
"begindatum": "2000-01-01",
"einddatum": "9999-12-31",
"omschrijving": "Volwassenen EPA"
}
},
"dbc.ggz.DiagnoseToekenning": {
"required": [
"primair",
"datum"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Object identifier",
"format": "int64",
"x-cupido-id": true
},
"externalId": {
"type": "integer",
"description": "Link a diagnosetoekenning to the original dsm classification series in ons-dossier.",
"format": "int64"
},
"primair": {
"type": "boolean",
"description": "Indicate that this object is the primary part of a set.\nOne DSM classification can contain a list of DiagnoseToekenningen. Only one of them can be primary",
"deprecated": true,
"x-deprecated-since": "20-11-2023"
},
"trekkenVan": {
"type": "boolean",
"description": "To indicate that the client has 'signs of' a diagnosis.\nThis is used when the user is not sure of the diagnosis.",
"deprecated": true,
"x-deprecated-since": "20-11-2023"
},
"datum": {
"type": "string",
"description": "The date at which the diagnosis took place",
"format": "date"
},
"diagnoseAs": {
"type": "integer",
"description": "Possible values:\n1,2,3,4,5\n\nPossible values:\nunexpected\ncareplan\n
",
"nullable": true
},
"typeCompetent": {
"type": "boolean",
"description": "Optional whether the client is competent regarding the measures",
"nullable": true
},
"competentNarrative": {
"type": "string",
"description": "[WVGGZ] Optional whether the client is NOT competent, to explain why not"
},
"typeAgreement": {
"type": "boolean",
"description": "Deprecated since: 01-01-2020 - use restrictiveMeasureEntries.typeAgreement instead, this is now recorded on a per-measure basis there.",
"nullable": true,
"deprecated": true,
"x-deprecated-since": "01-01-2020"
},
"typeResistant": {
"type": "boolean",
"description": "Deprecated since: 01-01-2020 - use restrictiveMeasureEntries.typeResistant instead, this is now recorded on a per-measure basis there.",
"nullable": true,
"deprecated": true,
"x-deprecated-since": "01-01-2020"
},
"decisionNarrative": {
"type": "string",
"description": "Optional explanation on the type and situation decisions",
"nullable": true
},
"inspectionReportDate": {
"type": "string",
"description": "Optional date the Bopz-measures were reported to the inspection, does not apply after 01-01-2020",
"format": "date",
"nullable": true
},
"status": {
"type": "string",
"description": "The status of the entry\n\nPossible values:\n- draft\n- active\n- archived\n
",
"nullable": true
},
"problemNarrative": {
"type": "string",
"description": "Optional problem why this measure is needed or serious detriment that is being prevented",
"nullable": true
},
"goalNarrative": {
"type": "string",
"description": "Optional goal to achieve with these measures, no longer applies after 01-01-2020",
"nullable": true
},
"beginDate": {
"type": "string",
"description": "Optional start date of the measures",
"format": "date",
"nullable": true
},
"endDate": {
"type": "string",
"description": "Optional end date of the measures (the date the entry is archived)",
"format": "date",
"nullable": true
},
"nextEvaluationDate": {
"type": "string",
"description": "Optional date on which the measures need to be evaluated",
"format": "date",
"nullable": true
},
"risksNarrative": {
"type": "string",
"description": "Optional risks of applying the measures or any adverse effects applying these measures might have",
"nullable": true
},
"guaranteeNarrative": {
"type": "string",
"description": "Optional guarantee for behavioural approach",
"nullable": true
},
"reductionNarrative": {
"type": "string",
"description": "Optional description of the plan to reduce application of measures",
"nullable": true
},
"proportionality": {
"type": "string",
"description": "Optional proportionality of applying the measures",
"nullable": true
},
"subsidiarity": {
"type": "string",
"description": "Optional subsidiarity of applying the measures",
"nullable": true
},
"effectiveness": {
"type": "string",
"description": "Optional effectiveness of applying the measures",
"nullable": true
},
"secondOpinion": {
"type": "string",
"description": "Optional second opinion for the measures",
"nullable": true
},
"causeNarrative": {
"type": "string",
"description": "Optional direct / indirect cause for the clients behaviour that cases serious detriment",
"nullable": true
},
"oversightNarrative": {
"type": "string",
"description": "Optional way the caregiver will keep oversight of the measures",
"nullable": true
},
"law": {
"type": "integer",
"description": "Optional law that applies to these measures\n\nPossible values:\n- 0 (bopz)\n- 1 (wzd)\n- 2 (wvggz)\n- 3 (wzd_fz)\n
",
"format": "int32",
"nullable": true
},
"step": {
"type": "integer",
"description": "Optional if these measures follow the Wzd roadmap, the definitive step they are in.",
"format": "int32",
"nullable": true
},
"manualStep": {
"type": "integer",
"description": "Optional if these measures follow the Wzd roadmap, the override step put in by the user.",
"format": "int32",
"nullable": true
},
"immutable": {
"type": "boolean",
"description": "Optional if these measures are immutable, usually because they are inserted via APIs.",
"nullable": true
},
"nature": {
"type": "string",
"description": "Optional the nature of these measures whether they are\n\n- agreement_client\n- agreement_representative\n- emergency (also includes temporary measures)\n- involuntary\n- mixed_plan (it contains different types of measures)\n- unknown (not all the fields are filled in so it cannot be calculated)\n- voluntary_plan (voluntary according to plan: measures that follow Wzd road map)\n
",
"nullable": true
},
"reasonNarrative": {
"type": "string",
"description": "Optional description of the reason.",
"nullable": true
},
"researchDate": {
"type": "string",
"description": "Optional date of research.",
"format": "date",
"nullable": true
},
"safety": {
"type": "string",
"description": "Optional safety measures.",
"nullable": true
},
"reasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.RestrictiveMeasureCarePlanEntryReason"
},
"description": "Optional list of reasons.",
"nullable": true
},
"problemNarratives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.RestrictiveMeasureCarePlanEntryProblemNarrative"
},
"description": "List of problem narratives.",
"nullable": true
},
"gdConferDate": {
"type": "string",
"description": "Optionally the date on which care personnel conferred with the Geneesheer-Directeur\non the measures.",
"format": "date",
"nullable": true
},
"combinedConditions": {
"type": "string",
"description": "Optionally the field in which care personnel explain how the legal conditions for\nthese measures are met: proportionality, subsidiarity, effectiveness, safety.",
"nullable": true
},
"evaluationNote": {
"type": "string",
"description": "Optional note to an evaluation."
},
"consultedWithClient": {
"type": "boolean",
"description": "[WVGGZ] (Required when \"in careplan\", not when \"unforeseen\") To indicate if the client was consulted"
},
"followPreferences": {
"type": "boolean",
"description": "[WVGGZ] Optional whether the client's preferences with regard to mandatory care can be followed"
},
"followPreferencesNarrative": {
"type": "string",
"description": "[WVGGZ] Optional whether the client's preferences with regard to mandatory care can NOT be followed,\nto explain why not: describe the major risks and dangers."
},
"ambulatory": {
"type": "boolean",
"description": "(Optional for model, may be required by law) If the client is ambulatory"
},
"clientRepresentativeNarrative": {
"type": "string",
"description": "Opinion of the client representative"
},
"responsibleCaregiverNarrative": {
"type": "string",
"description": "Opinion of the responsible caregiver"
},
"alternateExpertiseNarrative": {
"type": "string",
"description": "Opinion of the alternate expertise"
},
"physicianNarrative": {
"type": "string",
"description": "Opinion of the physician"
},
"uninvolvedExpertiseNarrative": {
"type": "string",
"description": "Opinion of the uninvolved expertise"
},
"externalExpertiseNarrative": {
"type": "string",
"description": "Opinion of the external expertise"
},
"diligenceRequirements": {
"type": "string",
"description": "In this field user explain what requirements need to be taken related to diligence"
},
"judgementStatus": {
"type": "integer",
"description": "Deprecated since: 26-02-2026, Use the judgements-field instead.\nStatus of a judgement. 0 if rejected and 1 if approved.",
"deprecated": true,
"x-deprecated-since": "26-02-2026"
},
"judgementText": {
"type": "string",
"description": "Deprecated since: 26-02-2026, Use the judgements-field instead.\nExplanation of judgement",
"deprecated": true,
"x-deprecated-since": "26-02-2026"
},
"judgeUserId": {
"type": "integer",
"description": "Deprecated since: 26-02-2026, Use the judgements-field instead.\nUser-id of employee who added a judgement",
"format": "int64",
"deprecated": true,
"x-deprecated-since": "26-02-2026"
},
"judgementTime": {
"type": "string",
"description": "Deprecated since: 26-02-2026, Use the judgements-field instead.\nMoment of when judgement is added.",
"format": "date-time",
"deprecated": true,
"x-deprecated-since": "26-02-2026"
},
"clientRepresentativeName": {
"type": "string",
"description": "Name of the client's representative"
},
"responsibleCaregiverName": {
"type": "string",
"description": "Name of the responsible caregiver"
},
"alternateExpertiseName": {
"type": "string",
"description": "Name of the alternate expertise"
},
"physicianName": {
"type": "string",
"description": "Name of the physician"
},
"uninvolvedExpertiseName": {
"type": "string",
"description": "Name of the uninvolved expertise"
},
"externalExpertiseName": {
"type": "string",
"description": "Name of the external expertise"
},
"judgements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.RestrictiveMeasureCarePlanEntryJudgement"
},
"description": "Optional list of judgements.",
"nullable": true
}
},
"description": "RestrictiveMeasureCarePlanEntry model (no description)",
"example": {
"id": 1,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 2,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"restrictiveMeasureEntries": [
{
"id": 1,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 2,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"expertiseProfile": 3,
"frequency": "continual",
"frequencyNarrative": "All the time",
"frequencyUnit": 1,
"frequencyAmount": 2,
"durationAmount": 3,
"narrative": "RM entry narrative",
"snomedExpressionValue": "37953008 | bedrails |",
"typeAgreement": true,
"typeResistant": false,
"ordinal": 1,
"ambulatoryCaregivers": 4,
"fixedBeginTime": "20:50:00.000",
"fixedEndTime": "07:45:00.000",
"categoryCode": "wzd_medication",
"duration": "duration",
"instruction": "instruction"
}
],
"restrictiveMeasureEvaluations": [
{
"id": 1,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 2,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"evaluationText": "Evaluation text",
"evaluationDate": "2014-11-14"
}
],
"situation": "in careplan",
"typeCompetent": true,
"competentNarrative": "Competent narrative",
"typeAgreement": true,
"typeResistant": true,
"decisionNarrative": "Decision narrative",
"inspectionReportDate": "2015-09-17",
"status": "active",
"problemNarrative": "Problem narrative",
"goalNarrative": "Goal narrative",
"beginDate": "2015-09-17",
"endDate": "2015-09-17",
"nextEvaluationDate": "2015-09-17",
"risksNarrative": "Risks narrative",
"guaranteeNarrative": "Guarantee narrative",
"reductionNarrative": "Reduction narrative",
"proportionality": "Proportionality",
"subsidiarity": "Subsidiarity",
"effectiveness": "Effectiveness",
"secondOpinion": "Second opinion",
"causeNarrative": "Cause narrative",
"oversightNarrative": "Oversight narrative",
"law": 2,
"step": 4,
"manualStep": 4,
"immutable": false,
"nature": "emergency",
"reasonNarrative": "Reason narrative",
"researchDate": "2015-10-17",
"safety": "Safety",
"reasons": [
{
"id": 1,
"tag": "prevent_crisis"
}
],
"problemNarratives": [
{
"id": 1,
"tag": "general_safety"
}
],
"gdConferDate": "2015-10-16",
"combinedConditions": "Combined conditions",
"evaluationNote": "Evaluation note",
"consultedWithClient": true,
"followPreferences": true,
"followPreferencesNarrative": "Follow preferences narrative",
"ambulatory": true,
"clientRepresentativeNarrative": "Client representative narrative",
"responsibleCaregiverNarrative": "Responsible caregiver narrative",
"alternateExpertiseNarrative": "Alternate expertise narrative",
"physicianNarrative": "Physician narrative",
"uninvolvedExpertiseNarrative": "Uninvolved expertise narrative",
"externalExpertiseNarrative": "External expertise narrative",
"diligenceRequirements": "Diligence requirements",
"judgementStatus": 1,
"judgementText": "This is fine",
"judgeUserId": 11,
"judgementTime": "2014-11-14T00:00:00.000+01:00",
"clientRepresentativeName": "Client representative name",
"responsibleCaregiverName": "Responsible caregiver name",
"alternateExpertiseName": "Alternate expertise name",
"physicianName": "Physician name",
"uninvolvedExpertiseName": "Uninvolved expertise name",
"externalExpertiseName": "External expertise name",
"judgements": [
{
"id": 1,
"restrictiveMeasureCarePlanEntryId": 1,
"status": 1,
"text": "text",
"clientExternalId": 3,
"reviewerUserId": 4,
"reviewedAt": "2021-01-01T00:00:00.000+01:00",
"createdById": 5,
"updatedById": 6,
"createdAt": "2021-01-01T00:00:00.000+01:00",
"updatedAt": "2021-01-01T00:00:00.000+01:00"
}
]
}
},
"dossier.RestrictiveMeasureEntry": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.MedicalBase"
}
],
"properties": {
"expertiseProfile": {
"type": "integer",
"description": "Optional expertise profile that can apply the measure",
"format": "int64",
"nullable": true
},
"frequency": {
"type": "string",
"description": "Optional frequency the restrictive measure should be applied",
"nullable": true
},
"frequencyNarrative": {
"type": "string",
"description": "Optional explanation of the frequency",
"nullable": true
},
"frequencyUnit": {
"type": "integer",
"description": "Optional the unit of the frequency with this structural measure is applied.\n\nPossible values:\n- 0 daily\n- 1 weekly\n- 2 monthly\n- 3 yearly\n
",
"format": "int32"
},
"frequencyAmount": {
"type": "integer",
"description": "Optional the frequency with which this structural measure is applied.",
"format": "int32"
},
"durationAmount": {
"type": "integer",
"description": "The duration of the application of the structural measure application.",
"format": "int32"
},
"narrative": {
"type": "string",
"description": "Optional additional explanation for this restrictive measure",
"nullable": true
},
"snomedExpressionValue": {
"type": "string",
"description": "Optional snomed expression of the restrictive measure",
"nullable": true
},
"deviceBuilders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.DeviceBuilder"
},
"description": "Optional device builder to build the restrictive measure relation",
"nullable": true
},
"device": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.Device"
}
],
"description": "Optional device that was used as a restrictive measure"
},
"typeAgreement": {
"type": "boolean",
"description": "Optional whether a client or representative agrees with this measure",
"nullable": true
},
"typeResistant": {
"type": "boolean",
"description": "Optional whether a client resists this measure",
"nullable": true
},
"ordinal": {
"type": "integer",
"description": "Optional the ordinal number of this measure in a restrictive measure care plan entry",
"format": "int32",
"default": 0,
"nullable": true
},
"ambulatoryCaregivers": {
"type": "integer",
"description": "Optional if this measure is applied in an ambulatory situation: the minimum amount of caregivers that are required to apply this measure",
"format": "int32",
"nullable": true
},
"fixedBeginTime": {
"type": "string",
"description": "Optional if this measure is applied at fixed times: when the application of this measure should begin",
"format": "time",
"nullable": true
},
"fixedEndTime": {
"type": "string",
"description": "Optional if this measure is applied at fixed times: when the application of this measure should end",
"format": "time",
"nullable": true
},
"categoryCode": {
"type": "string",
"description": "The code of the category the measure belongs to",
"nullable": true
},
"duration": {
"type": "string",
"description": "Optional duration",
"nullable": true
},
"instruction": {
"type": "string",
"description": "Optional instruction (original usage)\nRepurposed to be a combined \"toelichting\" field\n(includes \"Proportionality\", \"Subsidiarity\", \"Effectiveness\", and possibly \"Safety\")",
"nullable": true
},
"applicable": {
"type": "boolean",
"description": "Optional whether the measure is applicable",
"nullable": true
}
},
"description": "RestrictiveMeasureEntry model (no description)",
"example": {
"id": 1,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 2,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"expertiseProfile": 3,
"frequency": "continual",
"frequencyNarrative": "All the time",
"frequencyUnit": 1,
"frequencyAmount": 2,
"durationAmount": 3,
"narrative": "RM entry narrative",
"snomedExpressionValue": "37953008 | bedrails |",
"deviceBuilders": [
{
"system": "example",
"query": "example",
"name": "example"
},
{
"system": "example",
"query": "example",
"name": "example"
}
],
"device": {
"id": 1,
"name": "Bedrails"
},
"typeAgreement": true,
"typeResistant": false,
"ordinal": 1,
"ambulatoryCaregivers": 4,
"fixedBeginTime": "20:50:00.000",
"fixedEndTime": "07:45:00.000",
"categoryCode": "wzd_medication",
"duration": "duration",
"instruction": "instruction",
"applicable": true
}
},
"dossier.medical.DeviceBuilder": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.RelationshipBuilder"
}
],
"description": "DeviceBuilder model (no description)",
"example": {
"system": "SNOMED",
"query": "37953008 | bedrails |",
"name": "Bedrails"
}
},
"dossier.medical.Device": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The unique ID of the device",
"format": "int64",
"nullable": true
},
"name": {
"type": "string",
"description": "The name of the device",
"nullable": true
}
},
"description": "Optional device that was used as a restrictive measure",
"nullable": true,
"example": {
"id": 1,
"name": "Bedrails"
}
},
"dossier.RestrictiveMeasureEvaluation": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.MedicalBase"
}
],
"properties": {
"evaluationText": {
"type": "string",
"description": "The text of the evaluation",
"nullable": true
},
"evaluationDate": {
"type": "string",
"description": "The date of the evaluation",
"format": "date",
"nullable": true
}
},
"description": "RestrictiveMeasureEvaluation model (no description)",
"example": {
"id": 1,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 2,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"evaluationText": "Evaluation text",
"evaluationDate": "2014-11-14"
}
},
"dossier.RestrictiveMeasureCarePlanEntryReason": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The reason's ID.",
"format": "int64",
"nullable": true,
"x-cupido-id": true
},
"tag": {
"type": "string",
"description": "The reason description and their Dutch translation.\nNew values since the March 2022-release:\n\n
\n\nOlder values:\n\n
",
"nullable": true
}
},
"description": "A reason for a {@link RestrictiveMeasureCarePlanEntry}.",
"example": {
"id": 1,
"tag": "prevent_crisis"
}
},
"dossier.RestrictiveMeasureCarePlanEntryProblemNarrative": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The problem narrative's ID.",
"format": "int64",
"nullable": true,
"x-cupido-id": true
},
"tag": {
"type": "string",
"description": "The problem narrative description. Possible values and their Dutch translations:\n\nWZD-labels:\n\n
\n\nWZD-FZ-labels:\n\n
",
"nullable": true
}
},
"description": "A problem narrative for a {@link RestrictiveMeasureCarePlanEntry}.",
"example": {
"id": 1,
"tag": "general_safety"
}
},
"dossier.RestrictiveMeasureCarePlanEntryJudgement": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The id of this judgement",
"format": "int64",
"nullable": false,
"x-cupido-id": true
},
"restrictiveMeasureCarePlanEntryId": {
"type": "integer",
"description": "The id of the restrictive measure care plan entry this judgement is linked to",
"format": "int64",
"nullable": false
},
"status": {
"type": "integer",
"description": "The status of the status\n- 0 draft\n- 1 rejected\n- 2 approved",
"format": "int32",
"nullable": false
},
"text": {
"type": "string",
"description": "The text of the judgement",
"nullable": true
},
"clientExternalId": {
"type": "integer",
"description": "The id of the client this judgement is linked to",
"format": "int64",
"nullable": false
},
"reviewerUserId": {
"type": "integer",
"description": "The id of the user who reviewed this judgement",
"format": "int64",
"nullable": true
},
"reviewedAt": {
"type": "string",
"description": "The date and time when this judgement was reviewed",
"format": "date-time",
"nullable": true
},
"createdById": {
"type": "integer",
"description": "The id of the user who created this judgement",
"format": "int64",
"nullable": false
},
"updatedById": {
"type": "integer",
"description": "The id of the user who last updated this judgement",
"format": "int64",
"nullable": false
},
"createdAt": {
"type": "string",
"description": "The date and time when this judgement was created",
"format": "date-time",
"nullable": false
},
"updatedAt": {
"type": "string",
"description": "The date and time when this judgement was last updated",
"format": "date-time",
"nullable": false
}
},
"description": "RestrictiveMeasureCarePlanEntryJudgement model (no description)",
"example": {
"id": 1,
"restrictiveMeasureCarePlanEntryId": 2,
"status": 1,
"text": "text",
"clientExternalId": 3,
"reviewerUserId": 4,
"reviewedAt": "2021-01-01T00:00:00.000+01:00",
"createdById": 5,
"updatedById": 6,
"createdAt": "2021-01-01T00:00:00.000+01:00",
"updatedAt": "2021-01-01T00:00:00.000+01:00"
}
},
"dossier.episodes.Episode": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"description": "Object id of this episode",
"format": "int64",
"x-cupido-id": true
},
"clientId": {
"type": "integer",
"description": "Client object id this episode belongs too",
"format": "int64"
},
"startDate": {
"type": "string",
"description": "Start date of this episode",
"format": "date"
},
"endDate": {
"type": "string",
"description": "End date of this episode",
"format": "date"
},
"evaluationDate": {
"type": "string",
"description": "Evaluation date of this episode",
"format": "date"
},
"goal": {
"type": "string",
"description": "Goal description of this episode"
},
"title": {
"type": "string",
"description": "Title of this episode"
},
"important": {
"type": "boolean",
"description": "Marked as important"
},
"marked": {
"type": "boolean",
"description": "Marked as relevant"
},
"subGoals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.episodes.SubGoal"
},
"description": "Sub goals of this episode"
},
"problemIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Medical problems that are linked to this episode"
},
"surveyResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/survey.SurveyResult"
},
"description": "Object ids of the survey results that are linked to this episode"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.episodes.EpisodeDocument"
},
"description": "Object ids of the documents that are linked to this episode"
},
"expertiseProfileIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Only users with these expertise profiles are allowed to access this episode; authorzationIds",
"deprecated": true
},
"authorizedExpertiseProfileIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Only users with these expertise profiles are allowed to access this episode"
},
"authorizedExpertiseGroupIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Only users with these expertise groups are allowed to access this episode"
},
"linkedExpertiseProfileIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Users with these linked expertise profiles are connected to this episode"
},
"linkedExpertiseGroupIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Users with these linked expertise groups are connected to this episode"
}
},
"description": "Episode model (no description)",
"example": {
"updatedAt": "2017-11-27T00:00:00.000+01:00",
"createdAt": "2017-11-27T00:00:00.000+01:00",
"createdBy": "Some Employee",
"id": 1,
"clientId": 1,
"startDate": "2017-11-27",
"endDate": "2017-11-27",
"evaluationDate": "2017-11-27",
"goal": "Some Goal",
"title": "awesome episode",
"important": false,
"marked": false,
"subGoals": [
{
"updatedAt": "2017-11-27T00:00:00.000+01:00",
"createdAt": "2017-11-27T00:00:00.000+01:00",
"createdBy": "Dummy",
"id": 2,
"title": "Some sub goal",
"episodeId": 1,
"archived": false
}
],
"problemIds": [
1,
2
],
"surveyResults": [
{
"updatedAt": "2012-08-02T13:48:46.836+02:00",
"createdAt": "2012-08-02T13:48:46.836+02:00",
"createdBy": "user",
"id": 111,
"surveyObjectId": 555,
"clientObjectId": 333,
"employeeObjectId": 444,
"status": "Draft",
"version": 1,
"title": "test",
"linkedToActiveCarePlan": true,
"isAnyCarePlanUsingThisResult": true,
"duplicateSurveyResultAbility": {
"enabled": true,
"possible": true
},
"editSurveyResultAbility": {
"enabled": true,
"possible": true
},
"statusBumpSurveyResultAbility": {
"enabled": true,
"possible": true
},
"viewSurveyResultAbility": {
"enabled": true,
"possible": true
},
"answers": [],
"groupAnswers": [],
"completedAt": "2012-08-02T13:48:46.836+02:00"
}
],
"documents": [
{
"id": 1233,
"fileName": "file.pdf"
}
],
"expertiseProfileIds": [
1,
1
],
"authorizedExpertiseProfileIds": [
1,
2
],
"authorizedExpertiseGroupIds": [
1
],
"linkedExpertiseProfileIds": [
1,
2
],
"linkedExpertiseGroupIds": [
1
]
}
},
"dossier.episodes.SubGoal": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"description": "Object id of this sub goal",
"format": "int64",
"x-cupido-id": true
},
"title": {
"type": "string",
"description": "Title of this sub goal"
},
"episodeId": {
"type": "integer",
"description": "Object id of the parent episode of this sub goal",
"format": "int64"
},
"archived": {
"type": "boolean",
"description": "Archived status of this sub goal"
},
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.episodes.Action"
},
"description": "Actions on this sub goal"
}
},
"description": "SubGoal model (no description)",
"example": {
"updatedAt": "2017-11-27T00:00:00.000+01:00",
"createdAt": "2017-11-27T00:00:00.000+01:00",
"createdBy": "Dummy",
"id": 2,
"title": "Some sub goal",
"episodeId": 1,
"archived": false,
"actions": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"title": "example",
"subGoalId": 1,
"showInCarePlan": true,
"archived": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"title": "example",
"subGoalId": 1,
"showInCarePlan": true,
"archived": true
}
]
}
},
"dossier.episodes.Action": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"description": "Object id of this episode action",
"format": "int64",
"x-cupido-id": true
},
"title": {
"type": "string",
"description": "Title of this episode action"
},
"subGoalId": {
"type": "integer",
"description": "Object id of the parent episode sub goal",
"format": "int64"
},
"showInCarePlan": {
"type": "boolean",
"description": "Show this action in the care plan"
},
"archived": {
"type": "boolean",
"description": "Archive status of this action"
}
},
"description": "Action model (no description)",
"example": {
"updatedAt": "2017-11-27T00:00:00.000+01:00",
"createdAt": "2017-11-27T00:00:00.000+01:00",
"createdBy": "Dummy",
"id": 3,
"title": "Some action",
"subGoalId": 2,
"showInCarePlan": true,
"archived": false
}
},
"dossier.episodes.EpisodeDocument": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"fileName": {
"type": "string",
"deprecated": true,
"x-deprecated-since": "01-04-2026"
}
},
"description": "EpisodeDocument model",
"example": {
"id": 1233,
"fileName": "file.pdf"
}
},
"dossier.medical.advance_directives.Context": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.MedicalBase"
}
],
"properties": {
"narrative": {
"type": "string"
},
"snomedExpressionValue": {
"type": "string"
},
"date": {
"type": "string",
"format": "date"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string",
"description": "The human readable status of the AdvanceDirective Context."
},
"statusKey": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.advance_directives.context.StatusKey"
}
],
"description": "The status of the AdvanceDirective Context."
},
"documentId": {
"type": "integer",
"format": "int32"
},
"documentName": {
"type": "string",
"deprecated": true,
"x-deprecated-since": "01-04-2026"
},
"decisionBuilders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.DecisionBuilder"
},
"description": "Used by the update and create api's to build the Decisions of this AdvanceDirective\nBoth the update and create api will only look at the builders and not at the decision list."
},
"decisions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.advance_directives.Decision"
},
"description": "The decisions of the AdvanceDirective Context."
},
"immutable": {
"type": "boolean",
"description": "Whether or not the context is immutable"
}
},
"description": "The current medical policy of the client",
"example": {
"id": 3,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 1,
"createdById": 2,
"updatedById": 4,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"narrative": "Thats what I want",
"snomedExpressionValue": "Dummy",
"date": "2014-11-14",
"employeeId": 1337,
"status": "Discussed with patient",
"statusKey": "DISCUSSED_WITH_PATIENT",
"documentId": 1,
"documentName": "Document",
"decisionBuilders": [
{
"system": "example",
"query": "example",
"name": "example",
"outcome": "example"
},
{
"system": "example",
"query": "example",
"name": "example",
"outcome": "example"
}
],
"decisions": [
{
"name": "Resuscitation",
"outcome": "Yes"
}
],
"immutable": true
}
},
"dossier.medical.DecisionBuilder": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.RelationshipBuilder"
}
],
"properties": {
"outcome": {
"type": "string",
"description": "The outcome that should be set on the decision\nShould be a valid outcome code within the system that is set on this builder"
}
},
"description": "DecisionBuilder model (no description)",
"example": {
"system": "SNOMED",
"query": "61420007 | Tube feeding |",
"name": "Sondevoeding",
"outcome": "373067005 | no |"
}
},
"dossier.medical.advance_directives.Decision": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"outcome": {
"type": "string"
},
"snomedExpressionValue": {
"type": "string",
"description": "snomedexpression of the whole decision.\nExample: \"363589002 | associated procedure |: 246456000 | has interpretation | =439569004 | resuscitation |, 408729009 | finding context | =373066001 | yes |\""
}
},
"description": "Decision model (no description)",
"example": {
"name": "Resuscitation",
"outcome": "Yes",
"snomedExpressionValue": "363589002 | associated procedure |: 246456000 | has interpretation | =439569004 | resuscitation |, 408729009 | finding context | =373066001 | yes |"
}
},
"dossier.medical.advance_directives.context.StatusKey": {
"enum": [
"ACTIVE",
"DISCUSSED_WITH_PATIENT",
"DISCUSSED_WITH_RELATIVE"
],
"type": "string",
"description": "The status of the AdvanceDirective Context.",
"example": "DISCUSSED_WITH_PATIENT"
},
"dossier.medical.dsm.ClassificationSeries": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.MedicalBase"
}
],
"properties": {
"classifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.dsm.Classification"
},
"description": "The classifications belonging to this series"
},
"dsmType": {
"type": "string",
"description": "The type of DSM classifications in this series (DSM-IV or DSM-5)"
},
"financeId": {
"type": "integer",
"description": "The ID of the financial entity linked to this classification series",
"format": "int32"
},
"financeType": {
"type": "string",
"description": "The type of financial entity linked to this classification series"
},
"psychiatricCareType": {
"type": "string",
"description": "The type of psychiatric care for this classification series\nCan be 'basic' or 'specialistic'"
},
"status": {
"type": "string",
"description": "The status of the classification series (based on the status of the last Classification)"
}
},
"description": "ClassificationSeries model (no description)",
"example": {
"id": 1,
"uuid": "a72ec22c-faca-43c6-86ec-28ff0e1ddba4",
"clientId": 8,
"createdById": 1,
"updatedById": 1,
"createdAt": "2016-10-24T18:55:45.000+02:00",
"updatedAt": "2016-10-24T18:55:45.000+02:00",
"classifications": [
{
"id": 1,
"uuid": "d69c298d-89b6-409a-ac5a-450857c40d44",
"clientId": 8,
"createdById": 1,
"updatedById": 1,
"createdAt": "2016-10-24T18:55:45.000+02:00",
"updatedAt": "2016-10-24T18:56:23.000+02:00",
"beginDate": "2016-10-24",
"endDate": "2016-10-24",
"classificationDate": "2016-10-24",
"status": "registration",
"diagnosisDescription": "This is the descriptive diagnosis",
"childId": 2,
"immutable": true,
"axis3weight": 1,
"gafStart": 51,
"classificationSeriesId": 1
},
{
"id": 2,
"uuid": "5d4a08d0-d853-4882-8a7f-f414cd7e9f42",
"clientId": 8,
"createdById": 1,
"updatedById": 1,
"createdAt": "2016-10-24T18:56:23.000+02:00",
"updatedAt": "2016-10-26T19:39:33.000+02:00",
"findings": [
{
"id": 9,
"uuid": "dbff59ee-4ec0-40bf-bdab-8ee8f29a83f4",
"clientId": 8,
"createdById": 1,
"updatedById": 1,
"createdAt": "2016-10-26T19:39:33.000+02:00",
"updatedAt": "2016-10-26T19:39:33.000+02:00",
"axis": 1,
"mainDiagnosis": false,
"compoundCode": "2016-01-01|as1_10.02|0",
"icd9cmCode": "300.13",
"icd10Code": "F44.1",
"dsmType": "DSM-IV",
"description": "Dissociatieve fugue"
}
],
"beginDate": "2016-10-24",
"endDate": "2016-10-26",
"classificationDate": "2016-10-26",
"status": "intake",
"diagnosisDescription": "This is another descriptive diagnosis",
"parentId": 1,
"childId": 5,
"immutable": true,
"axis3weight": 1,
"gafStart": 51,
"classificationSeriesId": 1
},
{
"id": 5,
"uuid": "9ee1eb44-a89f-4fb6-bb29-ff39bfeef98e",
"clientId": 8,
"createdById": 1,
"updatedById": 1,
"createdAt": "2016-10-26T19:39:33.000+02:00",
"updatedAt": "2016-10-26T19:39:33.000+02:00",
"findings": [
{
"id": 10,
"uuid": "99db4e0f-0d7a-4c68-9f01-a38a7c30d11b",
"clientId": 8,
"createdById": 1,
"updatedById": 1,
"createdAt": "2016-10-26T19:39:33.000+02:00",
"updatedAt": "2016-10-26T19:39:33.000+02:00",
"axis": 2,
"signsOf": true,
"mainDiagnosis": false,
"compoundCode": "2016-01-01|as2_17.01|0",
"icd9cmCode": "V62.89",
"icd10Code": "F44.1",
"dsmType": "DSM-IV",
"description": "Zwakbegaafdheid"
}
],
"evaluations": [
{
"id": 1,
"uuid": "46b414fb-576c-4a5b-890e-0e7e058b4a72",
"clientId": 8,
"createdById": 1,
"updatedById": 1,
"createdAt": "2016-10-26T19:39:42.000+02:00",
"updatedAt": "2016-10-26T19:39:42.000+02:00",
"evaluationText": "Dit is een evaluatie",
"newDraft": false
}
],
"beginDate": "2016-10-26",
"status": "treatment_active",
"diagnosisDescription": "This is the last descriptive diagnosis",
"parentId": 2,
"axis3weight": 1,
"gafStart": 51,
"classificationSeriesId": 1
}
],
"dsmType": "DSM-IV",
"financeId": 655,
"financeType": "Cupido::Finance::CareOrder",
"psychiatricCareType": "basic",
"status": "treatment_active"
}
},
"dossier.medical.dsm.Classification": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.MedicalBase"
}
],
"properties": {
"findings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.dsm.Finding"
},
"description": "The findings belonging to this classification"
},
"evaluations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.dsm.Evaluation"
},
"description": "The evaluations belonging to this classification"
},
"beginDate": {
"type": "string",
"description": "The begin date of the classification phase",
"format": "date"
},
"endDate": {
"type": "string",
"description": "The end date of the classification phase",
"format": "date"
},
"classificationDate": {
"type": "string",
"description": "The date the classification was determined",
"format": "date"
},
"status": {
"type": "string",
"description": "The status of the classification phase"
},
"diagnosisDescription": {
"type": "string",
"description": "The descriptive diagnosis"
},
"parentId": {
"type": "integer",
"description": "The classification phase this classification was derived from",
"format": "int32"
},
"childId": {
"type": "integer",
"description": "The classification phase that was derived from this classification",
"format": "int32"
},
"immutable": {
"type": "boolean",
"description": "Whether or not the classification is immutable"
},
"axis3weight": {
"type": "integer",
"description": "The weight of the axis 3 findings",
"format": "int32"
},
"gafStart": {
"type": "integer",
"description": "The start GAF score",
"format": "int32"
},
"gafCurrent": {
"type": "integer",
"description": "The current GAF score",
"format": "int32"
},
"gafMax": {
"type": "integer",
"description": "The maximum GAF score",
"format": "int32"
},
"gafEnd": {
"type": "integer",
"description": "The end GAF score",
"format": "int32"
},
"classificationSeriesId": {
"type": "integer",
"description": "The series this classification is a part of",
"format": "int64"
}
},
"description": "Classification model (no description)",
"example": {
"id": 5,
"uuid": "9ee1eb44-a89f-4fb6-bb29-ff39bfeef98e",
"clientId": 8,
"createdById": 1,
"updatedById": 1,
"createdAt": "2016-10-26T19:39:33.000+02:00",
"updatedAt": "2016-10-26T19:39:33.000+02:00",
"findings": [
{
"id": 9,
"uuid": "dbff59ee-4ec0-40bf-bdab-8ee8f29a83f4",
"clientId": 8,
"createdById": 1,
"updatedById": 1,
"createdAt": "2016-10-26T19:39:33.000+02:00",
"updatedAt": "2016-10-26T19:39:33.000+02:00",
"axis": 1,
"signsOf": false,
"mainDiagnosis": true,
"compoundCode": "2016-01-01|as1_10.02|0",
"icd9cmCode": "300.13",
"icd10Code": "F44.1",
"dsmType": "DSM-IV",
"description": "Dissociatieve fugue"
},
{
"id": 10,
"uuid": "99db4e0f-0d7a-4c68-9f01-a38a7c30d11b",
"clientId": 8,
"createdById": 1,
"updatedById": 1,
"createdAt": "2016-10-26T19:39:33.000+02:00",
"updatedAt": "2016-10-26T19:39:33.000+02:00",
"axis": 2,
"signsOf": true,
"mainDiagnosis": false,
"compoundCode": "2016-01-01|as2_17.01|0",
"icd9cmCode": "V62.89",
"icd10Code": "F44.1",
"dsmType": "DSM-IV",
"description": "Zwakbegaafdheid"
}
],
"evaluations": [
{
"id": 1,
"uuid": "46b414fb-576c-4a5b-890e-0e7e058b4a72",
"clientId": 8,
"createdById": 1,
"updatedById": 1,
"createdAt": "2016-10-26T19:39:42.000+02:00",
"updatedAt": "2016-10-26T19:39:42.000+02:00",
"evaluationText": "Dit is een evaluatie",
"newDraft": false
}
],
"beginDate": "2016-10-26",
"endDate": "2016-10-26",
"classificationDate": "2016-10-26",
"status": "treatment_active",
"diagnosisDescription": "This is the descriptive diagnosis",
"parentId": 2,
"childId": 3,
"immutable": true,
"axis3weight": 1,
"gafStart": 51,
"gafCurrent": 61,
"gafMax": 71,
"gafEnd": 81,
"classificationSeriesId": 1
}
},
"dossier.medical.dsm.Finding": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.MedicalBase"
}
],
"properties": {
"axis": {
"type": "integer",
"description": "The axis of the finding",
"format": "int32"
},
"signsOf": {
"type": "boolean",
"description": "Whether or not there are signs of the diagnosis"
},
"mainDiagnosis": {
"type": "boolean",
"description": "Whether or it is the primary diagnosis"
},
"compoundCode": {
"type": "string",
"description": "The compound code that uniquely identifies the diagnosis\n\nFor DSM-IV this is:\nCL_DIAGNOSE_BEGINDATUM|CL_DIAGNOSE_CODE|CL_DIAGNOSE_BRANCHE_INDICATIE\n\nFor DSM-5 this is:\nCL_DIAGNOSE_BEGINDATUM|CL_D5_DIAGNOSE_CODE"
},
"icd9cmCode": {
"type": "string",
"description": "The ICD-9-CM code of the diagnosis"
},
"icd10Code": {
"type": "string",
"description": "The ICD-10 code of the diagnosis"
},
"dsmType": {
"type": "string",
"description": "Whether it is a DSM-IV or a DSM-V finding"
},
"convertedCompoundCodeDsm4": {
"type": "string",
"description": "If it is a DSM-5 finding, this is the converted DSM-IV compound code"
},
"description": {
"type": "string",
"description": "The description of the diagnosis"
},
"diagnosisClaimType": {
"type": "integer",
"description": "The claim type of a diagnosis.",
"format": "int32"
}
},
"description": "Finding model (no description)",
"example": {
"id": 10,
"uuid": "99db4e0f-0d7a-4c68-9f01-a38a7c30d11b",
"clientId": 8,
"createdById": 1,
"updatedById": 1,
"createdAt": "2016-10-26T19:39:33.000+02:00",
"updatedAt": "2016-10-26T19:39:33.000+02:00",
"axis": 2,
"signsOf": true,
"mainDiagnosis": false,
"compoundCode": "2016-01-01|as2_17.01|0",
"icd9cmCode": "V62.89",
"icd10Code": "F44.1",
"dsmType": "DSM-IV",
"convertedCompoundCodeDsm4": "2000-01-01|as1_5.04|0",
"description": "Waanstoornis",
"diagnosisClaimType": 2
}
},
"dossier.medical.dsm.Evaluation": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.MedicalBase"
}
],
"properties": {
"evaluationText": {
"type": "string",
"description": "The evaluation text"
},
"newDraft": {
"type": "boolean",
"description": "Whether or not this evaluation led to a new draft classification"
}
},
"description": "Evaluation model (no description)",
"example": {
"id": 1,
"uuid": "46b414fb-576c-4a5b-890e-0e7e058b4a72",
"clientId": 8,
"createdById": 1,
"updatedById": 1,
"createdAt": "2016-10-26T19:39:42.000+02:00",
"updatedAt": "2016-10-26T19:39:42.000+02:00",
"evaluationText": "Dit is een evaluatie",
"newDraft": false
}
},
"dossier.medical.involuntary_care.Incompetence": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.MedicalBase"
}
],
"properties": {
"narrative": {
"type": "string",
"description": "Extra comments relating to this incompetence"
},
"startDate": {
"type": "string",
"description": "The start date of the incompetence.",
"format": "date"
},
"endDate": {
"type": "string",
"description": "The end date of the incompetence. If this is in the past, the incompetence is no longer active",
"format": "date"
},
"snomedExpressionValue": {
"type": "string",
"description": "The snomed expression of the incompetence decision"
},
"decisionBuilders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.DecisionBuilder"
},
"description": "The decision builder to build the medical relation"
},
"decision": {
"type": "string"
}
},
"description": "An incompetence of a client",
"example": {
"id": 1,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 2,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"narrative": "I can't do this",
"startDate": "2015-09-17",
"endDate": "2015-09-27",
"snomedExpressionValue": "285033005 | ability to manage medication |",
"decisionBuilders": [
{
"system": "example",
"query": "example",
"name": "example",
"outcome": "example"
},
{
"system": "example",
"query": "example",
"name": "example",
"outcome": "example"
}
],
"decision": "Uitvoeren van gastroscopie"
}
},
"dossier.medical.involuntary_care.LegalStatus": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.MedicalBase"
}
],
"properties": {
"status": {
"type": "string",
"description": "The type of legal status. Currently supported types in Dossier are:\n- Vrijwillige opname\n- Artikel 60 Bopz-indicatie\n- Rechterlijke machtiging (RM)\n- Inbewaringstelling (IBS)\n\nIn 2020 Wzd and Wvggz take effect and dossier supports the following additional legal status types:\n- Ondertoezichtstelling (OTS)\n- Zorgmachtiging (ZM)\n- Crisismaatregel (CM)\n- Voortgezette crisismaatregel (VCM)\n- Terbeschikkingstelling (TBS)\n- Plaatsing Inrichting Jeugdigen (PIJ)\n- Artikel 21 Wzd-indicatie\n- Zelfbindingsverklaring\n- Wfz 2.3 Schakel-artikel\n- Voorwaardelijke machtiging voor jongvolwassenen met een verstandelijke beperking (VMM)\nIn 2022, dossier supports Jeugd law and the following additional legal status types:\n- Voorlopige onder toezichtstelling (VOTS)\n- Machtiging uithuisplaatsing (MUHP)\n- Gezagsbeëindigende maatregel\n- Voogdijmaatregel\n- Tijdelijke voogdij\n- Voorlopige voogdij (VoVo)\n- Jeugdreclassering\n- Machtiging gesloten jeugdhulp (MGJ) \n- Voorwaardelijke machtiging gesloten jeugdhulp (VMGJ) \n- Voorwaardelijke PIJ (Art. 77x lid 2) \n- Onvoorwaardelijke PIJ (Art. 77s) \n- Verlenging onvoorwaardelijke PIJ (Art. 77t) \n- Voorwaardelijke (beëindiging) PIJ, met algemene voorwaarden (Art. 77s) \n- Verlenging voorwaardelijke beëindiging PIJ (Art. 77z) \n- Gedragsbeïnvloedende maatregel (Art. 77w) \n- Voorwaardelijke veroordeling (Art. 77x) \n- Jeugddetentie (Art. 77i) \n- Spoedmachtiging gesloten jeugdhulp (Art. 6.1.3 Jw)"
},
"code": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.involuntary_care.LegalStatusTypeCode"
}
],
"description": "Unique code that identifies the legal status type"
},
"beginDate": {
"type": "string",
"description": "The start date of the legal status. May be empty if the client is in voluntary care (Vrijwillige opname)",
"format": "date"
},
"endDate": {
"type": "string",
"description": "The end date of the legal status. If this is in the past, the described legal status is no longer valid",
"format": "date"
},
"expirationDate": {
"type": "string",
"description": "The expiration date of the legal status",
"format": "date"
},
"comments": {
"type": "string",
"description": "Extra comments relating to this legal status"
},
"endingReason": {
"type": "string",
"description": "The reason to end the legal status"
},
"documentId": {
"type": "integer",
"description": "The ID of the document linked to this legal status",
"format": "int32",
"deprecated": true
},
"documentName": {
"type": "string",
"description": "The name of the document linked to this legal status",
"deprecated": true
},
"archived": {
"type": "boolean",
"description": "The archived status"
},
"request": {
"type": "boolean",
"description": "The request status"
},
"legalStatusDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.involuntary_care.LegalStatusDocument"
},
"description": "A list of documents"
},
"legalStatusSuspensions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.involuntary_care.LegalStatusSuspension"
},
"description": "A list of suspensions"
},
"legalGrounds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.involuntary_care.LegalGround"
},
"description": "A list of legal grounds"
}
},
"description": "The legal status of a client.",
"example": {
"id": 1,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 2,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"status": "Artikel 60 Bopz-indicatie",
"code": "sapc",
"beginDate": "2015-09-17",
"endDate": "2015-09-27",
"expirationDate": "2015-09-28",
"comments": "5 weeks until renewal",
"endingReason": "Client is better again",
"documentId": 1,
"documentName": "artikel60.pdf",
"archived": false,
"request": false,
"legalStatusDocuments": [
{
"documentId": 1,
"documentName": "artikel60.pdf"
}
],
"legalStatusSuspensions": [
{
"id": 1,
"beginDate": "2021-09-01",
"endDate": "2021-09-02",
"comments": "What the judge told",
"type": "withdraw_involuntary_care",
"createdById": 1,
"updatedById": 1,
"createdAt": "2020-11-14T00:00:00.000+01:00",
"updatedAt": "2020-11-14T00:00:00.000+01:00",
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51d"
}
],
"legalGrounds": [
{
"beginDate": "2015-09-25",
"endDate": "2015-09-26",
"comments": "Important side node",
"categoryCode": "wvggz_inclosure_other"
}
]
}
},
"dossier.medical.involuntary_care.LegalStatusDocument": {
"type": "object",
"properties": {
"documentId": {
"type": "integer",
"format": "int32"
},
"documentName": {
"type": "string",
"deprecated": true,
"x-deprecated-since": "01-04-2026"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"description": "LegalStatusDocument model (no description)",
"example": {
"documentId": 1,
"documentName": "Important.pdf",
"createdAt": "2020-11-15T00:00:00.000+01:00",
"updatedAt": "2020-11-15T00:00:00.000+01:00"
}
},
"dossier.medical.involuntary_care.LegalStatusSuspension": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"beginDate": {
"type": "string",
"description": "The start date of the suspension",
"format": "date"
},
"endDate": {
"type": "string",
"description": "The end date of the suspension",
"format": "date"
},
"comments": {
"type": "string",
"description": "Extra comments relating to this legal status"
},
"type": {
"type": "string",
"description": "The type of suspension\nCan consist of:\n- withdraw_involuntary_care (Onttrekken Verplichte Zorg)\n- transfer_involuntary_care (Overplaatsing met Verplichte Zorg)\n- temporary_suspension_involuntary_care (Tijdelijke onderbreking Verplichte Zorg)\n- termination_involuntary_care_with_conditions (Beëindiging Verplichte Zorg met voorwaarden)"
},
"createdById": {
"type": "integer",
"description": "The identifier of the employee that created the suspension",
"format": "int64"
},
"updatedById": {
"type": "integer",
"description": "The identifier of the employee that last updated the suspension",
"format": "int64"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"uuid": {
"type": "string"
}
},
"description": "LegalStatusSuspension model (no description)",
"example": {
"id": 1,
"beginDate": "2021-09-01",
"endDate": "2021-09-02",
"comments": "What the judge told",
"type": "withdraw_involuntary_care",
"createdById": 1,
"updatedById": 1,
"createdAt": "2020-11-14T00:00:00.000+01:00",
"updatedAt": "2020-11-14T00:00:00.000+01:00",
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51d"
}
},
"dossier.medical.involuntary_care.LegalGround": {
"type": "object",
"properties": {
"beginDate": {
"type": "string",
"description": "The begin date of the legal ground.",
"format": "date"
},
"endDate": {
"type": "string",
"description": "The end date of the legal ground.",
"format": "date"
},
"comments": {
"type": "string",
"description": "Extra comments relating to this legal ground"
},
"categoryCode": {
"type": "string",
"description": "The category code of the legal ground.\nThe following codes are available:\n- wvggz_administer_nutrition\n- wvggz_check_clothing_or_body\n- wvggz_check_drugs\n- wvggz_check_home_drugs_danger\n- wvggz_fixation_category\n- wvggz_inclosure_category\n- wvggz_inclosure_other\n- wvggz_inclosure_own_living_space\n- wvggz_inclosure_seclusion_room\n- wvggz_inclosure_secure_room\n- wvggz_inclosure_separation_room\n- wvggz_limit_means_of_communication\n- wvggz_limit_organize_life_category\n- wvggz_limit_organize_life_other\n- wvggz_limit_receive_visitors\n- wvggz_mechanical_fixation\n- wvggz_medical_checks_ect\n- wvggz_medical_checks_other\n- wvggz_medication_category\n- wvggz_medication_checks_category\n- wvggz_medication_intramuscularly\n- wvggz_medication_intravenously\n- wvggz_medication_oral\n- wvggz_medication_other\n- wvggz_movement_restriction_category\n- wvggz_movement_restriction_closed_department\n- wvggz_movement_restriction_other\n- wvggz_nutrition_medication_category\n- wvggz_physical_fixation\n- wvggz_receive_accommodation\n- wvggz_supervision_camera\n- wvggz_supervision_category\n- wvggz_supervision_other_electronic_devices\n- wvggz_transfer_temporary_accommodation"
},
"createdById": {
"type": "integer",
"description": "The identifier of the employee that created the LegalGround",
"format": "int64"
},
"updatedById": {
"type": "integer",
"description": "The identifier of the employee that last updated the LegalGround",
"format": "int64"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"uuid": {
"type": "string"
}
},
"description": "LegalGround model (no description)",
"example": {
"beginDate": "2015-09-18",
"endDate": "2015-09-25",
"comments": "5 weeks until renewal",
"categoryCode": "wvggz_inclosure_other",
"createdById": 1,
"updatedById": 1,
"createdAt": "2020-11-14T00:00:00.000+01:00",
"updatedAt": "2020-11-14T00:00:00.000+01:00",
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51c"
}
},
"dossier.medical.involuntary_care.LegalStatusTypeCode": {
"enum": [
"voluntary_admission",
"sapc",
"court_authorization",
"custody_claim",
"placed_under_supervision",
"care_authorization",
"crisis_measure",
"continued_crisis_measure",
"tbs",
"not_voluntary_no_resistance",
"self_binding",
"pij",
"wfz23",
"vmm",
"vots",
"muhp",
"gbm",
"guardianship",
"temporary_guardianship",
"vovo",
"juvenile_probation",
"mgj",
"vmgj",
"conditional_pij_77x_2",
"unconditional_pij_77s",
"extension_unconditional_pij_77t",
"conditional_termination_pij_77s",
"extension_conditional_termination_pij_77z",
"behavior_influencing_measure_77w",
"conditional_conviction_77x",
"juvenile_detention_77i",
"emgj_6_1_3"
],
"type": "string",
"description": "Unique code that identifies the legal status type",
"example": "sapc"
},
"dossier.medical.Problem": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.MedicalBase"
}
],
"properties": {
"narrative": {
"type": "string"
},
"starred": {
"type": "boolean"
},
"onsetApproximateDate": {
"type": "string"
},
"resolvedApproximateDate": {
"type": "string"
},
"snomedExpressionValue": {
"type": "string"
},
"active": {
"type": "boolean"
},
"relevant": {
"type": "boolean"
},
"certainty": {
"type": "string"
},
"severity": {
"type": "string"
},
"course": {
"type": "string"
},
"onsetPeriodOfLife": {
"type": "string"
},
"expertiseProfileIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"authorizedExpertiseProfileIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Only users with these expertise profiles are allowed to access this problem\nUse expertiseProfileIds until implemented in Dossier"
},
"authorizedExpertiseGroupIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Only users with these expertise groups are allowed to access this problem\nUse expertiseProfileIds until implemented in Dossier"
},
"episodeId": {
"type": "integer",
"format": "int32"
},
"episodeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The episodes that are linked to this problem"
},
"diagnosisBuilders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.DiagnosisBuilder"
}
},
"diagnoses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.Diagnosis"
}
},
"immutable": {
"type": "boolean",
"description": "Whether or not the problem is immutable"
},
"feederAuditContentStore": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.FeederAuditContentStoreType"
}
],
"description": "Identifier of the content store that is providing this content"
},
"feederAuditContentId": {
"type": "string",
"description": "Identifier referencing the original content in the feederAuditContentStore"
},
"feederAuditSenderName": {
"type": "string",
"description": "Name of the sender of the original content"
},
"feederAuditTransferType": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.FeederAuditTransferType"
}
],
"description": "Type of the transfer containing this content (a.k.a. the use case)"
}
},
"description": "Problem model (no description)",
"example": {
"id": 1,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 2,
"createdById": 3,
"updatedById": 1,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"narrative": "It hurts",
"starred": true,
"onsetApproximateDate": "2014",
"resolvedApproximateDate": "2014-12",
"snomedExpressionValue": "22298006 | Myocardial infarction (disorder) |",
"active": true,
"relevant": true,
"certainty": "Ik ben er niet zo zeker van",
"severity": "Niet levensbedreigend",
"course": "De afgelopen twee weken",
"onsetPeriodOfLife": "Vanaf kleuterperiode",
"expertiseProfileIds": [
1,
2
],
"authorizedExpertiseProfileIds": [
1,
2
],
"authorizedExpertiseGroupIds": [
3,
4
],
"episodeId": 1,
"episodeIds": [
1,
2
],
"diagnosisBuilders": [
{
"system": "example",
"query": "example",
"name": "example"
},
{
"system": "example",
"query": "example",
"name": "example"
}
],
"diagnoses": [
{
"name": "example",
"code": "example",
"encodings": [
{
"code": "example",
"codeSystem": "example",
"displayName": "example"
},
{
"code": "example",
"codeSystem": "example",
"displayName": "example"
}
]
},
{
"name": "example",
"code": "example",
"encodings": [
{
"code": "example",
"codeSystem": "example",
"displayName": "example"
},
{
"code": "example",
"codeSystem": "example",
"displayName": "example"
}
]
}
],
"immutable": true,
"feederAuditContentStore": "ons_ketenverkeer",
"feederAuditContentId": "abz123",
"feederAuditSenderName": "Some care organisation",
"feederAuditTransferType": "eoverdracht_nursing"
}
},
"dossier.medical.DiagnosisBuilder": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.RelationshipBuilder"
}
],
"description": "DiagnosisBuilder model (no description)",
"example": {
"system": "SNOMED",
"query": "22298006 | Myocardial infarction (disorder) |",
"name": "Hartinfarct"
}
},
"dossier.medical.Diagnosis": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"code": {
"type": "string",
"description": "Deprecated since: 01-12-2021 - use encodings instead\n(the `code` field of all encodings is equivalent to this stringified array of codes)",
"deprecated": true
},
"encodings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.Encoding"
}
}
},
"description": "Diagnosis model (no description)",
"example": {
"name": "Type 1-diabetes",
"code": "E10",
"encodings": [
{
"code": "E10",
"codeSystem": "ICD-10",
"displayName": "Type 1-diabetes"
}
]
}
},
"dossier.medical.SimplifiedPropensityToAdverseReaction": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.MedicalBase"
}
],
"properties": {
"causeBuilders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.CauseBuilder"
}
},
"causes": {
"type": "array",
"items": {
"type": "string"
}
},
"immutable": {
"type": "boolean",
"description": "Whether or not the propensity to adverse reaction is immutable"
}
},
"description": "SimplifiedPropensityToAdverseReaction model (no description)",
"example": {
"id": 5,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 4,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-10T12:00:00.000+01:00",
"updatedAt": "2014-11-10T12:00:00.000+01:00",
"causeBuilders": [
{
"system": "CUSTOM",
"query": "Stofmijt"
},
{
"system": "SNOMED",
"query": "256259004 | pollen |",
"name": "Pollen"
}
],
"causes": [
"Diarree",
"Misselijkheid",
"Duizeligheid"
],
"immutable": true
}
},
"fvc.FvcMessage": {
"required": [
"uuid",
"payload"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "UUID identifying this FVC message across applications",
"example": null,
"x-cupido-id": true
},
"payload": {
"type": "string",
"description": "Payload FVC message (Base64 encoded)",
"example": null
}
},
"description": "FvcMessage model (no description)",
"example": {
"uuid": "Dummy",
"payload": "Dummy"
},
"xml": {
"name": "fvcMessage"
}
},
"groupcare.Group": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"nullable": true,
"x-cupido-id": true
},
"name": {
"type": "string"
},
"startTime": {
"type": "string",
"format": "time",
"nullable": true
},
"endTime": {
"type": "string",
"format": "time",
"nullable": true
},
"minimumCapacity": {
"type": "integer",
"description": "Minimum capacity of a group (only notifies user in the browser about this in Groupcare)",
"format": "int32",
"nullable": true
},
"maximumCapacity": {
"type": "integer",
"description": "Maximum capacity of a group, can go up to 99 (only notifies user in the browser about this in Groupcare)",
"format": "int32",
"nullable": true
},
"expiresAfter": {
"type": "string",
"description": "After this date the Group is not visible anymore in Groupcare (together with archived)",
"format": "date-time",
"nullable": true
},
"archived": {
"type": "boolean"
},
"useLocationAuthorisation": {
"type": "boolean",
"description": "Use location based authorisation for this group, instead of adding employees manually (with employee_ids)"
},
"useAgendaAppointments": {
"type": "boolean",
"description": "Store appointments of this group in Agenda, where it also should be registered (not normal Groupcare flow, see Groupregistration project)"
},
"locationId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"teamId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"employeeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64",
"xml": {
"name": "employeeId"
}
},
"xml": {
"wrapped": true
}
},
"activityIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64",
"xml": {
"name": "activityId"
}
},
"xml": {
"wrapped": true
}
},
"uuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"monday": {
"type": "boolean",
"description": "Needed to recreate agenda appointments for the Groupregistration project"
},
"tuesday": {
"type": "boolean"
},
"wednesday": {
"type": "boolean"
},
"thursday": {
"type": "boolean"
},
"friday": {
"type": "boolean"
},
"saturday": {
"type": "boolean"
},
"sunday": {
"type": "boolean"
},
"cycleInterval": {
"type": "integer",
"format": "int32"
},
"recurrenceType": {
"type": "string"
}
},
"description": "Group model (no description)",
"example": {
"id": 1,
"name": "Testgroup",
"startTime": "08:00:00.000",
"endTime": "16:00:00.000",
"minimumCapacity": 0,
"maximumCapacity": 25,
"expiresAfter": "2040-01-01T00:00:00.000+01:00",
"archived": false,
"useLocationAuthorisation": false,
"useAgendaAppointments": false,
"locationId": 10,
"teamId": 8,
"employeeIds": [
10
],
"activityIds": [
1
],
"uuid": "2d8b914f-33e3-4f15-b737-89bb1a58f122",
"monday": false,
"tuesday": false,
"wednesday": false,
"thursday": false,
"friday": false,
"saturday": true,
"sunday": true,
"cycleInterval": 1,
"recurrenceType": "single"
},
"xml": {
"name": "group"
}
},
"onsimport.Run": {
"required": [
"name"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "string",
"description": "Object identifier of the run, usually in the form of a UUID.",
"x-cupido-id": true
},
"name": {
"type": "string",
"description": "Name of the run."
},
"autoProcess": {
"type": "boolean",
"description": "Indicates that records added to the run will be automatically\nmatched and synchronized.",
"default": true,
"deprecated": true,
"x-deprecated-since": "20-11-2023"
},
"quickMatch": {
"type": "boolean",
"description": "Indicates that matching will be skipped for reference fields\nalready containing database IDs.",
"default": false,
"deprecated": true,
"x-deprecated-since": "20-11-2023"
}
},
"description": "A collection of records to be imported via Ons Import.\nRecords can be added by uploading XML or binary files\nvia RunAPI.",
"example": {
"updatedAt": "2020-03-25T00:00:00.000+01:00",
"createdAt": "2020-03-25T00:00:00.000+01:00",
"createdBy": "htaylor",
"id": "runwithme",
"name": "Run With Me",
"autoProcess": true,
"quickMatch": true
},
"xml": {
"name": "run"
}
},
"onsimport.BinaryFileRequest": {
"type": "object",
"properties": {
"runId": {
"type": "string",
"description": "Object identifier of the run, usually in the form of a UUID."
},
"fileName": {
"type": "string",
"description": "File name of the binary file, optionally including a path."
},
"content": {
"type": "string",
"description": "Content of the binary file.",
"format": "binary"
}
},
"description": "Contains a binary file to be added to a run in Ons Import.",
"example": {
"runId": "runwithme",
"fileName": "runwithme.pdf",
"content": "JVBERi1jb250ZW50JSVFT0Y="
},
"xml": {
"name": "binaryFileRequest"
}
},
"onsimport.RecordsXmlRequest": {
"type": "object",
"properties": {
"runId": {
"type": "string",
"description": "Object identifier of the run, usually in the form of a UUID."
},
"xml": {
"type": "string",
"description": "XML as specified by the Ons Import XSD, optionally\nBase64 encoded."
}
},
"description": "Contains records to be added to a run in Ons Import,\nformatted as XML as specified by the Ons Import XSD.",
"example": {
"runId": "runwithme",
"xml": "\nPossible values:\nSMS\nEmail\n
"
},
"allowNotifications": {
"type": "boolean",
"description": "Allows Ons Notificaties to send notifications for this type of contact method"
}
},
"description": "This class is used to update notification settings for Clients.",
"example": {
"type": "SMS",
"allowNotifications": true
}
},
"hermes.Notification": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"nullable": true,
"x-cupido-id": true
},
"uuid": {
"type": "string",
"description": "The universal unique id for this notification\nThis can be filled by the sending application, if not Hermes will generate one",
"nullable": true
},
"title": {
"type": "string",
"description": "The title displayed of this notification",
"nullable": true
},
"message": {
"type": "string",
"description": "The contents of the notification",
"nullable": true
},
"path": {
"type": "string",
"description": "The path for a given deployment where to go to when this notification is clicked",
"nullable": true
},
"deploymentType": {
"type": "string",
"description": "The deployment type where this notification refers to",
"nullable": true
},
"collapseKey": {
"type": "string",
"description": "The key used to merge notification for the same recipient and they have not been read yet",
"nullable": true
},
"collapseMethod": {
"type": "string",
"description": "The method of collapsing the notification, currently supported: collapse, replace and everything else defaults to collapse",
"nullable": true
},
"collapseTitle": {
"type": "string",
"description": "The title given to notification when more then one message with given collapse key is found\n%{count} : can be used in the String to indicate the number of messages",
"nullable": true
},
"collapseMessage": {
"type": "string",
"description": "The message given to notification when more then one message with given collapse key is found\n%{count} : can be used in the String to indicate the number of messages",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
},
"iconId": {
"type": "string",
"description": "The icon that should be showed with the notification, currently supported: \"facebook, agenda, mailbounce, password, dossier, default\"",
"nullable": true
},
"validTo": {
"type": "string",
"description": "Date and time until which the notification should be shown",
"format": "date-time",
"nullable": true
},
"priority": {
"type": "integer",
"description": "Deprecated since: 8-11-2019 - please use silent instead",
"format": "int32",
"nullable": true,
"deprecated": true,
"x-deprecated-since": "08-11-2019"
},
"silent": {
"type": "boolean",
"description": "Indicates whether the notifications should be shown in the web-interface",
"nullable": true
},
"recipient": {
"allOf": [
{
"$ref": "#/components/schemas/hermes.Recipient"
}
],
"description": "The entity (client, employee) where this notification is for"
},
"read": {
"type": "boolean",
"nullable": true
}
},
"description": "Notification model (no description)",
"example": {
"id": 1,
"uuid": "DuMMy",
"title": "spam",
"message": "You have new spam",
"path": "/spam",
"deploymentType": "PortalDeployment",
"collapseKey": "blik",
"collapseMethod": "replace",
"collapseTitle": "%{count} spam",
"collapseMessage": "You have %{count} new spam",
"createdAt": "2015-01-01T12:00:00.000+01:00",
"updatedAt": "2015-01-01T12:00:00.000+01:00",
"iconId": "default",
"validTo": "2016-01-01T12:00:00.000+01:00",
"priority": 0,
"silent": false,
"recipient": {
"clientId": 1,
"clientUuid": "abca58ed-0138-4aec-87c6-5d391e98161b",
"employeeId": 1
},
"read": true
},
"xml": {
"name": "hermesNotification"
}
},
"hermes.Recipient": {
"type": "object",
"properties": {
"clientId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"clientUuid": {
"type": "string",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
"description": "The method belongs to a recipient",
"nullable": true,
"example": {
"clientId": 1,
"clientUuid": "abca58ed-0138-4aec-87c6-5d391e98161b",
"employeeId": 1
}
},
"nexus.ClientEmployeeRelation": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"relationName": {
"type": "string",
"description": "The name of the relation type, equal to relationType.name."
},
"validFrom": {
"type": "string",
"format": "date-time"
},
"validTo": {
"type": "string",
"format": "date-time"
},
"relationType": {
"$ref": "#/components/schemas/nexus.ClientEmployeeRelationType"
},
"relationTypeId": {
"type": "integer",
"format": "int64"
},
"clientId": {
"type": "integer",
"format": "int64"
},
"employeeId": {
"type": "integer",
"format": "int64"
}
},
"description": "ClientEmployeeRelation model (no description)",
"example": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user",
"id": 5,
"relationName": "Cøach",
"validFrom": "2013-11-28T00:00:00.000+01:00",
"validTo": "2013-11-30T00:00:00.000+01:00",
"relationType": {
"id": 6,
"name": "Cøach",
"primary": true,
"exclusive": true,
"relevant": true,
"negative": false,
"active": true,
"legal": false,
"vbmResponsible": false,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user",
"id": 7,
"name": "Standard"
},
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user"
},
"relationTypeId": 6,
"clientId": 3,
"employeeId": 12
},
"xml": {
"name": "clientEmployeeRelation"
}
},
"nexus.ClientEmployeeRelationType": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/nexus.RelationType"
}
],
"description": "ClientEmployeeRelationType model (no description)",
"example": {
"id": 6,
"name": "Coach",
"tag": "tag",
"primary": true,
"exclusive": true,
"relevant": true,
"negative": false,
"active": true,
"legal": false,
"vbmResponsible": false,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user",
"id": 7,
"name": "Standard"
},
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user"
}
},
"openehr.CompositionWrapper": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/openehr.ReferenceModelObjectWrapper"
}
],
"properties": {
"uuid": {
"type": "string",
"description": "UUID of the composition, referring to the UUID of the object in Chiron."
},
"temporaryCompositionKey": {
"type": "string",
"description": "In combination with the archetype version, serves as a unique identifier for this temporary composition.",
"nullable": true
}
},
"description": "OpenEHR CompositionWrapper model, including relevant metadata.\nObject to return an CompositionWrapper, which extends from the ReferenceModelObjectWrapper\n\nSee also https://www.openehr.org/releases/BASE/latest/docs/resource/resource.html\n\nCreated on 08/06/2018.",
"example": {
"id": 1,
"ehrId": 1,
"clientId": 1,
"archetypeId": "openEHR-EHR-COMPOSITION.text_report.v1.0.0",
"storedCompositionId": 1,
"versionedCompositionUuid": "e3d332a0-27bf-42f8-8d7c-0997a9b74ae8",
"temporaryCompositionKey": "a2bc5e00-c67e-4d7e-bb87-b3b74cdefd00",
"type": "COMPOSITION",
"firstEventTime": "2018-06-08T00:00:00.000+02:00",
"composerId": 1,
"composerName": "Dhr. Mike Wazowski",
"composerEmployeeId": 1,
"timeCommitted": "2021-06-16T11:18:30.000+02:00",
"committerName": "Dhr. Mike Wazowski",
"committerEmployeeId": 1,
"authorizedForUpdate": true,
"lifecycleState": "COMPLETE",
"referenceModelObject": "{\"@type\":\"COMPOSITION\",\"archetype_details\":{\"@type\":\"ARCHETYPED\",\"archetype_id\":{\"@type\":\"ARCHETYPE_ID\",\"domain_concept\":\"text_report\",\"qualified_rm_entity\":\"openEHR-EHR-COMPOSITION\",\"rm_entity\":\"COMPOSITION\",\"rm_name\":\"EHR\",\"rm_originator\":\"openEHR\",\"value\":\"openEHR-EHR-COMPOSITION.text_report.v1.0.0\",\"versionId\":\"1.0.0\",\"full_id\":\"openEHR-EHR-COMPOSITION.text_report.v1.0.0\",\"semantic_id\":\"openEHR-EHR-COMPOSITION.text_report.v1\"},\"rm_version\":\"1.0.4\"},\"archetype_node_id\":\"id1.1\",\"category\":{\"@type\":\"DV_CODED_TEXT\",\"defining_code\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"433\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"openehr\"}},\"mappings\":[],\"value\":\"event\"},\"composer\":{\"@type\":\"PARTY_IDENTIFIED\",\"external_ref\":{\"@type\":\"PARTY_REF\",\"id\":{\"@type\":\"HIER_OBJECT_ID\",\"value\":\"com.nedap.NE0001.employee::2\"},\"namespace\":\"demographic\",\"type\":\"PERSON\"},\"identifiers\":[],\"name\":\"administrator\"},\"content\":[{\"@type\":\"OBSERVATION\",\"archetype_details\":{\"@type\":\"ARCHETYPED\",\"archetype_id\":{\"@type\":\"ARCHETYPE_ID\",\"domain_concept\":\"text_report\",\"qualified_rm_entity\":\"openEHR-EHR-OBSERVATION\",\"rm_entity\":\"OBSERVATION\",\"rm_name\":\"EHR\",\"rm_originator\":\"openEHR\",\"value\":\"openEHR-EHR-OBSERVATION.text_report.v1.0.0\",\"versionId\":\"1.0.0\",\"full_id\":\"openEHR-EHR-OBSERVATION.text_report.v1.0.0\",\"semantic_id\":\"openEHR-EHR-OBSERVATION.text_report.v1\"},\"rm_version\":\"1.0.4\"},\"archetype_node_id\":\"id0.2\",\"data\":{\"@type\":\"HISTORY\",\"archetype_node_id\":\"id2\",\"events\":[{\"@type\":\"POINT_EVENT\",\"archetype_node_id\":\"id3\",\"data\":{\"@type\":\"ITEM_TREE\",\"archetype_node_id\":\"id4\",\"items\":[{\"@type\":\"ELEMENT\",\"archetype_node_id\":\"id5\",\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Text report\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]/data[id4]/items[id5]\"}],\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]/data[id4]\"},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Point event\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]\",\"time\":{\"@type\":\"DV_DATE_TIME\",\"other_reference_ranges\":[],\"value\":\"2021-06-16T11:18:30.000+02:00\"}}],\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"\"},\"origin\":{\"@type\":\"DV_DATE_TIME\",\"other_reference_ranges\":[],\"value\":\"2021-06-16T11:18:30.000+02:00\"},\"path\":\"/content[id0.2]/data[id2]\"},\"encoding\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"UTF-8\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"IANA_character-sets\"}},\"language\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"en\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_639-1\"}},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Text report\"},\"other_participations\":[],\"path\":\"/content[id0.2]\",\"subject\":{\"@type\":\"PARTY_SELF\"}}],\"language\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"en\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_639-1\"}},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Text report\"},\"path\":\"/\",\"territory\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"NL\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_3166-1\"}}}",
"pathsAndValues": "{\"/content[id0.2]/data[id2]/events[id3]/time/value\": \"2021-06-16T11:18:30.000+02:00\", \"/content[id0.2]/data[id2]/events[id3]/data[id4]/items[id5,1]\": \"Tekst rapportage test\"}",
"authorizedEmployeeGroupsForRead": [],
"authorizedEmployeeGroupsForUpdate": [
{
"id": 57,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
},
{
"id": 58,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
}
],
"itemTags": [
{
"id": 59,
"key": "important",
"value": "value",
"targetPath": "/content[id0.1]/data[id2]/events[id3]/data[id4]/items[id5]"
}
],
"updatedAt": "2021-06-16T11:18:30.000+02:00",
"createdAt": "2018-06-08T00:00:00.000+02:00",
"createdBy": "Dhr. Mike Wazowski",
"uuid": "e3d332a0-27bf-42f8-8d7c-0997a9b74ae8",
"instructions": []
}
},
"openehr.ReferenceModelObjectWrapper": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"nullable": true,
"x-cupido-id": true
},
"ehrId": {
"type": "integer",
"description": "Integer containing the ehrId.",
"format": "int64",
"nullable": true
},
"clientId": {
"type": "integer",
"description": "Integer containing the clientId. This might be empty, since a reference model object is primarily linked to an\nehr. An EHR might not have a link to a cupido client, for example if a client is not known in Ons Administratie.",
"format": "int64",
"nullable": true
},
"archetypeId": {
"type": "string",
"description": "String containing the archetypeId of the archetype used.\nExample: \"openEHR-EHR-CLUSTER.symptom_sign.v1.0.0\"",
"nullable": true
},
"storedCompositionId": {
"type": "integer",
"description": "Long containing the storedCompositionId, referring to the id of the object in Chiron.\nInteger containing the storedCompositionId, referring to the id of the object in Chiron.",
"format": "int64",
"nullable": true
},
"versionedCompositionUuid": {
"type": "string",
"description": "UUID containing the versionedCompositionUuid, referring to the UUID of the object in Chiron."
},
"type": {
"type": "string",
"description": "String containing the type of object stored.\nExample: \"composition\", \"archetyped_object\" or \"temporary_composition\"",
"nullable": true
},
"firstEventTime": {
"type": "string",
"description": "DateTime of the first event that took place when the reference model was created.",
"format": "date-time",
"nullable": true
},
"composerId": {
"type": "integer",
"description": "Long containing the composerId, referring to the composer of the object.\nInteger containing the composerId, referring to the composer of the object.\nNote: The composer is not always the same person as the person who commits the object.",
"format": "int64",
"nullable": true
},
"composerName": {
"type": "string",
"description": "String containing the composerName, referring to the composer of the object.\nNote: The composer is not always the same person as the person who commits the object.",
"nullable": true
},
"composerEmployeeId": {
"type": "integer",
"description": "Integer containing the employeeId in Ons Administratie of the composer. This can be empty when the composer\nis not known in Ons Administratie, or when just the name was recorded.\nNote: The composer is not always the same person as the person who commits the object.",
"format": "int64",
"nullable": true
},
"timeCommitted": {
"type": "string",
"description": "Fetched from the contribution. Time that the composition was committed",
"format": "date-time",
"nullable": true
},
"committerName": {
"type": "string",
"description": "String containing the name of the committer.\nNote: The committer is not always the same person as the person who composes the object."
},
"committerEmployeeId": {
"type": "integer",
"description": "Integer containing the employeeId in Ons Administratie of the committer. This can be empty when the committer\nis not known in Ons Administratie. The name of the committer is recorded in the committerName field.\nNote: The committer is not always the same person as the person who composes the object.",
"format": "int64",
"nullable": true
},
"authorizedForUpdate": {
"type": "boolean",
"description": "Boolean to indicate that the current user is authorized to update this\ncomposition.\n\nTrue if authorizedEmployeeGroupsForUpdate is empty or the current user\nis a member of one of the authorizedEmployeeGroupsForUpdate.\n\nFalse if the user not a member of one of the\nauthorizedEmployeeGroupsForUpdate.\n\nNull if no user information is available.",
"nullable": true
},
"lifecycleState": {
"type": "string",
"description": "String containing the state of the ReferenceModelObject.\nExample: \"COMPLETE\", \"INCOMPLETE\" or \"DELETED\"",
"nullable": true
},
"referenceModelObject": {
"type": "string",
"description": "String containing the JSON-blob with the actual OpenEHR Reference Object\nThis is the actual referenceModelObject stored in Chiron, the openEHR database",
"nullable": true
},
"pathsAndValues": {
"type": "string",
"description": "String containing the summarized structure of the paths and values of an stored object.\nThis contains the same information as a fully fledged ReferenceModelObject, but combined in one data-structure.\nExample: {\n\"/content[id3]/data[id4]/items[id7]/value/defining_code\": \"at2\",\n\"/category/defining_code\": \"at1\",\n\"/content[id3]/data[id4]/items[id9]/value/value\": \"2017-11-05T13:15:30Z\",\n}",
"nullable": true
},
"authorizedEmployeeGroupsForRead": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/openehr.EmployeeGroup"
}
],
"xml": {
"name": "employeeGroup"
}
},
"description": "List of {@link EmployeeGroup}s who are by allowed to read this\ncomposition.\n\nAn empty list means all employees are allowed to read this composition.",
"nullable": true
},
"authorizedEmployeeGroupsForUpdate": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/openehr.EmployeeGroup"
}
],
"xml": {
"name": "employeeGroup"
}
},
"description": "List of {@link EmployeeGroup}s who are allowed to update this\ncomposition.\n\n\nAn empty list means all employees are allowed to update this\ncomposition.",
"nullable": true
},
"itemTags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.ItemTag"
},
"description": "List of {@link ItemTag}s connected to this ReferenceModelObject."
},
"instructions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.Instruction"
},
"description": "List of instructions in the returned composition."
}
},
"description": "OpenEHR Reference Model Object Wrapper model.\nObject to return an ReferenceModelObjectWrapper.\nThis is the superclass of every object in an EHR, such as StoredComposition, ArchetypedObject or Observation.\nIt also includes relevant metadata.\n\nSee also https://www.openehr.org/releases/BASE/latest/docs/resource/resource.html\n\nCreated on 08/06/2018.",
"example": {
"id": 1,
"ehrId": 1,
"clientId": 1,
"archetypeId": "openEHR-EHR-COMPOSITION.text_report.v1.0.0",
"storedCompositionId": 1,
"versionedCompositionUuid": "e3d332a0-27bf-42f8-8d7c-0997a9b74ae8",
"type": "COMPOSITION",
"firstEventTime": "2018-06-08T00:00:00.000+02:00",
"composerId": 1,
"composerName": "Dhr. Mike Wazowski",
"composerEmployeeId": 1,
"timeCommitted": "2021-06-16T11:18:30.000+02:00",
"committerName": "Dhr. Mike Wazowski",
"committerEmployeeId": 1,
"authorizedForUpdate": true,
"lifecycleState": "COMPLETE",
"referenceModelObject": "{\"@type\":\"COMPOSITION\",\"archetype_details\":{\"@type\":\"ARCHETYPED\",\"archetype_id\":{\"@type\":\"ARCHETYPE_ID\",\"domain_concept\":\"text_report\",\"qualified_rm_entity\":\"openEHR-EHR-COMPOSITION\",\"rm_entity\":\"COMPOSITION\",\"rm_name\":\"EHR\",\"rm_originator\":\"openEHR\",\"value\":\"openEHR-EHR-COMPOSITION.text_report.v1.0.0\",\"versionId\":\"1.0.0\",\"full_id\":\"openEHR-EHR-COMPOSITION.text_report.v1.0.0\",\"semantic_id\":\"openEHR-EHR-COMPOSITION.text_report.v1\"},\"rm_version\":\"1.0.4\"},\"archetype_node_id\":\"id1.1\",\"category\":{\"@type\":\"DV_CODED_TEXT\",\"defining_code\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"433\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"openehr\"}},\"mappings\":[],\"value\":\"event\"},\"composer\":{\"@type\":\"PARTY_IDENTIFIED\",\"external_ref\":{\"@type\":\"PARTY_REF\",\"id\":{\"@type\":\"HIER_OBJECT_ID\",\"value\":\"com.nedap.NE0001.employee::2\"},\"namespace\":\"demographic\",\"type\":\"PERSON\"},\"identifiers\":[],\"name\":\"administrator\"},\"content\":[{\"@type\":\"OBSERVATION\",\"archetype_details\":{\"@type\":\"ARCHETYPED\",\"archetype_id\":{\"@type\":\"ARCHETYPE_ID\",\"domain_concept\":\"text_report\",\"qualified_rm_entity\":\"openEHR-EHR-OBSERVATION\",\"rm_entity\":\"OBSERVATION\",\"rm_name\":\"EHR\",\"rm_originator\":\"openEHR\",\"value\":\"openEHR-EHR-OBSERVATION.text_report.v1.0.0\",\"versionId\":\"1.0.0\",\"full_id\":\"openEHR-EHR-OBSERVATION.text_report.v1.0.0\",\"semantic_id\":\"openEHR-EHR-OBSERVATION.text_report.v1\"},\"rm_version\":\"1.0.4\"},\"archetype_node_id\":\"id0.2\",\"data\":{\"@type\":\"HISTORY\",\"archetype_node_id\":\"id2\",\"events\":[{\"@type\":\"POINT_EVENT\",\"archetype_node_id\":\"id3\",\"data\":{\"@type\":\"ITEM_TREE\",\"archetype_node_id\":\"id4\",\"items\":[{\"@type\":\"ELEMENT\",\"archetype_node_id\":\"id5\",\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Text report\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]/data[id4]/items[id5]\"}],\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]/data[id4]\"},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Point event\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]\",\"time\":{\"@type\":\"DV_DATE_TIME\",\"other_reference_ranges\":[],\"value\":\"2021-06-16T11:18:30.000+02:00\"}}],\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"\"},\"origin\":{\"@type\":\"DV_DATE_TIME\",\"other_reference_ranges\":[],\"value\":\"2021-06-16T11:18:30.000+02:00\"},\"path\":\"/content[id0.2]/data[id2]\"},\"encoding\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"UTF-8\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"IANA_character-sets\"}},\"language\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"en\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_639-1\"}},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Text report\"},\"other_participations\":[],\"path\":\"/content[id0.2]\",\"subject\":{\"@type\":\"PARTY_SELF\"}}],\"language\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"en\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_639-1\"}},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Text report\"},\"path\":\"/\",\"territory\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"NL\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_3166-1\"}}}",
"pathsAndValues": "{\"/content[id0.2]/data[id2]/events[id3]/time/value\": \"2021-06-16T11:18:30.000+02:00\", \"/content[id0.2]/data[id2]/events[id3]/data[id4]/items[id5,1]\": \"Tekst rapportage test\"}",
"authorizedEmployeeGroupsForRead": [],
"authorizedEmployeeGroupsForUpdate": [
{
"id": 57,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
},
{
"id": 58,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
}
],
"itemTags": [
{
"id": 59,
"key": "important",
"value": "value",
"targetPath": "/content[id0.2]/data[id2]/events[id3]/data[id4]/items[id5]"
},
{
"id": 60,
"key": "evaluation",
"value": "value",
"targetPath": "/content[id0.2]/data[id2]/events[id3]/data[id4]/items[id7]"
}
],
"updatedAt": "2021-06-16T11:18:30.000+02:00",
"createdAt": "2018-06-08T00:00:00.000+02:00",
"createdBy": "Dhr. Mike Wazowski",
"instructions": []
}
},
"openehr.ItemTag": {
"required": [
"key"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"key": {
"type": "string",
"description": "The tag key. May not be empty or contain leading or trailing whitespace."
},
"value": {
"type": "string",
"description": "The value. If set, may not be empty."
},
"targetPath": {
"type": "string",
"description": "Optional archetype or RM path within target, used to tag a fine-grained element."
}
},
"description": "OpenEHR ItemTag, which is a tag with a key and optional value that is associated with a target ReferenceModelObjectWrapper.",
"example": {
"id": 59,
"key": "important",
"value": "value",
"targetPath": "/content[id0.1]/data[id2]/events[id3]/data[id4]/items[id5]"
}
},
"openehr.Instruction": {
"type": "object",
"properties": {
"instructionCompositionId": {
"type": "integer",
"description": "Integer containing the id of the composition containing the instruction",
"format": "int64"
},
"instructionCompositionUuid": {
"type": "string",
"description": "UUID of the composition containing the instruction",
"format": "uuid"
},
"instructionCompositionArchetypeId": {
"type": "string",
"description": "The archetype id of the composition archetype the instruction is created from."
},
"instructionArchetypeId": {
"type": "string",
"description": "The archetype id of the instruction archetype this instruction is created from."
},
"pathFromCompositionRoot": {
"type": "string",
"description": "String containing the path where the instruction is located from the root of the composition containing it."
},
"aggregatedState": {
"$ref": "#/components/schemas/openehr.InstructionState"
},
"receiverMatchesUser": {
"type": "boolean",
"description": "Boolean to indicate whether the requesing user is a receiving person or part of a receiving employee group."
},
"receivers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.Receiver"
},
"description": "List of objects containing information about the receiver of the instruction."
}
},
"description": "Contains metadata of an ons-ehr-db Instruction like it's path within a composition, the aggregated state and the receivers of the Instruction.",
"example": {
"instructionCompositionId": 1,
"instructionCompositionUuid": "e3d332a0-27bf-42f8-8d7c-0997a9b74ae8",
"instructionCompositionArchetypeId": "openEHR-EHR-COMPOSITION.generic_text_report.v1.0.0",
"instructionArchetypeId": "openEHR-EHR-INSTRUCTION.service_request-report_action.v1.0.0",
"pathFromCompositionRoot": "/content[id1]",
"aggregatedState": "TERMINATED",
"receiverMatchesUser": true,
"receivers": [
{
"personId": 1,
"employeeId": 1,
"employeeGroupId": 1,
"expertiseProfileId": 1,
"expertiseGroupId": 1,
"name": "Verpleegkundige"
},
{
"personId": 2,
"employeeId": 2,
"employeeGroupId": 2,
"expertiseProfileId": 2,
"expertiseGroupId": 2,
"name": "Verpleegkundige"
}
]
}
},
"openehr.InstructionState": {
"enum": [
"PRE_ACTIVE",
"ACTIVE",
"INACTIVE",
"TERMINATED"
],
"type": "string",
"description": "The aggregated state of the instruction.",
"example": "TERMINATED"
},
"openehr.Receiver": {
"type": "object",
"properties": {
"personId": {
"type": "integer",
"description": "The id of the receiving person as it is stored in ons-ehr-db.",
"format": "int64"
},
"employeeId": {
"type": "integer",
"description": "The id of the receiving employee as it is stored in Ons Administratie."
},
"employeeGroupId": {
"type": "integer",
"description": "The id of the employee group as it is stored in ons-ehr-db.",
"format": "int64"
},
"expertiseProfileId": {
"type": "integer",
"description": "The id of the expertise profile as it is stored in Ons Administratie.",
"format": "int64"
},
"expertiseGroupId": {
"type": "integer",
"description": "The id of the expertise group as it is stored in Ons Administratie."
},
"name": {
"type": "string",
"description": "The name of the receiving person or employee group"
}
},
"description": "Contains information about the receiving ons-ehr-db Person or EmployeeGroup.",
"example": {
"personId": 1,
"employeeId": 1,
"employeeGroupId": 1,
"expertiseProfileId": 1,
"expertiseGroupId": 1,
"name": "Verpleegkundige"
}
},
"openehr.EmployeeGroup": {
"title": "EmployeeGroup",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"nullable": true,
"x-cupido-id": true
},
"employeeGroupType": {
"type": "string",
"description": "Type of employee group, e.g. EXPERTISE_PROFILE or EXPERTISE_GROUP.",
"nullable": true
},
"originatingSystemId": {
"type": "string",
"description": "Originating system of the employee group, e.g. Administratie.",
"nullable": true
},
"originatingSystemItemId": {
"type": "string",
"description": "Id of the employee group in the originating system."
},
"parentGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.EmployeeGroup"
},
"description": "List of direct parents of the employee group."
},
"childGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.EmployeeGroup"
},
"description": "List of direct children of the employee group."
},
"name": {
"type": "string",
"description": "Name of the employee group.",
"nullable": true
},
"beginDate": {
"type": "string",
"description": "Begin date of the employee group.",
"format": "date",
"nullable": true
},
"endDate": {
"type": "string",
"description": "End date of the employee group.",
"format": "date",
"nullable": true
},
"deleted": {
"type": "boolean",
"description": "Boolean to indicate that this employee group is deleted.",
"nullable": true
},
"visible": {
"type": "boolean",
"description": "Boolean to indicate that this employee group is visible.",
"nullable": true
},
"allowDossierActions": {
"type": "boolean",
"description": "Boolean to indicate that this employee group is allowed to create reports with actions. Boolean is null if the employeeGroupType is not EXPERTISE_PROFILE.",
"nullable": true
},
"allowDossierConfidential": {
"type": "boolean",
"description": "Boolean to indicate that this employee group is allowed to create confidential reports. Boolean is null if the employeeGroupType is not EXPERTISE_PROFILE.",
"nullable": true
}
},
"description": "Employee group used for authorizations in {@link ArchetypeWrapper} and\n{@link CompositionWrapper}.\n\nEmployee groups can be based on {@link com.nedap.healthcare.domain.ExpertiseProfile}\nand {@link com.nedap.healthcare.domain.ExpertiseGroup}.",
"example": {
"id": 132,
"employeeGroupType": "EXPERTISE_GROUP",
"originatingSystemId": "Administratie",
"originatingSystemItemId": "11",
"parentGroups": [
{
"id": 57,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
}
],
"childGroups": [
{
"id": 134,
"employeeGroupType": "EXPERTISE_PROFILE",
"name": "Profile1",
"deleted": false,
"allowDossierActions": true,
"allowDossierConfidential": false
}
],
"name": "Group1",
"beginDate": "2020-05-11",
"endDate": "2020-05-25",
"deleted": false
}
},
"openehr.LifecycleState": {
"enum": [
"ABANDONED",
"COMPLETE",
"DELETED",
"INACTIVE",
"INCOMPLETE"
],
"type": "string",
"description": "The lifecycle state of a composition version.",
"example": "COMPLETE"
},
"openehr.list.ItemTagList": {
"type": "object",
"properties": {
"itemTags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.ItemTag"
}
}
},
"description": "List of openEHR ItemTags.",
"example": {
"itemTags": [
{
"id": 59,
"key": "important",
"value": "value",
"targetPath": "/content[id0.1]/data[id2]/events[id3]/data[id4]/items[id5]"
}
]
}
},
"openehr.list.ArchetypeSelectionList": {
"type": "object",
"properties": {
"archetypeSelections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.ArchetypeSelection"
}
}
},
"description": "List of archetypes and paths to request the values of",
"example": {
"archetypeSelections": [
{
"archetypeId": "openEHR-EHR-OBSERVATION.bem.v1",
"requestedPaths": [
"/data[id2]/events[id3]/time/value",
"/data[id2]/events[id3]/data[id4]/items[id31]/items[id77]/value/value"
],
"startDateTime": "2022-09-07T01:00:00.000+02:00",
"endDateTime": "2023-09-14T23:59:59.000+02:00"
},
{
"archetypeId": "openEHR-EHR-OBSERVATION.six_minute_walking_test.v1.0.0",
"requestedPaths": [
"/data[id2]/events[id3]/time/value",
"/data[id2]/events[id3]/data[id4]/items[id30]/value/magnitude"
],
"startDateTime": "2022-08-03T00:00:00.000+02:00",
"endDateTime": "2023-06-01T00:00:00.000+02:00"
}
]
}
},
"openehr.ArchetypeSelection": {
"type": "object",
"properties": {
"archetypeId": {
"type": "string",
"description": "Archetype id. Can be a archetype concept id without version number, or an archetype id with a major, minor or patch version number."
},
"requestedPaths": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of paths to request the values of. Paths will also match specializations, e.g. '/content[id4]' will also match '/content[id4.2]'."
},
"startDateTime": {
"type": "string",
"description": "When provided, only data from compositions with a first event time after the provided start date/time will be included.",
"format": "date-time"
},
"endDateTime": {
"type": "string",
"description": "When provided, only data from compositions with a first event time before the provided end date/time will be included.",
"format": "date-time"
},
"limit": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"description": "When provided, the number of results will be limited to the given value, starting with the most recent result.",
"format": "int32"
}
},
"description": "Requested archetype id and the paths to get the values for, optionally limited by a start and/or end date/time.",
"example": {
"archetypeId": "openEHR-EHR-OBSERVATION.bem.v1",
"requestedPaths": [
"/data[id2]/events[id3]/time/value",
"/data[id2]/events[id3]/data[id4]/items[id31]/items[id77]/value/value"
],
"startDateTime": "2022-09-07T01:00:00.000+02:00",
"endDateTime": "2023-09-14T23:59:59.000+02:00",
"limit": 120
}
},
"openehr.MultimediaFileCreateRequest": {
"required": [
"metadata",
"attachment"
],
"type": "object",
"properties": {
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/openehr.MultimediaFile"
}
],
"description": "A JSON object with metadata of the multimedia file"
},
"attachment": {
"type": "string",
"description": "The actual file. Supported mediaTypes are application/pdf and image/jpeg",
"format": "binary"
}
},
"description": "MultimediaFileCreateRequest model (no description)",
"example": {
"metadata": {
"updatedAt": "2019-06-17T00:00:00.000+02:00",
"createdAt": "2019-06-17T00:00:00.000+02:00",
"createdBy": "Henk",
"id": 1,
"ehrId": 2,
"clientId": 3,
"committerEmployeeId": 4,
"mediaType": "image/jpeg"
},
"attachment": ""
}
},
"openehr.MultimediaFile": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"nullable": true,
"x-cupido-id": true
},
"ehrId": {
"type": "integer",
"description": "Integer containing the ehrId.",
"format": "int64",
"nullable": true
},
"clientId": {
"type": "integer",
"description": "Integer containing the clientId. This might be empty, since a multimedia file is primarily linked to an\nEHR. An EHR might not have a link to a Cupido client, for example if a client is not known in Ons Administratie.",
"format": "int64",
"nullable": true
},
"committerEmployeeId": {
"type": "integer",
"description": "Integer containing the employeeId in Ons Administratie of the committer. This can be empty when the committer\nis not known in Ons Administratie. The name of the committer is recorded in the createdBy field.\nNote: The committer is not always the same person as the person who composes the object.",
"format": "int64",
"nullable": true
},
"mediaType": {
"type": "string",
"description": "The IANA Media Type of the file associated with this MultimediaFile",
"nullable": true
}
},
"description": "A JSON object with metadata of the multimedia file",
"example": {
"updatedAt": "2019-06-17T00:00:00.000+02:00",
"createdAt": "2019-06-17T00:00:00.000+02:00",
"createdBy": "Henk",
"id": 1,
"ehrId": 2,
"clientId": 3,
"committerEmployeeId": 4,
"mediaType": "image/jpeg"
}
},
"openehr.CompositionIdList": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
},
"description": "CompositionIdList model (no description)",
"example": {
"ids": [
101,
102,
103
]
}
},
"moves.ContainerSearchRequest": {
"title": "ContainerSearchRequest",
"required": [
"from",
"to"
],
"type": "object",
"properties": {
"from": {
"type": "string",
"description": "The date from which all the results need to be found",
"format": "date",
"nullable": false
},
"to": {
"type": "string",
"description": "The exclusive date until all the results need to be found",
"format": "date",
"nullable": false
},
"unitIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The identifiers of the units that need to be attached to the result",
"nullable": true
},
"shiftTimelineIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The timeline ids of the shifts that need to be attached to the result",
"nullable": true
},
"employeeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The identifiers of the employees that need to be attached to the result",
"nullable": true
}
},
"description": "The request body used to search for containers",
"nullable": false,
"example": {
"from": "2025-05-20",
"to": "2025-05-30",
"unitIds": [
1,
2
],
"shiftTimelineIds": [],
"employeeIds": []
}
},
"moves.EmployeeExportJob": {
"title": "EmployeeExportJob",
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"batch": {
"type": "string",
"nullable": true
},
"presenceLogsCreated": {
"type": "integer",
"format": "int32",
"nullable": true
},
"presenceLogs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PresenceLog"
},
"nullable": true
}
},
"description": "EmployeeExportJob model (no description)",
"example": {
"date": "2014-10-10",
"employeeId": 998,
"batch": "fe7ef626-81c3-4baa-8a0c-eeb00f792d0b",
"presenceLogsCreated": 15,
"presenceLogs": [
{
"activityObjectId": 999,
"duration": 100,
"reason": "Moves import",
"action": "create",
"externalId": "1",
"sourceType": "6",
"clientObjectId": 12344,
"employeeObjectId": 557,
"startDate": "2012-08-02T11:48:46.836+02:00",
"endDate": "2012-08-02T11:48:46.836+02:00",
"clusterObjectId": 1,
"registration": false,
"payment": true,
"removed": true,
"verified": false,
"hasRealTime": false,
"products": []
}
]
}
},
"PresenceLog": {
"title": "PresenceLog",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"nullable": true,
"x-cupido-id": true
},
"activityObjectId": {
"type": "integer",
"description": "The id of the {@link HourType} that is assigned to this {@code PresenceLog}. The value of this field is a bit complicated, and depends on the contents of the {@code products} field. The following rules are used, from top to bottom:\n\nIf there is exactly one PresenceLogProduct with a duration, the hour type id of that PresenceLogProduct is used If there are multiple PresenceLogProducts with a duration, 12 is used, which means 'client time' If there are no PresenceLogProducts with a duration, but exactly one with a quantity, the hour type id of that PresenceLogProduct is used If there are no PresenceLogProducts with a duration, and multiple with a quantity, or no products, no value is set",
"format": "int64"
},
"duration": {
"type": "integer",
"description": "The duration of this PresenceLog. This value is only set for PresenceLogs for which the start- and endtime don't matter; so called 'duration presence logs'. These are usually created from for example the week sheet. This value is only set if hasRealTime is false.",
"format": "int64"
},
"reason": {
"type": "string",
"description": "The user-provided reason this PresenceLog was created or modified, if available.",
"nullable": true
},
"action": {
"$ref": "#/components/schemas/PresenceLogAction"
},
"externalId": {
"type": "string",
"description": "The id of the PresenceLog in the source application of the PresenceLog.",
"nullable": true
},
"sourceType": {
"type": "string",
"description": "2: MobilePhone\n3: Manual\n4: Timesheet\n5: APriori\n6: Planning\n7: EmployeePortal\n8: Groupcare\n9: Schedule\n10: Import\n11: ImportWithOverlap\n12: Agenda\n13: NewGroupCare\n14: YsisConnector\n15: OnsDBC\n16: OnsVandaag\n17: OnsDossier",
"nullable": true
},
"clientObjectId": {
"type": "integer",
"description": "The id of the Client related to this PresenceLog.",
"format": "int64",
"nullable": true
},
"employeeObjectId": {
"type": "integer",
"description": "The id of the Employee related to this PresenceLog.",
"format": "int64",
"nullable": true
},
"careOrderObjectId": {
"type": "integer",
"description": "The id of the CareOrder related to this PresenceLog. Only set for treatment-related PresenceLogs, such as those relating to Primary Care.",
"format": "int64"
},
"date": {
"type": "string",
"description": "Date of registration.\nOnly use this for indirect presencelogs, which are not bound to a client.\nWhen date is not set, a fallback to startDate will be used.",
"format": "date-time"
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"clusterObjectId": {
"type": "integer",
"description": "The id of the Team used for cost center computation.",
"format": "int64"
},
"registration": {
"type": "boolean",
"description": "Indicates if this is a client-related registration."
},
"payment": {
"type": "boolean",
"description": "Indicates if this PresenceLog is considered for payrolling. Only if both payment and payrollingActivity are true, the presence log is actually considered for payrolling."
},
"fixedRateCompensation": {
"type": "boolean",
"description": "Indicates if this PresenceLog is compensated with a fixed rate. If true, it is not displayed as work time."
},
"payrollingActivity": {
"type": "boolean",
"description": "Indicates if the Activity or Activities attached to this presence log are considered for payrolling. This property is read-only. Only if both payment and payrollingActivity are true, the presence log is actually considered for payrolling."
},
"removed": {
"type": "boolean",
"description": "Indicates if this PresenceLog is removed."
},
"verified": {
"type": "boolean",
"description": "Indicates if this PresenceLog is verified."
},
"dossierReportUuid": {
"type": "string",
"description": "UUID of the related Dossier report."
},
"hasRealTime": {
"type": "boolean",
"description": "Indicates if this PresenceLog represents a real period with a start and end, or simply a duration (e.g. 6 hours). If this is set to true, the duration field should be ignored, if it is false the duration field should have a correct value."
},
"calculatedWorktimeAmount": {
"type": "integer",
"description": "This field contains the actual work time. This can be different if the registration is an availability shift (bereikbaarheidsdienst)\nfor example. Or if the registration is part of a group appointment. Thus, the full time is not should be split over several\nregistrations.",
"format": "int64"
},
"presenceLogLocation": {
"$ref": "#/components/schemas/PresenceLogLocation"
},
"products": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/PresenceLogProduct"
},
"nullable": false,
"xml": {
"wrapped": true
}
},
"ortHours": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PresenceLogORT"
},
"xml": {
"wrapped": true
}
},
"presenceLogPermission": {
"$ref": "#/components/schemas/PresenceLogPermission"
},
"metadata": {
"$ref": "#/components/schemas/PresenceLogMetadata"
},
"uuid": {
"type": "string",
"description": "This field contains the uuid of a registration to all related presencelogs. An example usage could be a group appointment. All presencelogs from a group appointment will have the same uuid."
}
},
"description": "PresenceLog model (no description)",
"nullable": true,
"example": {
"id": 1337,
"activityObjectId": 999,
"duration": 100,
"reason": "Moves import",
"action": "create",
"externalId": "1",
"sourceType": "6",
"clientObjectId": 12344,
"employeeObjectId": 557,
"careOrderObjectId": 123,
"date": "2012-08-02T11:48:46.836+02:00",
"startDate": "2012-08-02T11:48:46.836+02:00",
"endDate": "2012-08-02T11:48:46.836+02:00",
"clusterObjectId": 1,
"registration": false,
"payment": true,
"fixedRateCompensation": true,
"payrollingActivity": true,
"removed": true,
"verified": false,
"dossierReportUuid": "12345234900234",
"hasRealTime": false,
"calculatedWorktimeAmount": 60,
"presenceLogLocation": {
"id": 1,
"expenseTypeObjectId": 1,
"zipcode": "1234OK",
"homenumber": 2,
"homenumberExtension": "a",
"latitude": 52.22,
"longitude": 4.53
},
"products": [],
"ortHours": [],
"presenceLogPermission": {
"add_before": true,
"add_after": true,
"modify": true,
"remove": true
},
"uuid": "48b99408-f6e0-11ec-b939-0242ac120002"
},
"xml": {
"name": "presenceLog"
}
},
"PresenceLogAction": {
"type": "string",
"oneOf": [
{
"title": "CREATE",
"enum": [
"create"
]
},
{
"title": "UPDATE",
"enum": [
"update"
]
},
{
"title": "DELETE",
"enum": [
"delete"
]
}
],
"description": "PresenceLogAction model (no description)",
"nullable": true,
"example": "create"
},
"PresenceLogLocation": {
"title": "PresenceLogLocation",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"expenseTypeObjectId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"zipcode": {
"type": "string",
"description": "Please use #position instead",
"deprecated": true
},
"homenumber": {
"type": "integer",
"description": "Please use #position instead",
"format": "int32",
"deprecated": true
},
"homenumberExtension": {
"type": "string",
"description": "Please use #position instead",
"deprecated": true
},
"latitude": {
"type": "number",
"description": "Please use #position instead",
"format": "double",
"deprecated": true
},
"longitude": {
"type": "number",
"description": "Please use #position instead",
"format": "double",
"deprecated": true
},
"position": {
"$ref": "#/components/schemas/registration.Position"
}
},
"description": "PresenceLogLocation model (no description)",
"nullable": true,
"example": {
"id": 1,
"expenseTypeObjectId": 1,
"zipcode": "2602AA",
"homenumber": 13,
"homenumberExtension": "a",
"latitude": 52.03,
"longitude": 52.37,
"position": {
"city": "Amsterdam",
"homeNumber": 20,
"homeNumberExtension": "b",
"street": "Prinsengracht",
"zipCode": "1502AA",
"country": "NL",
"longitude": 32.37,
"latitude": 12.13
}
},
"xml": {
"name": "presenceLogLocation"
}
},
"PresenceLogPermission": {
"type": "object",
"properties": {
"add_before": {
"type": "boolean",
"default": false
},
"add_after": {
"type": "boolean",
"default": false
},
"modify": {
"type": "boolean",
"default": false
},
"remove": {
"type": "boolean",
"default": false
}
},
"description": "PresenceLogPermission model (no description)",
"example": {
"add_before": true,
"add_after": true,
"modify": true,
"remove": true
},
"xml": {
"name": "presenceLogPermission"
}
},
"PresenceLogMetadata": {
"type": "object",
"properties": {
"shortNotice": {
"type": "boolean",
"description": "When true, the correct short notice hour type will be added by OA",
"default": false
}
},
"description": "Metadata corresponding to the presence log",
"nullable": true,
"example": {
"shortNotice": true
}
},
"PresenceLogProduct": {
"title": "PresenceLogProduct",
"type": "object",
"properties": {
"activityObjectId": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"duration": {
"type": "integer",
"format": "int64",
"nullable": true
},
"quantity": {
"type": "integer",
"format": "int64"
},
"activityDirectOrIndirect": {
"type": "string",
"description": "Valid values for this field are: \"direct\", \"indirect\", \"indirect_client\", \"indirect_client_travel\""
},
"description": {
"type": "string"
},
"digitalCare": {
"type": "boolean",
"default": false
}
},
"description": "Product stored within {@link PresenceLog}.",
"example": {
"activityObjectId": 999,
"duration": 100,
"quantity": 1,
"activityDirectOrIndirect": "direct",
"description": "description",
"digitalCare": false
},
"xml": {
"name": "product"
}
},
"PresenceLogORT": {
"type": "object",
"properties": {
"start": {
"type": "string",
"format": "date-time"
},
"end": {
"type": "string",
"format": "date-time"
},
"percentage": {
"type": "integer",
"description": "use 'percentage_decimal' instead",
"format": "int32",
"deprecated": true
},
"percentageDecimal": {
"type": "number",
"format": "double"
},
"description": {
"type": "string"
}
},
"description": "PresenceLogORT model (no description)",
"example": {
"start": "2016-06-02T00:00:00.000+02:00",
"end": "2016-06-02T00:00:00.000+02:00",
"percentage": 0,
"percentageDecimal": 0.5,
"description": "Dummy"
},
"xml": {
"name": "ortHour"
}
},
"moves.AbsenceUpsert": {
"title": "AbsenceUpsert",
"required": [
"remoteId"
],
"type": "object",
"properties": {
"remoteId": {
"type": "string",
"description": "The unique identifier of the absence in the remote system",
"nullable": false
},
"employeeNumber": {
"type": "string",
"description": "The employee number of the employee this absence belongs to",
"nullable": false
},
"employmentNumber": {
"type": "integer",
"description": "The employment number, used when an employee has multiple employments",
"format": "int64",
"nullable": true
},
"beginDateTime": {
"type": "string",
"description": "The date and time the absence started",
"format": "date-time",
"nullable": false
},
"expectedEndDateTime": {
"type": "string",
"description": "The expected date and time the absence will end",
"format": "date-time",
"nullable": true
},
"actualEndDateTime": {
"type": "string",
"description": "The actual date and time the absence ended",
"format": "date-time",
"nullable": true
},
"absenceType": {
"$ref": "#/components/schemas/moves.AbsenceType"
}
},
"description": "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.",
"example": {
"remoteId": "12345",
"employeeNumber": "EMP001",
"employmentNumber": 1,
"beginDateTime": "2024-01-15T08:00:00.000+01:00",
"expectedEndDateTime": "2024-01-22T08:00:00.000+01:00",
"actualEndDateTime": "2024-01-22T08:00:00.000+01:00",
"absenceType": "Z"
}
},
"moves.AbsenceType": {
"enum": [
"A",
"B",
"D",
"O",
"P",
"Z",
"ZB",
"ZOD",
"ZW",
"ZZW"
],
"type": "string",
"description": "The type of absence. Possible values:\n- `A`: adoptie\n- `B`: bedrijfsongeval\n- `D`: arbeidsongeschikt_door_derde\n- `O`: overig_ongeval\n- `P`: pleegzorg\n- `Z`: ziek\n- `ZB`: ziek_als_gevolg_van_bevalling\n- `ZOD`: ziek_als_gevolg_van_orgaandonatie\n- `ZW`: zwangerschap_bevalling\n- `ZZW`: ziek_als_gevolg_van_zwangerschap\n",
"nullable": false,
"example": "Z"
},
"moves.FlexSignupRequest": {
"title": "moves.FlexSignupRequest",
"required": [
"employeeId",
"flexRequestId"
],
"type": "object",
"properties": {
"employeeId": {
"type": "string",
"description": "The external ID of the employee",
"example": "EMP123"
},
"flexRequestId": {
"type": "integer",
"description": "The ID of the flex request to sign up for",
"format": "int64",
"example": 456
}
},
"description": "FlexSignupRequest model (no description)",
"example": {
"employeeId": "EMP123",
"flexRequestId": 456
}
},
"moves.PlanCardOccurrenceAttributesRequest": {
"title": "PlanCardOccurrenceAttributesRequest",
"required": [
"date",
"occurrenceId",
"planCardChecksum",
"planCardTimelineId"
],
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The date to apply the attributes to",
"format": "date"
},
"occurrenceId": {
"type": "string",
"description": "The ID that links to this specific plan card occurrence",
"nullable": false
},
"planCardChecksum": {
"type": "string",
"description": "The url-encoded checksum used to check if planning changes are made with the correct updated data",
"nullable": false
},
"planCardTimelineId": {
"type": "integer",
"description": "The timeline id that links this plan card occurrence to the other moments that were planned in the past and in the future",
"format": "int64",
"nullable": false
},
"canceled": {
"type": "boolean",
"description": "Whether the plan card occurrence is canceled or not",
"nullable": false
}
},
"description": "Incidentally update a plan card occurrence, for example by canceling a single care moment",
"nullable": false,
"example": {
"occurrenceId": "2025-05-18--2025-05-23--98--true--1--null",
"planCardChecksum": "1:oAdyjHX3rvpvjlbc%2F4TkTunSATrXeAnjKt8.ToIBL9yq5sZzlf.D2",
"planCardTimelineId": 1,
"date": "2025-06-16",
"canceled": true
}
},
"moves.PlanCardOccurrencePlanRequest": {
"title": "PlanCardOccurrencePlanRequest",
"required": [
"date",
"occurrenceId",
"planCardChecksum",
"planCardTimelineId"
],
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "Date to plan the plan card to.",
"format": "date"
},
"occurrenceId": {
"type": "string",
"description": "The ID that links to this specific plan card occurrence",
"nullable": false
},
"planCardChecksum": {
"type": "string",
"description": "The url-encoded checksum used to check if planning changes are made with the correct updated data",
"nullable": false
},
"planCardTimelineId": {
"type": "integer",
"description": "The timeline id that links this plan card occurrence to the other moments that were planned in the past and in the future",
"format": "int64",
"nullable": false
},
"fixedStartTime": {
"pattern": "^\\d{2}:\\d{2}:\\d{2}$",
"type": "string",
"description": "The local fixed start time on which this PlanCardOccurrence should occur. This time remains the same when going through DST changes. When set to null, the start time will be calculated automatically.",
"nullable": true
},
"incidental": {
"type": "boolean",
"description": "Whether this plan action is an incidental action",
"nullable": false
},
"assignment": {
"$ref": "#/components/schemas/moves.ContainerAssignment"
},
"beforePlanCard": {
"$ref": "#/components/schemas/moves.PlanCardOccurrenceId"
},
"afterPlanCard": {
"$ref": "#/components/schemas/moves.PlanCardOccurrenceId"
}
},
"description": "Moves a single plan card to another time and order in a container",
"nullable": false,
"example": {
"occurrenceId": "2025-05-18--2025-05-23--98--true--1--null",
"planCardChecksum": "1:3AoAdyjHX3rvpvjlbc%2F4TkTunSATrXeAnjKt8.ToIBL9yq5sZzlf.D2",
"planCardTimelineId": 1,
"date": "2025-06-16",
"fixedStartTime": "12:30:00",
"assignment": {
"containerId": "|UNIT:1|EMPLOYEE:1|DAY:FRIDAY|",
"containerChecksum": "1:3A4htqjKzgaY4J23Xehi1wouSatlJVl%2FGbYQbQ%2FuQTAmQp8rpKzrvge"
},
"afterPlanCard": {
"occurrenceId": "2025-03-18--2025-05-23--20--true--4--|UNIT:1|EMPLOYEE:1|DAY:FRIDAY|",
"planCardChecksum": "1:3AGRpMLiogzgMpVz8s2MlSueNO5Wg0wZncQlt0lQfMxFDlS%2FIfYu0D6",
"planCardTimelineId": 4
},
"beforePlanCard": {
"occurrenceId": "2025-03-18--2025-05-23--54--false--2--|UNIT:1|EMPLOYEE:1|DAY:FRIDAY|",
"planCardChecksum": "1:3ALkpfLodVXYnuLpF6ClKYsu8lkXwRUP01Iaq6gNJ7VGjjhHlO%2FTl0W",
"planCardTimelineId": 2
}
}
},
"moves.ContainerAssignment": {
"title": "ContainerAssignment",
"required": [
"containerId",
"containerChecksum"
],
"type": "object",
"properties": {
"containerId": {
"type": "string",
"description": "The unique identifier that links to this specific Shift or Employee. Only used for referring to assignments.",
"nullable": false
},
"containerChecksum": {
"type": "string",
"description": "The url-encoded checksum used to check if planning changes to this container are made with the correct updated data.",
"nullable": false
}
},
"description": "An assignment of a plan card to a specific container ( shift or employee ) on a specific date. 'null' refers to being unplanned",
"nullable": true,
"example": {
"containerId": "|SHIFT:1|UNIT:1|DAY:MONDAY|",
"containerChecksum": "1:3AVMN3il5ywyQXDqzgfKITtet6kEKcnmxgKM6TDD2hLLb23SQzA685S"
}
},
"moves.PlanCardOccurrenceId": {
"title": "PlanCardOccurrenceId",
"required": [
"occurrenceId",
"planCardChecksum",
"planCardTimelineId"
],
"type": "object",
"properties": {
"occurrenceId": {
"type": "string",
"description": "The ID that links to this specific plan card occurrence",
"nullable": false
},
"planCardChecksum": {
"type": "string",
"description": "The url-encoded checksum used to check if planning changes are made with the correct updated data",
"nullable": false
},
"planCardTimelineId": {
"type": "integer",
"description": "The timeline id that links this plan card occurrence to the other moments that were planned in the past and in the future",
"format": "int64",
"nullable": false
}
},
"description": "A set of identifiers linking to a single PlanCardOccurrence with additional checksums for mutation validations.",
"nullable": false,
"example": {
"occurrenceId": "2025-05-18--2025-05-23--98--true--1--null",
"planCardChecksum": "1:3AoAdyjHX3rvpvjlbc%2F4TkTunSATrXeAnjKt8.ToIBL9yq5sZzlf.D2",
"planCardTimelineId": 1
}
},
"moves.ShiftAssignment": {
"title": "ShiftAssignment",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"nullable": true,
"x-cupido-id": true
},
"date": {
"type": "string",
"format": "date",
"nullable": true
},
"beginTime": {
"type": "string",
"description": "Effective begin time (based on the shift or incidental)",
"format": "date-time",
"nullable": true
},
"endTime": {
"type": "string",
"description": "Effective end time (based on the shift or incidental)",
"format": "date-time",
"nullable": true
},
"shiftId": {
"type": "string",
"description": "Composed from the timeline_id and date: \"413@2019-05-01\"",
"nullable": true
},
"shiftName": {
"type": "string",
"description": "Name of the shift",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"employeeLeadingName": {
"type": "string",
"nullable": true
},
"employeeName": {
"type": "string",
"nullable": true
},
"externalExpertiseProfileId": {
"type": "integer",
"description": "Effective expertise profile (based on the shift or incidentally changed)",
"format": "int64",
"nullable": true
},
"expertiseProfileName": {
"type": "string",
"description": "Name of the effective expertise profile",
"nullable": true
},
"onCall": {
"type": "boolean",
"description": "Is it an on-call (bereikbaarheidsdienst) shift",
"nullable": true
},
"timelineShiftId": {
"type": "integer",
"description": "To what shift does it belong",
"format": "int64",
"nullable": true
},
"teamId": {
"type": "integer",
"description": "To what team does it belong",
"format": "int64",
"nullable": true
},
"unitId": {
"type": "integer",
"description": "To what team does it belong",
"format": "int64",
"nullable": true,
"deprecated": true,
"x-deprecated-since": "01-06-2026"
},
"breakDuration": {
"type": "integer",
"description": "How long is the break (in minutes)",
"format": "int64",
"nullable": true
},
"incidental": {
"type": "boolean",
"description": "Has one of the following fields been changed in comparison to the original shift (begin/end time, start/stop break time and/or expertise profile).",
"nullable": true
},
"order": {
"type": "integer",
"description": "Order of ShiftAssignments if there are multiple on the same date and shift.",
"format": "int64",
"nullable": true
},
"startBreakTime": {
"type": "string",
"description": "Effective start break time (based on the shift or incidental)",
"format": "date-time",
"nullable": true
},
"stopBreakTime": {
"type": "string",
"description": "Effective stop break time (based on the shift or incidental)",
"format": "date-time",
"nullable": true
},
"discardedAt": {
"type": "string",
"description": "Shift Assignments are not hard-deleted, but marked as discarded. When the Shift Assignment is discarded, discardedAt shows when this was discarded.",
"format": "date-time",
"nullable": true
},
"exportable": {
"type": "boolean",
"description": "Indicates if this ShiftAssignnment will be exported. Only available through specific APIs.",
"nullable": true
}
},
"description": "Updated by Jurriën Gosselink on 04-03-19",
"example": {
"id": 1,
"date": "1999-12-31",
"beginTime": "1999-12-31T22:00:00.000+01:00",
"endTime": "1999-12-31T23:00:00.000+01:00",
"shiftId": "1@2014-03-28",
"shiftName": "(1) Morning",
"employeeId": 1,
"employeeLeadingName": "Jan Henk",
"employeeName": "Jan Henk Heilersig",
"externalExpertiseProfileId": 1,
"expertiseProfileName": "Verpleegkundige",
"onCall": true,
"timelineShiftId": 1654,
"unitId": 5,
"teamId": 5,
"breakDuration": 15,
"incidental": true,
"order": 0,
"startBreakTime": "1999-12-31T22:15:00.000+01:00",
"stopBreakTime": "1999-12-31T23:29:00.000+01:00",
"discardedAt": "2000-12-31T23:29:00.000+01:00",
"exportable": true
},
"xml": {
"name": "shiftAssignment"
}
},
"tasque.CareTaskGroup": {
"required": [
"namedPath"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of task group provided by source",
"readOnly": true,
"x-cupido-id": true
},
"namedPath": {
"type": "string",
"description": "Name of the task group including hierarchy when nesting via '/'"
},
"active": {
"type": "boolean",
"description": "True if task group is active globally",
"nullable": true
},
"qualityTask": {
"type": "boolean",
"description": "True if task group is active and tasks are visible in Kwaliteitsmonitor"
},
"rights": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of rights"
}
},
"description": "Group of tasks with the same subtype",
"nullable": true,
"example": {
"id": "care_plan_renew",
"namedPath": "Dossier/Care plan/renewal",
"active": true,
"qualityTask": true,
"rights": [
"client_overview"
]
}
},
"tasque.CareTaskOccurrence": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Occurrence ID, the combination of date and task id in hexidecimal format",
"x-cupido-id": true
},
"uuid": {
"type": "string",
"description": "UUID from source or autogenerated to enforce uniqueness"
},
"occurrenceDate": {
"type": "string",
"description": "Date on which the task occurs",
"format": "date"
},
"timelineId": {
"type": "integer",
"description": "Internal reference to the original task ID, mostly used for exceptions",
"format": "int64"
},
"type": {
"type": "string",
"description": "The type of the task\n\nPossible values:\nBeforeTask\nDuringTask\n
"
},
"subType": {
"type": "string",
"description": "Type of task to group multiple tasks.\nFor example care_plan_base_renew, survey_base_review, profile etc."
},
"subTypeId": {
"type": "string",
"description": "ID to uniquely identify the task in the subType.\nFor example in care_plan_base_renew the client id and for survey_base_review the survey id, etc."
},
"manual": {
"type": "boolean",
"description": "Manual tasks are allowed to mark as finished manually"
},
"limitView": {
"type": "boolean",
"description": "True if the task should only be visible to the executors"
},
"name": {
"type": "string",
"description": "The title of the task"
},
"comment": {
"type": "string",
"description": "A comment added to a task"
},
"url": {
"type": "string",
"description": "URL to where the task can be executed"
},
"validFrom": {
"type": "string",
"description": "Begin date of the task",
"format": "date"
},
"validTo": {
"type": "string",
"description": "End date of the task",
"format": "date"
},
"recurrenceType": {
"allOf": [
{
"$ref": "#/components/schemas/RecurrenceType"
}
],
"description": "If and when the task should reoccure\n\nsingle\ndaily\nweekly\nmonthly_on_day\nmonthly_on_week\nyearly\n
"
},
"startAfter": {
"type": "string",
"description": "The time on the validFrom date the task should be started to be executed",
"format": "time"
},
"finishBefore": {
"type": "string",
"description": "The time on the validTo date the task should be finished before",
"format": "time"
},
"expectedDuration": {
"type": "integer",
"description": "Expected duration of task in seconds",
"format": "int32"
},
"monday": {
"type": "boolean",
"description": "True if task happens on Monday"
},
"tuesday": {
"type": "boolean",
"description": "True if task happens on Tuesday"
},
"wednesday": {
"type": "boolean",
"description": "True if task happens on Wednesday"
},
"thursday": {
"type": "boolean",
"description": "True if task happens on Thursday"
},
"friday": {
"type": "boolean",
"description": "True if task happens on Friday"
},
"saturday": {
"type": "boolean",
"description": "True if task happens on Saturday"
},
"sunday": {
"type": "boolean",
"description": "True if task happens on Sunday"
},
"cycleInterval": {
"type": "integer",
"description": "The interval of the cycle based on the recurrence type",
"format": "int32",
"default": 0
},
"cycleBase": {
"type": "string",
"description": "Date on which the task cycle starts",
"format": "date"
},
"subject": {
"allOf": [
{
"$ref": "#/components/schemas/tasque.Subject"
}
],
"description": "A client, employee, location or team"
},
"executors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tasque.Executor"
},
"description": "A list of employees, locations, teams, expertise profiles or expertise groups"
},
"creatorId": {
"type": "integer",
"description": "ID of the person who created the task",
"format": "int64"
},
"finishDate": {
"type": "string",
"description": "The date on which the task was finished",
"format": "date"
},
"finisherId": {
"type": "integer",
"description": "ID of the person who finished the task",
"format": "int64"
},
"careTaskGroup": {
"allOf": [
{
"$ref": "#/components/schemas/tasque.CareTaskGroup"
}
],
"description": "Group of tasks with the same subtype"
},
"autoExpireAfter": {
"type": "integer",
"format": "int64"
},
"expiredDate": {
"type": "string",
"format": "date"
},
"morning": {
"type": "boolean",
"description": "True if task should happen in the morning"
},
"afternoon": {
"type": "boolean",
"description": "True is task should happen in the afternoon"
},
"evening": {
"type": "boolean",
"description": "True is task should happen in the evening"
},
"night": {
"type": "boolean",
"description": "True is task should happen in the night"
},
"userAuthorized": {
"type": "boolean",
"description": "True if the user is authorized to see the content of the task"
},
"rights": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of rights"
},
"hideExpiredSubject": {
"type": "boolean"
}
},
"description": "Care Task occurrence domain model used by Cupido system. Only used for read, update and deleting existing care tasks",
"example": {
"id": "123f3e3",
"uuid": "abca58ed-0138-4aec-87c6-5d391e98161b",
"occurrenceDate": "2012-08-02",
"timelineId": 1,
"type": "during",
"subType": "CarePlan",
"subTypeId": "12",
"manual": true,
"limitView": true,
"name": "Renew care plan",
"comment": "no comment",
"url": "/client/view/13/careplan",
"validFrom": "2012-08-02",
"validTo": "2012-09-02",
"recurrenceType": "single",
"startAfter": "12:00:00.000",
"finishBefore": "16:00:00.000",
"expectedDuration": 120,
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true,
"sunday": true,
"cycleInterval": 1,
"cycleBase": "2010-01-01",
"subject": {
"clientId": 13
},
"executors": [
{
"employeeId": 1
}
],
"creatorId": 12,
"finishDate": "2012-08-03",
"finisherId": 12,
"careTaskGroup": {
"id": "care_plan_renew",
"namedPath": "Dossier/Care plan/renewal",
"qualityTask": true
},
"autoExpireAfter": 5,
"expiredDate": "2016-09-06",
"morning": true,
"afternoon": true,
"evening": true,
"night": true,
"userAuthorized": true,
"rights": [
"client_overview"
],
"hideExpiredSubject": true
}
},
"tasque.Executor": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"locationId": {
"type": "integer",
"format": "int64"
},
"teamId": {
"type": "integer",
"format": "int64"
},
"expertiseProfileId": {
"type": "integer",
"format": "int64"
},
"expertiseGroupId": {
"type": "integer",
"format": "int64"
}
},
"description": "Executor model (no description)",
"example": {
"employeeId": 1,
"locationId": 1,
"teamId": 1,
"expertiseProfileId": 1,
"expertiseGroupId": 1
}
},
"tasque.Subject": {
"type": "object",
"properties": {
"clientId": {
"type": "integer",
"format": "int64"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"locationId": {
"type": "integer",
"format": "int64"
},
"teamId": {
"type": "integer",
"format": "int64"
}
},
"description": "A client, employee, location or team",
"example": {
"clientId": 1,
"employeeId": 1,
"locationId": 1,
"teamId": 1
}
},
"tasque.CareTaskSeries": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"uuid": {
"type": "string",
"description": "UUID from source or autogenerated to enforce uniqueness",
"format": "uuid",
"nullable": true
},
"type": {
"type": "string",
"description": "The type of the task\n\nPossible values:\nBeforeTask\nDuringTask\n
"
},
"subType": {
"type": "string",
"description": "Type of task to group multiple tasks. For example care_plan_base_renew, survey_base_review, profile etc."
},
"subTypeId": {
"type": "string",
"description": "ID to uniquely identify the task in the subType.\nFor example in care_plan_base_renew the client id and for survey_base_review the survey id, etc.",
"nullable": true
},
"manual": {
"type": "boolean",
"description": "Manual tasks are allowed to mark as finished manually"
},
"limitView": {
"type": "boolean",
"description": "True if the task should only be visible to the executors"
},
"groupName": {
"type": "string"
},
"name": {
"type": "string",
"description": "The title of the task"
},
"comment": {
"type": "string",
"description": "A comment added to a task",
"nullable": true
},
"url": {
"type": "string",
"description": "URL to where the task can be executed",
"nullable": true
},
"validFrom": {
"type": "string",
"description": "Begin date of the task",
"format": "date"
},
"validTo": {
"type": "string",
"description": "End date of the task",
"format": "date"
},
"recurrenceType": {
"allOf": [
{
"$ref": "#/components/schemas/RecurrenceType"
}
],
"description": "If and when the task should reoccure\n\nsingle\ndaily\nweekly\nmonthly_on_day\nmonthly_on_week\nyearly\n
"
},
"startAfter": {
"type": "string",
"description": "The time on the validFrom date the task should be started to be executed",
"format": "time",
"nullable": true
},
"finishBefore": {
"type": "string",
"description": "The time on the validTo date the task should be finished before",
"format": "time",
"nullable": true
},
"expectedDuration": {
"type": "integer",
"description": "Expected duration of task in seconds",
"format": "int32",
"default": 0,
"nullable": true
},
"monday": {
"type": "boolean",
"description": "True if task happens on Monday"
},
"tuesday": {
"type": "boolean",
"description": "True if task happens on Tuesday"
},
"wednesday": {
"type": "boolean",
"description": "True if task happens on Wednesday"
},
"thursday": {
"type": "boolean",
"description": "True if task happens on Thursday"
},
"friday": {
"type": "boolean",
"description": "True if task happens on Friday"
},
"saturday": {
"type": "boolean",
"description": "True if task happens on Saturday"
},
"sunday": {
"type": "boolean",
"description": "True if task happens on Sunday"
},
"cycleInterval": {
"type": "integer",
"description": "The interval of the cycle based on the recurrence type",
"format": "int32",
"default": 0
},
"cycleBase": {
"type": "string",
"description": "Date on which the task cycle starts",
"format": "date",
"readOnly": true
},
"subject": {
"allOf": [
{
"$ref": "#/components/schemas/tasque.Subject"
}
],
"description": "A client, employee, location or team"
},
"executors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tasque.Executor"
},
"description": "A list of employees, locations, teams, expertise profiles or expertise groups"
},
"creatorId": {
"type": "integer",
"description": "ID of the person who created the task",
"format": "int64",
"nullable": true
},
"careTaskGroup": {
"allOf": [
{
"$ref": "#/components/schemas/tasque.CareTaskGroup"
}
],
"description": "Group of tasks with the same subtype"
},
"autoExpireAfter": {
"type": "integer",
"description": "Amount of days after which the task should automatically expire",
"format": "int64",
"nullable": true
},
"morning": {
"type": "boolean",
"description": "True if task should happen in the morning"
},
"afternoon": {
"type": "boolean",
"description": "True is task should happen in the afternoon"
},
"evening": {
"type": "boolean",
"description": "True is task should happen in the evening"
},
"night": {
"type": "boolean",
"description": "True is task should happen in the night"
},
"rights": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of rights"
},
"hideExpiredSubject": {
"type": "boolean"
}
},
"description": "Care Task series domain model used by Cupido system. Only used for creating new care tasks",
"example": {
"id": 1,
"uuid": "abca58ed-0138-4aec-87c6-5d391e98161b",
"type": "before",
"subType": "CarePlan",
"subTypeId": "12",
"manual": true,
"limitView": true,
"groupName": "groep",
"name": "Renew care plan",
"comment": "no comment",
"url": "/client/view/13/careplan",
"validFrom": "2012-08-02",
"validTo": "2012-09-02",
"recurrenceType": "single",
"startAfter": "12:00:00.000",
"finishBefore": "16:00:00.000",
"expectedDuration": 120,
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true,
"sunday": true,
"cycleInterval": 1,
"cycleBase": "2012-08-02",
"subject": {
"clientId": 13
},
"executors": [
{
"employeeId": 1
}
],
"creatorId": 12,
"careTaskGroup": {
"id": "care_plan_renew",
"namedPath": "Dossier/Care plan/renewal",
"qualityTask": true
},
"autoExpireAfter": 5,
"morning": true,
"afternoon": true,
"evening": true,
"night": true,
"rights": [
"client_overview"
],
"hideExpiredSubject": true
}
},
"zorgdomein_module.BundleWrapper": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"type": "string",
"description": "Data from original HL7 FHIR DSTU3 bundle. Contains JSON."
}
},
"description": "BundleWrapper model for transporting HL7 FHIR DSTU3 bundle data to the Zorgdomein module.",
"example": {
"data": "bundlejson"
}
},
"zorgmail_module.ZorgmailMailboxDto": {
"type": "object",
"properties": {
"accountNumber": {
"type": "string"
},
"domain": {
"type": "string"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"description": "Zorgmail Mailbox model.",
"example": {
"accountNumber": "5005132548",
"domain": "lms.lifeline.nl",
"password": "my-secret-password",
"username": "5005132548"
}
},
"carepath.Template": {
"required": [
"uuid",
"name",
"modules"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID of this template",
"x-cupido-id": true
},
"name": {
"type": "string",
"description": "The name of this template"
},
"description": {
"type": "string",
"description": "A description of this template"
},
"modules": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/carepath.ModuleTemplate"
}
],
"xml": {
"name": "moduleTemplate"
}
},
"description": "The modules in this template",
"xml": {
"wrapped": true
}
}
},
"description": "A template which may be used for creating care paths for clients using the web interface",
"example": {
"uuid": "46ff9856-a645-4764-be01-9c64668bf93b",
"name": "Dummy",
"description": "Dummy description",
"modules": [
{
"uuid": "Dummy",
"name": "Dummy",
"duration": 0,
"precededBy": "Dummy2",
"offset": 0,
"intents": [
{
"uuid": "4dc4ee6a-6b09-4245-8dd1-7aa192178280",
"timelineUuid": "1c7acb14-6d31-4b67-a999-3ed68fcbbf14",
"duration": 7,
"offset": 0,
"hourTypeId": 1,
"frequency": 3,
"quantityAmount": 4,
"quantityUnit": "HOUR",
"recurrenceInterval": 1,
"recurrenceType": "WEEK"
}
],
"templateRoot": true
}
]
},
"xml": {
"name": "template"
}
},
"carepath.ModuleTemplate": {
"required": [
"uuid",
"name",
"duration"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID of this module. May be used to reference an existing module if this module template\nis already part of another care path template",
"x-cupido-id": true
},
"name": {
"type": "string",
"description": "The name of the module"
},
"duration": {
"type": "integer",
"description": "Duration in days",
"format": "int64"
},
"precededBy": {
"type": "string",
"description": "UUID of care path module which precedes this module."
},
"offset": {
"type": "integer",
"description": "The offset in days",
"format": "int64"
},
"intents": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/carepath.IntentTemplate"
}
],
"xml": {
"name": "intentTemplate"
}
},
"description": "The templates of intents contained in this module template",
"xml": {
"wrapped": true
}
},
"templateRoot": {
"type": "boolean",
"description": "This signifies that this module template may also be used without being embedded\nin a care path template.",
"default": false,
"deprecated": true,
"x-deprecated-since": "23-09-2022"
}
},
"description": "ModuleTemplate model (no description)",
"example": {
"uuid": "Dummy",
"name": "Dummy",
"duration": 0,
"precededBy": "Dummy2",
"offset": 0,
"intents": [
{
"uuid": "4dc4ee6a-6b09-4245-8dd1-7aa192178280",
"timelineUuid": "1c7acb14-6d31-4b67-a999-3ed68fcbbf14",
"duration": 7,
"offset": 0,
"hourTypeId": 1,
"frequency": 3,
"quantityAmount": 4,
"quantityUnit": "HOUR",
"recurrenceInterval": 1,
"recurrenceType": "WEEK"
}
],
"templateRoot": true
},
"xml": {
"name": "moduleTemplate"
}
},
"carepath.IntentTemplate": {
"required": [
"timelineUuid",
"duration",
"offset",
"hourTypeId",
"frequency",
"quantityAmount",
"quantityUnit",
"recurrenceInterval",
"recurrenceType"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "Object identifier",
"x-cupido-id": true
},
"timelineUuid": {
"type": "string",
"description": "UUID for the timeline that groups this Intent with other Intents."
},
"duration": {
"type": "integer",
"description": "Duration in days",
"format": "int64"
},
"offset": {
"type": "integer",
"description": "Offset in days",
"format": "int64"
},
"hourTypeId": {
"type": "integer",
"description": "The HourType of the Intent",
"format": "int64"
},
"frequency": {
"type": "integer",
"description": "The number of times this intent is present within the recurrence interval. It can be seen as the multiplier of the\nquantity. For example in '3 times 4 hours every week', 3 is the frequency.",
"format": "int32"
},
"quantityAmount": {
"type": "integer",
"description": "The amount matching the quantity",
"format": "int32"
},
"quantityUnit": {
"type": "string",
"description": "The Intent's quantity unit, for example MINUTE or HOUR. In combination with the quantity amount, it determines the\nquantity of th the care that is intended. For example:\n- 2, HOUR means '2 hours'\n- 120, MINUTE means '120 minutes'"
},
"recurrenceInterval": {
"type": "integer",
"description": "The recurrence interval",
"format": "int32"
},
"recurrenceType": {
"type": "string",
"description": "Together with the recurrence interval, the recurrence type determines how the intent is repeated over time.\nExamples:\n- 1, WEEK corresponds to 'every week'\n- 2, DAY corresponds to 'every 2 days' or 'every other day'"
},
"sourceDescription": {
"type": "string",
"description": "Free text description."
}
},
"description": "Mostly copied from Intent, but without client information and using relative offsets.\n\n@see com.nedap.healthcare.domain.arrangement.Intent",
"example": {
"uuid": "12345",
"timelineUuid": "12344",
"duration": 0,
"offset": 0,
"hourTypeId": 12,
"frequency": 3,
"quantityAmount": 1,
"quantityUnit": "DAY_PART",
"recurrenceInterval": 1,
"recurrenceType": "WEEK",
"sourceDescription": "for someone"
},
"xml": {
"name": "intentTemplate"
}
},
"payroll.AccountEntry": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"date": {
"type": "string",
"format": "date"
},
"minutes": {
"type": "integer",
"format": "int64"
},
"reason": {
"type": "string"
},
"comment": {
"type": "string"
},
"accountTypeId": {
"type": "integer",
"format": "int64"
},
"subType": {
"$ref": "#/components/schemas/payroll.SubType"
},
"absolute": {
"type": "boolean"
},
"correction": {
"type": "boolean"
},
"verified": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"reasonAsText": {
"type": "string"
},
"includedInStartingBalance": {
"type": "boolean",
"description": "Used to mark an accountEntry that is already included in the starting balance account amount. Will only be set to true when the account entry is set on the exact same date and time as the start of the requested period."
}
},
"description": "AccountEntry model (no description)",
"example": {
"id": 1741079,
"employeeId": 3,
"date": "2015-09-03",
"minutes": 30,
"reason": "Calculated",
"comment": "Een comment op deze accountEntry",
"accountTypeId": 2,
"subType": "lfb",
"absolute": false,
"correction": false,
"verified": true,
"createdAt": "2015-09-03T00:00:00.000+02:00",
"updatedAt": "2015-09-03T00:00:00.000+02:00",
"reasonAsText": "Berekend over week 35 2015",
"includedInStartingBalance": false
}
},
"payroll.SubType": {
"type": "string",
"oneOf": [
{
"title": "NONE",
"enum": [
"none"
]
},
{
"title": "PLB",
"enum": [
"plb"
]
},
{
"title": "LFB",
"enum": [
"lfb"
]
},
{
"title": "SPECIAL_LEAVE",
"enum": [
"special leave"
]
}
],
"description": "SubType model (no description)",
"example": "none"
},
"payroll.list.AccountEntryList": {
"type": "object",
"properties": {
"accountEntries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payroll.AccountEntry"
}
}
},
"description": "AccountEntryList model (no description)",
"example": {
"accountEntries": [
{
"id": 1741079,
"employeeId": 3,
"date": "2015-09-03",
"minutes": 30,
"reason": "Calculated",
"comment": "Een comment op deze accountEntry",
"accountTypeId": 2,
"subType": "lfb",
"absolute": false,
"correction": false,
"verified": true,
"createdAt": "2015-09-03T00:00:00.000+02:00",
"updatedAt": "2015-09-03T00:00:00.000+02:00",
"reasonAsText": "Berekend over week 35 2015"
}
]
}
},
"payroll.list.AccountTypeExpireStatisticList": {
"type": "object",
"properties": {
"accountTypeExpireStatistics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payroll.AccountTypeExpireStatistic"
}
}
},
"description": "AccountTypeExpireStatisticList model (no description)",
"example": {
"accountTypeExpireStatistics": [
{
"accountTypeId": 3,
"minutes": 100,
"expirationDate": "2019-12-31",
"year": 2019,
"description": "test description"
}
]
}
},
"payroll.AccountTypeExpireStatistic": {
"type": "object",
"properties": {
"accountTypeId": {
"type": "integer",
"description": "The accountType to which the minutes that will expire on the expirationDate belong.",
"format": "int64"
},
"minutes": {
"type": "integer",
"description": "The total amount of minutes that will expire on the expirationDate.",
"format": "int32"
},
"expirationDate": {
"type": "string",
"description": "The date on which the given minutes will expire.",
"format": "date"
},
"year": {
"type": "integer",
"description": "The original year of the minutes",
"format": "int32"
},
"description": {
"type": "string"
}
},
"description": "AccountTypeExpireStatistic model (no description)",
"example": {
"accountTypeId": 3,
"minutes": 100,
"expirationDate": "2019-12-31",
"year": 2019,
"description": "test description"
}
},
"payroll.list.AccountTypeList": {
"type": "object",
"properties": {
"accountTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payroll.AccountType"
},
"xml": {
"name": "accountType"
}
}
},
"description": "AccountTypeList model (no description)",
"example": {
"accountTypes": [
{
"id": 1,
"name": "Test account type",
"importCode": "test importcode",
"type": "Vacation",
"subType": "lfb",
"priority": 1,
"expirationMonths": 12,
"startDate": "2016-01-01",
"endDate": "2016-12-31"
},
{
"id": 666,
"name": "Bovenwettelijke uren",
"importCode": "bovenwettelijk",
"type": "Vacation",
"subType": "none",
"priority": 2,
"expirationMonths": 18,
"startDate": "2015-01-01",
"endDate": "2015-12-31"
}
]
},
"xml": {
"name": "accountTypes"
}
},
"payroll.AccountType": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"name": {
"type": "string"
},
"importCode": {
"type": "string"
},
"type": {
"type": "string"
},
"subType": {
"$ref": "#/components/schemas/payroll.SubType"
},
"priority": {
"type": "integer",
"format": "int32"
},
"expirationMonths": {
"type": "integer",
"format": "int32"
},
"startDate": {
"type": "string",
"format": "date"
},
"endDate": {
"type": "string",
"format": "date"
}
},
"description": "AccountType model (no description)",
"example": {
"id": 1,
"name": "Test account type",
"importCode": "test importcode",
"type": "Vacation",
"subType": "lfb",
"priority": 1,
"expirationMonths": 12,
"startDate": "2016-01-01",
"endDate": "2016-12-31"
},
"xml": {
"name": "accountType"
}
},
"admin.BackgroundImage": {
"type": "object",
"properties": {
"isGradient": {
"type": "boolean",
"default": false
},
"backgroundPath": {
"type": "string"
},
"color": {
"type": "string"
}
},
"description": "BackgroundImage model (no description)",
"example": {
"isGradient": false,
"backgroundPath": "/hier/daar/weg.png",
"color": "#123456"
},
"xml": {
"name": "backgroundImage"
}
},
"admin.list.LicenseList": {
"type": "object",
"properties": {
"licenses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin.License"
},
"xml": {
"name": "license"
}
}
},
"description": "LicenseList model (no description)",
"example": {
"licenses": [
{
"id": 1,
"module": "FORENSIC_CARE",
"active": true
}
]
},
"xml": {
"name": "licenses"
}
},
"admin.License": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"module": {
"type": "string",
"description": "The name of the license"
},
"active": {
"type": "boolean",
"description": "Indication if the license is activated or not."
}
},
"description": "Licenses that are maintained in Ons Administratie",
"example": {
"id": 1,
"module": "FORENSIC_CARE",
"active": true
},
"xml": {
"name": "license"
}
},
"admin.LogoImage": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Free field to identify type of logo image"
}
},
"description": "Used for logo image",
"example": {
"type": "versionA"
},
"xml": {
"name": "logoImage"
}
},
"admin.Version": {
"type": "object",
"properties": {
"versionNumber": {
"type": "string"
},
"buildDate": {
"type": "string",
"format": "date"
},
"versionInfo": {
"type": "string"
}
},
"description": "Version model (no description)",
"example": {
"versionNumber": "2015.5.0",
"buildDate": "2015-06-05",
"versionInfo": "iO server version 2015.5.0 built on Fri Jun 05 10:38:31 CEST 2015"
},
"xml": {
"name": "version"
}
},
"list.AgbcodeList": {
"type": "object",
"properties": {
"agbcodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Agbcode"
},
"xml": {
"name": "agbcode"
}
}
},
"description": "AgbcodeList model (no description)",
"example": {
"agbcodes": [
{
"id": 1,
"name": "Organization name 1",
"code": "75750535",
"vatNumber": "NL123456789B01"
},
{
"id": 2,
"name": "Organization name 2",
"code": "75750537",
"vatNumber": "NL123456789B02"
}
]
},
"xml": {
"name": "agbcodes"
}
},
"Agbcode": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"vatNumber": {
"type": "string"
}
},
"description": "Agbcode model (no description)",
"example": {
"id": 1,
"name": "Organization name",
"code": "75750535",
"vatNumber": "NL123456789B01"
},
"xml": {
"name": "agbcode"
}
},
"arrangement.list.IntentPreferenceList": {
"type": "object",
"properties": {
"intentPreferences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/arrangement.IntentPreference"
},
"xml": {
"name": "intentPreference"
}
}
},
"description": "IntentPreferenceList model (no description)",
"example": {
"intentPreferences": [
{
"intent": {
"uuid": "12345",
"timelineUuid": "12344",
"clientUuid": "CLIENT_UUID",
"clientId": 24,
"beginDate": "2018-06-14",
"endDate": "2018-05-20",
"hourTypeId": 12,
"frequency": 3,
"quantityAmount": 1,
"quantityUnit": "DAY_PART",
"recurrenceInterval": 1,
"recurrenceType": "WEEK",
"sourceApp": "PLANNING",
"sourceReference": "planning/123",
"sourceDescription": "for someone",
"splittable": true
},
"timeSlot": {
"uuid": "TIME_SLOT_UUID",
"clientId": 1,
"clientUuid": "CLIENT_UUID",
"dayOfWeek": 1,
"beginAfter": "00:00:00.000",
"endBefore": "00:00:00.000"
}
},
{
"intent": {
"uuid": "12345",
"timelineUuid": "12344",
"clientUuid": "CLIENT_UUID",
"clientId": 24,
"beginDate": "2018-06-14",
"endDate": "2018-05-20",
"hourTypeId": 12,
"frequency": 3,
"quantityAmount": 1,
"quantityUnit": "DAY_PART",
"recurrenceInterval": 1,
"recurrenceType": "WEEK",
"sourceApp": "PLANNING",
"sourceReference": "planning/123",
"sourceDescription": "for someone",
"splittable": true
},
"timeSlot": {
"uuid": "TIME_SLOT_UUID",
"clientId": 1,
"clientUuid": "CLIENT_UUID",
"dayOfWeek": 1,
"beginAfter": "00:00:00.000",
"endBefore": "00:00:00.000"
}
}
]
},
"xml": {
"name": "intentPreferences"
}
},
"arrangement.IntentPreference": {
"required": [
"intent",
"timeSlot"
],
"type": "object",
"properties": {
"intent": {
"allOf": [
{
"$ref": "#/components/schemas/arrangement.Intent"
}
],
"description": "Intent of the preference"
},
"timeSlot": {
"allOf": [
{
"$ref": "#/components/schemas/arrangement.TimeSlot"
}
],
"description": "TimeSlot of the preference"
}
},
"description": "IntentPreference model (no description)",
"example": {
"intent": {
"uuid": "12345",
"timelineUuid": "12344",
"clientUuid": "CLIENT_UUID",
"clientId": 24,
"beginDate": "2018-06-14",
"endDate": "2018-05-20",
"hourTypeId": 12,
"frequency": 3,
"quantityAmount": 1,
"quantityUnit": "DAY_PART",
"recurrenceInterval": 1,
"recurrenceType": "WEEK",
"sourceApp": "PLANNING",
"sourceReference": "planning/123",
"sourceDescription": "for someone",
"splittable": true
},
"timeSlot": {
"uuid": "TIME_SLOT_UUID",
"clientId": 1,
"clientUuid": "CLIENT_UUID",
"dayOfWeek": 1,
"beginAfter": "00:00:00.000",
"endBefore": "00:00:00.000"
}
},
"xml": {
"name": "intentPreference"
}
},
"arrangement.list.StakeholderList": {
"type": "object",
"properties": {
"stakeholders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/arrangement.Stakeholder"
}
}
},
"description": "StakeholderList model (no description)",
"example": {
"stakeholders": [
{
"uuid": "AAABB",
"timelineUuid": "ABCDEF",
"intentUuid": "AAAABB"
},
{
"uuid": "AAABC",
"timelineUuid": "ABCDEF",
"intentUuid": "AAAABB"
}
]
}
},
"arrangement.list.TimeSlotList": {
"type": "object",
"properties": {
"timeSlots": {
"type": "array",
"items": {
"$ref": "#/components/schemas/arrangement.TimeSlot"
},
"xml": {
"name": "timeSlot"
}
}
},
"description": "TimeSlotList model (no description)",
"example": {
"timeSlots": [
{
"uuid": "TIME_SLOT_UUID",
"clientId": 1,
"clientUuid": "CLIENT_UUID",
"dayOfWeek": 1,
"beginAfter": "12:00:00.000",
"endBefore": "14:00:00.000"
},
{
"uuid": "TIME_SLOT_UUID",
"clientId": 1,
"clientUuid": "CLIENT_UUID",
"dayOfWeek": 2,
"beginAfter": "12:00:00.000",
"endBefore": "14:00:00.000"
}
]
},
"xml": {
"name": "timeSlots"
}
},
"expense.list.ExpenseAddressModelList": {
"type": "object",
"properties": {
"expenseAddressModels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/expense.ExpenseAddressModel"
}
}
},
"description": "List of departe location settings (ExpenseAddressModel) for an employee",
"example": {
"expenseAddressModels": [
{
"id": 124,
"beginDate": "2020-01-01",
"departureLocation": "HOME",
"endDate": "2020-01-31"
}
]
}
},
"list.VehicleAssignmentModelList": {
"type": "object",
"properties": {
"vehicleAssignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VehicleAssignmentModel"
}
}
},
"description": "VehicleAssignmentModel list",
"example": {
"vehicleAssignments": [
{
"id": 1,
"beginDate": "2010-12-02",
"endDate": "2011-01-02",
"isCompanyVehicle": false,
"employeeObjectid": 123456,
"vehicle": "CAR_GASOLINE"
},
{
"id": 2,
"beginDate": "2011-01-03",
"endDate": "2011-03-14",
"isCompanyVehicle": false,
"employeeObjectid": 123456,
"vehicle": "CAR_EV"
}
]
}
},
"capacity.list.CapacityProfileList": {
"type": "object",
"properties": {
"capacityProfiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/capacity.CapacityProfile"
},
"xml": {
"name": "capacityProfile"
}
}
},
"description": "CapacityProfileList model (no description)",
"example": {
"capacityProfiles": [
{
"id": 1,
"name": "Active profile",
"comment": "Some nice comment about this profile",
"beginDate": "2018-01-01",
"capacityCategories": [
{
"id": 1,
"name": "Capacity category",
"financeType": {
"id": 1,
"externalCode": "Dummy",
"description": "Dummy",
"userIdentifier": "Dummy",
"beginDate": "2015-01-01",
"endDate": "2019-01-01",
"systemDefined": true,
"covRequired": true,
"agbSelectionEnabled": true,
"cakDelivery": false,
"useWmoNumbering": false,
"zzpAllowed": false
},
"productObjectId": 1,
"capacityExpertiseProfileAssignments": [
{
"id": 1,
"expertiseProfileObjectId": 4,
"categoryObjectId": 3,
"minutes": 30,
"createdAt": "2018-01-01T12:00:00.000+01:00",
"updatedAt": "2018-01-01T12:00:00.000+01:00"
}
],
"capacityExpertiseGroupAssignments": [
{
"id": 1,
"expertiseGroupObjectId": 3,
"categoryObjectId": 3,
"minutes": 60,
"createdAt": "2018-01-01T12:00:00.000+01:00",
"updatedAt": "2018-01-01T12:00:00.000+01:00"
}
],
"profileObjectId": 1,
"createdAt": "2018-01-01T12:00:00.000+01:00",
"updatedAt": "2018-01-01T12:00:00.000+01:00"
}
],
"createdAt": "2018-07-18T00:00:00.000+02:00",
"updatedAt": "2018-07-18T00:00:00.000+02:00"
},
{
"id": 2,
"name": "Future profile",
"beginDate": "2018-02-01",
"createdAt": "2018-07-18T00:00:00.000+02:00",
"updatedAt": "2018-07-18T00:00:00.000+02:00"
}
]
},
"xml": {
"name": "capacityProfiles"
}
},
"capacity.CapacityProfile": {
"required": [
"name",
"beginDate"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"name": {
"type": "string"
},
"comment": {
"type": "string",
"description": "Additional optional comments for this profile."
},
"financeType": {
"allOf": [
{
"$ref": "#/components/schemas/finance.FinanceType"
}
],
"description": "{@link FinanceType} for which this profile is defined.",
"deprecated": true
},
"beginDate": {
"type": "string",
"format": "date"
},
"endDate": {
"type": "string",
"description": "End date of this profile. Can be null for never ending profile.",
"format": "date"
},
"capacityCategories": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/capacity.CapacityCategory"
},
"description": "Set of all {@link CapacityCategory} instances that this profile contains.",
"xml": {
"wrapped": true
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"description": "CapacityProfile is a profile used for capacity management. Every profile can contain multiple {@link CapacityCategory} instances.\nEvery {@link CapacityCategory} can contain multiple {@link CapacityExpertiseProfileAssignment} instances that link a {@link CapacityCategory} to an {@link com.nedap.healthcare.domain.ExpertiseProfile}\nfor a given number of minutes. Besides that, every {@link CapacityCategory} can contain multiple\n@link CapacityExpertiseGroupAssignment} instances that link a {@link CapacityCategory} to an {@link com.nedap.healthcare.domain.ExpertiseGroup}\nfor a given number of minutes. All those assignments together give an indication of the estimated capacity needed for this profile.",
"example": {
"id": 1,
"name": "Capacity profile",
"comment": "Test profile for capacity management",
"financeType": {
"id": 1,
"externalCode": "example",
"description": "example",
"userIdentifier": "example",
"beginDate": "2014-12-29",
"endDate": "2014-12-29",
"systemDefined": true,
"covRequired": true,
"agbSelectionEnabled": true,
"cakDelivery": true,
"useWmoNumbering": true,
"zzpAllowed": true,
"shape": "square",
"colorHex": "example",
"timeRange": true,
"category": 1
},
"beginDate": "2018-01-01",
"endDate": "2018-12-31",
"capacityCategories": [
{
"id": 1,
"name": "Capacity category",
"financeType": {
"id": 1,
"externalCode": "Dummy",
"description": "Dummy",
"userIdentifier": "Dummy",
"beginDate": "2015-01-01",
"endDate": "2019-01-01",
"systemDefined": true,
"covRequired": true,
"agbSelectionEnabled": true,
"cakDelivery": false,
"useWmoNumbering": false,
"zzpAllowed": false
},
"productObjectId": 1,
"profileObjectId": 1,
"createdAt": "2018-01-01T12:00:00.000+01:00",
"updatedAt": "2018-01-01T12:00:00.000+01:00"
}
],
"createdAt": "2018-01-01T12:00:00.000+01:00",
"updatedAt": "2018-01-01T12:00:00.000+01:00"
},
"xml": {
"name": "capacityProfile"
}
},
"capacity.CapacityCategory": {
"required": [
"name",
"financeType",
"productObjectId",
"profileObjectId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"name": {
"type": "string"
},
"financeType": {
"allOf": [
{
"$ref": "#/components/schemas/finance.FinanceType"
}
],
"description": "{@link FinanceType} for which this profile is defined."
},
"productObjectId": {
"type": "integer",
"description": "The objectId of the {@link com.nedap.healthcare.domain.finance.Product} instance on which this category is based.",
"format": "int64"
},
"capacityExpertiseProfileAssignments": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/capacity.CapacityExpertiseProfileAssignment"
},
"description": "Set of all {@link CapacityExpertiseProfileAssignment} instances this category contains.",
"xml": {
"wrapped": true
}
},
"capacityExpertiseGroupAssignments": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/capacity.CapacityExpertiseGroupAssignment"
},
"description": "Set of all {@link CapacityExpertiseGroupAssignment} instances this category contains.",
"xml": {
"wrapped": true
}
},
"profileObjectId": {
"type": "integer",
"description": "The objectId of the {@link CapacityProfile} that this category belongs to.",
"format": "int64"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"description": "Every CapacityCategory is defined for a single {@link FinanceType}.\nCapacityCategory is a category that can have multiple {@link CapacityExpertiseProfileAssignment} instances and multiple {@link CapacityExpertiseGroupAssignment} instances.\nEach assignment specifies how many minutes the {@link com.nedap.healthcare.domain.ExpertiseProfile} or {@link com.nedap.healthcare.domain.ExpertiseGroup} is required for this category.",
"example": {
"id": 1,
"name": "Capacity category",
"financeType": {
"id": 1,
"externalCode": "Dummy",
"description": "Dummy",
"userIdentifier": "Dummy",
"beginDate": "2015-01-01",
"endDate": "2019-01-01",
"systemDefined": true,
"covRequired": true,
"agbSelectionEnabled": true,
"cakDelivery": false,
"useWmoNumbering": false,
"zzpAllowed": false,
"shape": "square",
"colorHex": "#FFFFFF",
"timeRange": true,
"category": 2
},
"productObjectId": 1,
"capacityExpertiseProfileAssignments": [
{
"id": 1,
"expertiseProfileObjectId": 4,
"categoryObjectId": 3,
"minutes": 30,
"createdAt": "2018-01-01T12:00:00.000+01:00",
"updatedAt": "2018-01-01T12:00:00.000+01:00"
}
],
"capacityExpertiseGroupAssignments": [
{
"id": 1,
"expertiseGroupObjectId": 3,
"categoryObjectId": 3,
"minutes": 60,
"createdAt": "2018-01-01T12:00:00.000+01:00",
"updatedAt": "2018-01-01T12:00:00.000+01:00"
}
],
"profileObjectId": 1,
"createdAt": "2018-01-01T12:00:00.000+01:00",
"updatedAt": "2018-01-01T12:00:00.000+01:00"
},
"xml": {
"name": "capacityCategory"
}
},
"capacity.CapacityExpertiseProfileAssignment": {
"required": [
"expertiseProfileObjectId",
"categoryObjectId",
"minutes"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"expertiseProfileObjectId": {
"type": "integer",
"description": "The objectId of the {@link ExpertiseProfile} that is part of this assignment.",
"format": "int64"
},
"categoryObjectId": {
"type": "integer",
"description": "The objectId of the {@link CapacityCategory} that is part of this assignment.",
"format": "int64"
},
"minutes": {
"type": "integer",
"description": "Number of minutes that the {@link ExpertiseProfile} is configured for the {@link CapacityCategory}.",
"format": "int32",
"default": 0
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"description": "CapacityExpertiseProfileAssignment specifies a link between a {@link CapacityCategory} and an {@link ExpertiseProfile}.",
"example": {
"id": 1,
"expertiseProfileObjectId": 4,
"categoryObjectId": 3,
"minutes": 30,
"createdAt": "2018-01-01T12:00:00.000+01:00",
"updatedAt": "2018-01-01T12:00:00.000+01:00"
},
"xml": {
"name": "capacityExpertiseProfileAssignment"
}
},
"capacity.CapacityExpertiseGroupAssignment": {
"required": [
"expertiseGroupObjectId",
"categoryObjectId",
"minutes"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"expertiseGroupObjectId": {
"type": "integer",
"description": "The objectId of the {@link ExpertiseGroup} that is part of this assignment.",
"format": "int64"
},
"categoryObjectId": {
"type": "integer",
"description": "The objectId of the {@link CapacityCategory} that is part of this assignment.",
"format": "int64"
},
"minutes": {
"type": "integer",
"description": "Number of minutes that the {@link ExpertiseGroup} is configured for the {@link CapacityCategory}.",
"format": "int32",
"default": 0
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"description": "CapacityExpertiseProfileAssignment specifies a link between a {@link CapacityCategory} and an {@link ExpertiseGroup}.",
"example": {
"id": 1,
"expertiseGroupObjectId": 3,
"categoryObjectId": 3,
"minutes": 60,
"createdAt": "2018-01-01T12:00:00.000+01:00",
"updatedAt": "2018-01-01T12:00:00.000+01:00"
},
"xml": {
"name": "capacityExpertiseGroupAssignment"
}
},
"finance.FinanceType": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"externalCode": {
"type": "string"
},
"description": {
"type": "string"
},
"userIdentifier": {
"type": "string",
"description": "Short description"
},
"beginDate": {
"type": "string",
"format": "date"
},
"endDate": {
"type": "string",
"format": "date"
},
"systemDefined": {
"type": "boolean",
"description": "Indicates if this FinanceType was created by Nedap (=true) or if this was manually created (=false)"
},
"covRequired": {
"type": "boolean"
},
"agbSelectionEnabled": {
"type": "boolean",
"description": "Indicates if the agbcode can be manually selected (=true)"
},
"cakDelivery": {
"type": "boolean",
"description": "Indicates if this FinanceType is eligible (=true) for the CAK delivery",
"deprecated": true
},
"useWmoNumbering": {
"type": "boolean",
"description": "Indicates if this FinanceType has a beschikkingsnummer/aanvraagnummer/indicatie orgaan"
},
"zzpAllowed": {
"type": "boolean",
"description": "Indicates if this FinanceType is allowed to have ZZP products"
},
"shape": {
"allOf": [
{
"$ref": "#/components/schemas/finance.Shape"
}
],
"description": "This is the shape of the icon used in Administration"
},
"colorHex": {
"type": "string",
"description": "This is color of the shape of the icon used in Administration"
},
"timeRange": {
"type": "boolean",
"description": "If this is true this finance type works with klassen otherwise this financetype works with a timerange"
},
"category": {
"type": "integer",
"description": "\nPossible values:\n0 - Overig\n1 - AWBZ extramuraal\n2 - AWBZ intramuraal\n3 - WMO\n4 - PGB\n5 - Onderaannemer\n7 - Jeugdwet\n9 - Eigen risico\n10 - ZVW\n11 - GGZ\n
",
"format": "int32"
}
},
"description": "{@link FinanceType} for which this profile is defined.",
"example": {
"id": 1,
"externalCode": "Dummy",
"description": "Dummy",
"userIdentifier": "Dummy",
"beginDate": "2015-01-01",
"endDate": "2019-01-01",
"systemDefined": true,
"covRequired": true,
"agbSelectionEnabled": true,
"cakDelivery": false,
"useWmoNumbering": false,
"zzpAllowed": false,
"shape": "square",
"colorHex": "#FFFFFF",
"timeRange": true,
"category": 2
},
"xml": {
"name": "financeType"
}
},
"finance.Shape": {
"type": "string",
"oneOf": [
{
"title": "SQUARE",
"enum": [
"square"
]
},
{
"title": "CIRCLE",
"enum": [
"circle"
]
},
{
"title": "TRIANGLE",
"enum": [
"triangle"
]
}
],
"description": "This is the shape of the icon used in Administration",
"example": "square"
},
"list.AddressList": {
"type": "object",
"properties": {
"addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Address"
}
}
},
"description": "AddressList model (no description)",
"example": {
"addresses": [
{
"id": 1,
"beginDate": "2010-02-16",
"endDate": "2010-02-17",
"homeNumber": 4,
"homeNumberExtension": "a",
"poBoxNumber": "123a",
"street": "Parallelweg",
"city": "Groenlo",
"zipcode": "7513KC",
"municipality": "Enschede",
"country": "Netherlands",
"telephoneNumber": "053-1234567",
"telephoneCountryCode": "+31",
"telephoneNumber2": "053-1234567",
"telephoneCountryCode2": "+31",
"faxNumber": "053-1234567",
"email": "mike.wazowski@nedap.com",
"type": "3",
"typeString": "residence address",
"residentType": "?",
"personType": "1",
"personTypeString": "client",
"roomNumber": "1",
"locationDescription": "Afdeling noord",
"updatedAt": "2016-01-01T12:00:00.000+01:00",
"createdAt": "2016-01-01T12:00:00.000+01:00",
"latitude": 52.1,
"longitude": 6.9,
"situationDescription": "Woont bij ex"
},
{
"id": 1,
"beginDate": "2010-02-16",
"endDate": "2010-02-17",
"homeNumber": 4,
"homeNumberExtension": "b",
"poBoxNumber": "123a",
"street": "Parallelweg",
"city": "Groenlo",
"zipcode": "7513KC",
"municipality": "Enschede",
"country": "Netherlands",
"telephoneNumber": "053-1234567",
"telephoneCountryCode": "+31",
"telephoneNumber2": "053-1234567",
"telephoneCountryCode2": "+31",
"faxNumber": "053-1234567",
"email": "mike.wazowski@nedap.com",
"type": "3",
"typeString": "residence address",
"residentType": "?",
"personType": "1",
"personTypeString": "client",
"roomNumber": "1",
"locationDescription": "Afdeling noord",
"updatedAt": "2016-01-01T12:00:00.000+01:00",
"createdAt": "2016-01-01T12:00:00.000+01:00",
"latitude": 52.1,
"longitude": 6.9,
"situationDescription": "Sleutel bij buurman"
}
]
}
},
"list.CareProviderList": {
"type": "object",
"properties": {
"careProviders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CareProvider"
},
"xml": {
"name": "careProvider"
}
}
},
"description": "CareProviderList model (no description)",
"example": {
"careProviders": [
{
"id": 111,
"identificationNumber": "555",
"beholdenId": "333",
"companyName": "compname",
"name": "name",
"firstName": "firstname",
"initials": "initials",
"prefix": "prefix",
"gender": "F",
"comments": "comments",
"categoryObjectId": 1234,
"organisationCategoryId": 456
}
]
},
"xml": {
"name": "careProviders"
}
},
"list.ClientContactRelationTypeList": {
"type": "object",
"properties": {
"clientContactRelationTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClientContactRelationType"
}
}
},
"description": "ClientContactRelationTypeList model (no description)",
"example": {
"clientContactRelationTypes": [
{
"id": 6,
"name": "Curator",
"primary": true,
"exclusive": true,
"negative": false,
"active": true,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"id": 7,
"name": "Standard"
},
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00"
}
]
}
},
"ClientContactRelationType": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/RelationType"
}
],
"description": "ClientContactRelationType model (no description)",
"example": {
"id": 6,
"name": "Curator",
"tag": "tag",
"primary": true,
"exclusive": true,
"relevant": true,
"negative": false,
"active": true,
"legal": true,
"vbmResponsible": false,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user",
"id": 7,
"name": "Standard"
},
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user"
}
},
"list.ClientContactRelationList": {
"type": "object",
"properties": {
"clientContactRelations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClientContactRelation"
},
"xml": {
"name": "clientContactRelation"
}
}
},
"description": "ClientContactRelationList model (no description)",
"example": {
"clientContactRelations": [
{
"updatedAt": "2014-04-17T16:04:36.000+02:00",
"createdAt": "2014-04-17T16:04:36.000+02:00",
"id": 10310,
"firstName": "",
"name": "Mw. MMT 05-11-86",
"identificationNo": "",
"preferredNameType": "0",
"lastName": "05-11-86-Niemeijer",
"birthName": "05-11-86",
"partnerName": "Niemeijer",
"initials": "MMT",
"prefix": "",
"birthNamePrefix": "",
"partnerNamePrefix": "",
"gender": "F",
"clientObjectId": 30259,
"inCaseOfEmergency": false,
"comments": "Casemanager komt 1 keer per maand"
},
{
"updatedAt": "2014-04-17T14:05:26.000+02:00",
"createdAt": "2014-04-17T14:05:26.000+02:00",
"id": 10303,
"firstName": "",
"name": "Dhr. AA Groothuis",
"identificationNo": "",
"preferredNameType": "0",
"lastName": "Groothuis",
"birthName": "Groothuis",
"partnerName": "",
"initials": "AA",
"prefix": "",
"birthNamePrefix": "",
"partnerNamePrefix": "",
"gender": "M",
"clientObjectId": 30258,
"inCaseOfEmergency": true,
"comments": ""
}
]
},
"xml": {
"name": "clientContactRelations"
}
},
"list.ClientEmployeeRelationTypeList": {
"type": "object",
"properties": {
"clientEmployeeRelationTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClientEmployeeRelationType"
}
}
},
"description": "ClientEmployeeRelationTypeList model (no description)",
"example": {
"clientEmployeeRelationTypes": [
{
"id": 6,
"name": "Coach",
"primary": true,
"exclusive": true,
"negative": false,
"active": true,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"id": 7,
"name": "Standard"
},
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00"
}
]
}
},
"list.ClientAbsenceReasonList": {
"type": "object",
"properties": {
"clientAbsenceReasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClientAbsenceReason"
},
"xml": {
"name": "clientAbsenceReason"
}
}
},
"description": "ClientAbsenceReasonList model (no description)",
"example": {
"clientAbsenceReasons": [
{
"id": 42,
"reason": "aap",
"active": true
},
{
"id": 1337,
"reason": "dev",
"active": false
}
]
},
"xml": {
"name": "clientAbsenceReasons"
}
},
"list.ClientAbsenceList": {
"type": "object",
"properties": {
"clientAbsences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClientAbsence"
},
"xml": {
"name": "clientAbsence"
}
}
},
"description": "ClientAbsenceList model (no description)",
"example": {
"clientAbsences": [
{
"id": 1,
"clientId": 1,
"endDate": "2012-08-02T11:48:46.836+02:00",
"beginTime": "11:48:46.836",
"endTime": "12:48:46.836",
"note": "aap",
"sourceId": 900
},
{
"id": 2,
"clientId": 2,
"endDate": "2012-08-03T11:48:46.836+02:00",
"endTime": "12:48:46.836",
"note": "noot",
"sourceId": 901
},
{
"id": 3,
"clientId": 3,
"endDate": "2012-08-04T11:48:46.836+02:00",
"beginTime": "11:48:46.836",
"note": "mies",
"sourceId": 902
}
]
},
"xml": {
"name": "clientAbsences"
}
},
"ClientsInCare": {
"type": "object",
"properties": {
"noLongerInCareAmount": {
"type": "integer",
"format": "int32"
},
"activeInCareAmount": {
"type": "integer",
"format": "int32"
},
"inactiveInCareAmount": {
"type": "integer",
"format": "int32"
},
"waitingForCareAmount": {
"type": "integer",
"format": "int32"
},
"activeNoLongerInCareAmount": {
"type": "integer",
"format": "int32"
}
},
"description": "ClientsInCare model (no description)",
"example": {
"noLongerInCareAmount": 1,
"activeInCareAmount": 2,
"inactiveInCareAmount": 3,
"waitingForCareAmount": 4,
"activeNoLongerInCareAmount": 5
},
"xml": {
"name": "clientsInCare"
}
},
"list.CareAllocationList": {
"type": "object",
"properties": {
"careAllocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CareAllocation"
},
"xml": {
"name": "careAllocation"
}
}
},
"description": "CareAllocationList model (no description)",
"example": {
"careAllocations": [
{
"id": 1,
"clientId": 544,
"beginDate": "2016-01-01",
"endDate": "2020-01-01",
"comments": "niets te melden",
"destination": "EIGEN_OMGEVING",
"reason": "IN_CARE",
"reasonTemporary": "VAKANTIEVERLOF"
}
]
},
"xml": {
"name": "careAllocations"
}
},
"list.CareArrangementList": {
"type": "object",
"properties": {
"careArrangements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CareArrangement"
},
"xml": {
"name": "careArrangement"
}
}
},
"description": "CareArrangementList model (no description)",
"example": {
"careArrangements": [
{
"id": 1,
"clientObjectId": 7815,
"teamObjectId": 0,
"activityObjectId": 39,
"category": 1,
"beginDate": "2010-02-22T00:00:00.000+01:00",
"endDate": "2010-05-21T23:59:59.000+02:00",
"normMorning": 180,
"normAfternoon": 0,
"normEvening": 0,
"normNight": 0,
"mornings": "1 2 3 4 5",
"afternoons": "",
"evenings": "",
"nights": ""
}
]
},
"xml": {
"name": "careArrangements"
}
},
"CareArrangement": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"clientObjectId": {
"type": "integer",
"format": "int64"
},
"teamObjectId": {
"type": "integer",
"format": "int64"
},
"activityObjectId": {
"type": "integer",
"description": "Id of an activityObject, also known as hour_type",
"format": "int64"
},
"category": {
"type": "integer",
"format": "int32"
},
"beginDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
},
"normMorning": {
"type": "integer",
"format": "int32"
},
"normAfternoon": {
"type": "integer",
"format": "int32"
},
"normEvening": {
"type": "integer",
"format": "int32"
},
"normNight": {
"type": "integer",
"format": "int32"
},
"mornings": {
"type": "string"
},
"afternoons": {
"type": "string"
},
"evenings": {
"type": "string"
},
"nights": {
"type": "string"
}
},
"description": "Care arrangement domain model.",
"example": {
"id": 1,
"clientObjectId": 7815,
"teamObjectId": 0,
"activityObjectId": 39,
"category": 1,
"beginDate": "2010-02-22T01:00:00.000+01:00",
"endDate": "2010-05-22T01:59:59.000+02:00",
"normMorning": 180,
"normAfternoon": 0,
"normEvening": 0,
"normNight": 0,
"mornings": "1 2 3 4 5",
"afternoons": "1 2 3 4 5",
"evenings": "1 2 3 4 5",
"nights": "1 2 3 4 5"
},
"xml": {
"name": "careArrangement"
}
},
"list.ClientEmployeeRelationList": {
"type": "object",
"properties": {
"clientEmployeeRelations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClientEmployeeRelation"
}
}
},
"description": "ClientEmployeeRelationList model (no description)",
"example": {
"clientEmployeeRelations": [
{
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"id": 17,
"relationName": "Cach",
"validFrom": "2013-11-28T11:49:58.000+01:00",
"validTo": "2013-11-30T11:49:58.000+01:00",
"relationType": {
"id": 6,
"name": "Cach",
"primary": true,
"exclusive": true,
"negative": false,
"active": true,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"id": 7,
"name": "Standard"
},
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00"
},
"relationTypeId": 6,
"clientId": 3,
"employeeId": 12
}
]
}
},
"list.ClientCardList": {
"type": "object",
"properties": {
"clientCards": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClientCard"
}
}
},
"description": "ClientCardList model (no description)",
"example": {
"clientCards": [
{
"id": 3,
"beginDate": "2012-08-02T11:48:46.836+02:00",
"endDate": "2012-08-05T11:48:46.836+02:00",
"lastRead": "2012-09-04T11:48:46.836+02:00",
"number": "12345",
"status": "free",
"statusFromDate": "2012-02-01T11:48:46.836+01:00"
}
]
}
},
"ClientCard": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"beginDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
},
"lastRead": {
"type": "string",
"format": "date-time"
},
"number": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/TokenStatus"
},
"statusFromDate": {
"type": "string",
"format": "date-time"
}
},
"description": "Card model.",
"example": {
"id": 3,
"beginDate": "2012-08-02T13:48:46.836+02:00",
"endDate": "2012-08-05T13:48:46.836+02:00",
"lastRead": "2012-09-04T13:48:46.836+02:00",
"number": "12345",
"status": "free",
"statusFromDate": "2012-02-01T12:48:46.836+01:00"
}
},
"TokenStatus": {
"type": "string",
"oneOf": [
{
"title": "UNKNOWN",
"enum": [
"unknown"
]
},
{
"title": "FREE",
"enum": [
"free"
]
},
{
"title": "IN_USE",
"enum": [
"used"
]
},
{
"title": "BLOCKED",
"enum": [
"blocked"
]
},
{
"title": "DEFECT",
"enum": [
"defect"
]
},
{
"title": "LOST",
"enum": [
"lost"
]
}
],
"description": "TokenStatus model (no description)",
"example": "unknown"
},
"list.LocationList": {
"type": "object",
"properties": {
"locations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Location"
},
"xml": {
"name": "location"
}
}
},
"description": "LocationList model (no description)",
"example": {
"locations": [
{
"id": 1,
"beginDate": "2012-08-02T11:48:46.836+02:00",
"endDate": "2012-08-02T11:48:46.836+02:00",
"identificationNo": "1",
"name": "Nedap Demo",
"agbCode": "75750535",
"agbcodeId": 1,
"materializedPath": "1.2",
"wzaCode": "690535",
"intramuralLocation": false,
"locationType": "Locatie",
"capacity": 0,
"costCenter": "costCenter",
"roomType": "1",
"parentObjectId": 0,
"icon": 0,
"registeredLocationNumber": "123456789012",
"correspondenceName": "Pretty correspondence name",
"hideCorrespondenceName": false
}
]
},
"xml": {
"name": "locations"
}
},
"nuts.list.ConsentList": {
"type": "object",
"properties": {
"consents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nuts.Consent"
}
}
},
"description": "ConsentList model (no description)",
"example": {
"consents": [
{
"updatedAt": "2018-11-30T00:00:00.000+01:00",
"createdAt": "2018-11-30T00:00:00.000+01:00",
"createdBy": "user",
"id": 1,
"clientId": 1,
"purpose": "Het delen van medische gegevens met de huisarts.",
"careProviderId": 2,
"policy": "PERMIT_ALL",
"category": "MEDICAL",
"documentId": 1337,
"signedDocumentIds": [
1337,
1338
],
"validFrom": "2018-01-01",
"validTo": "2050-01-01",
"party": "GENERAL_PRACTITIONERS",
"goal": "EXECUTION_OF_CARE",
"subject": "MEDICAL_INFORMATION"
}
]
}
},
"nuts.Consent": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"clientId": {
"type": "integer",
"description": "Reference to the client",
"format": "int64"
},
"purpose": {
"type": "string",
"description": "A description about the consent, readable for professional and patient"
},
"careProviderId": {
"type": "integer",
"description": "A reference to the care provider, eg: a GP",
"format": "int64"
},
"policy": {
"type": "string",
"description": "The policy or outcome of the consent question: PERMIT_ALL, DENY_ALL or empty, which assumes DENY_ALL but also the exceptions must be ignored"
},
"category": {
"type": "string",
"description": "CONTACT, MEDICAL, MENTAL, in the future it might refer to FHIR (http://hl7.org/fhir/ValueSet/consent-category)"
},
"documentId": {
"type": "integer",
"description": "The latest signed document which is the proof for the consent",
"format": "int64",
"deprecated": true
},
"signedDocumentIds": {
"type": "array",
"items": {
"type": "integer",
"description": "The signed documents which are the proof for the consent",
"format": "int64",
"xml": {
"name": "signedDocumentId"
}
},
"description": "The signed documents which are the proof for the consent",
"xml": {
"wrapped": true
}
},
"validFrom": {
"type": "string",
"description": "period start where this consent is valid from, inclusive",
"format": "date"
},
"validTo": {
"type": "string",
"description": "period end where this consent is valid to, exclusive",
"format": "date"
},
"party": {
"type": "string",
"description": "The party the data may be shared with.\nPossible options include:\n- \"MEDIQUEST\"\n- \"QUALIZORG\"\n- \"GENERAL_PRACTITIONERS\"\n- \"PHARMACISTS\""
},
"goal": {
"type": "string",
"description": "Why this specific set of data is shared.\nPossible options include:\n- \"NOTIFICATION\"\n- \"SURVEY\"\n- \"EXECUTION_OF_CARE\"\n- \"LDF\""
},
"subject": {
"type": "string",
"description": "The set of data to be shared.\nPossible options include:\n- \"EMAIL\"\n- \"POSTAL_ADDRESS\"\n- \"MOBILE_PHONE_SMS\"\n- \"MEDICAL_INFORMATION\"\n- \"TREATMENT_EPISODE\"\n- \"PREM_RESULT\""
}
},
"description": "Consent model (no description)",
"example": {
"updatedAt": "2018-11-30T00:00:00.000+01:00",
"createdAt": "2018-11-30T00:00:00.000+01:00",
"createdBy": "user",
"id": 1,
"clientId": 1,
"purpose": "Het delen van medische gegevens met de huisarts.",
"careProviderId": 2,
"policy": "PERMIT_ALL",
"category": "MEDICAL",
"documentId": 1337,
"signedDocumentIds": [
1337,
1338
],
"validFrom": "2018-01-01",
"validTo": "2050-01-01",
"party": "GENERAL_PRACTITIONERS",
"goal": "EXECUTION_OF_CARE",
"subject": "MEDICAL_INFORMATION"
},
"xml": {
"name": "consent"
}
},
"list.DebtorList": {
"type": "object",
"properties": {
"debtors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Debtor"
},
"xml": {
"name": "debtor"
}
}
},
"description": "DebtorList model (no description)",
"example": {
"debtors": [
{
"id": 1,
"type": "2",
"uzoviCode": "3",
"beginDate": "2012-08-02T11:48:46.836+02:00",
"endDate": "2012-08-02T11:48:46.836+02:00",
"phone1": "4",
"phone2": "5",
"phone3": "6",
"fax": "7",
"email": "8",
"gender": "9",
"debtorNumber": "10",
"organizationName": "11",
"firstName": "12",
"lastName": "13",
"lastNameOwn": "13",
"streetName": "14",
"addressNumber": 15,
"addressNumberExt": "16",
"zipCode": "17",
"city": "18",
"sourceType": "19",
"clientObjectId": 20,
"bankAccount": {
"id": 21,
"number": "NL27TRIO0207182531",
"nameOfOwner": "Pietje Puk",
"cityOfOwner": "Lutjebroek"
},
"paymentMethod": "26",
"closedAt": "2012-08-02T11:48:46.836+02:00",
"hidden": true,
"invoicePerEmail": false
}
]
},
"xml": {
"name": "debtors"
}
},
"list.DocumentList": {
"type": "object",
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Document"
},
"xml": {
"name": "document"
}
}
},
"description": "DocumentList model (no description)",
"example": {
"documents": [
{
"id": 88,
"employeeObjectId": 10,
"clientObjectId": 2,
"description": "Dit is een test",
"rightSelection": "Group",
"expertiseProfiles": [
{
"id": 1
},
{
"id": 2
}
],
"expertiseGroups": [
{
"id": 1
}
],
"tags": [
"test",
"Een tweede tag"
]
},
{
"id": 162,
"employeeObjectId": 11,
"clientObjectId": 2,
"description": "Dit is een test",
"rightSelection": "Group",
"expertiseProfiles": [
{
"id": 1
},
{
"id": 4
}
],
"expertiseGroups": [
{
"id": 1
}
],
"tags": [
"Een tweede tag"
]
}
]
},
"xml": {
"name": "documents"
}
},
"list.InsuranceList": {
"type": "object",
"properties": {
"insurances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insurance"
},
"xml": {
"name": "insurance"
}
}
},
"description": "InsuranceList model (no description)",
"example": {
"insurances": [
{
"id": 1,
"registrationNumber": "1",
"clientObjectId": 1234,
"debtorObjectId": 4321,
"sourceType": 1,
"insuranceType": "AV",
"packageCode": "001T0",
"packageName": "Top geen Tandarts",
"labelCode": "001",
"labelName": "Salland Zorgverzekeringen",
"requestedDate": "2012-08-02",
"clientIsDead": false,
"comments": "comments",
"beginDate": "2022-01-01T08:00:00.000+01:00",
"createdAt": "2012-08-02T11:48:46.836+02:00",
"updatedAt": "2012-08-02T11:48:46.836+02:00"
}
]
},
"xml": {
"name": "insurances"
}
},
"list.LocationAssignmentList": {
"type": "object",
"properties": {
"locationAssignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LocationAssignment"
},
"xml": {
"name": "locationAssignment"
}
}
},
"description": "LocationAssignmentList model (no description)",
"example": {
"locationAssignments": [
{
"id": 1,
"beginDate": "2012-08-02",
"endDate": "2012-08-02",
"locationAssignmentType": "MAIN",
"mainLocation": true
}
]
},
"xml": {
"name": "locationAssignments"
}
},
"list.PresenceLogList": {
"type": "object",
"properties": {
"presenceLogs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PresenceLog"
},
"xml": {
"name": "presenceLog"
}
}
},
"description": "PresenceLogList model (no description)",
"example": {
"presenceLogs": [
{
"id": 1234,
"activityObjectId": 999,
"duration": 100,
"reason": "Moves import",
"action": "create",
"externalId": "1",
"sourceType": "6",
"clientObjectId": 12344,
"employeeObjectId": 557,
"careOrderObjectId": 123,
"startDate": "2012-08-02T11:48:46.000+02:00",
"endDate": "2012-08-02T11:48:46.000+02:00",
"clusterObjectId": 1
}
]
},
"xml": {
"name": "presenceLogs"
}
},
"list.LocationAssignmentWaitingListList": {
"type": "object",
"properties": {
"locationAssignmentWaitingLists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LocationAssignmentWaitingList"
},
"xml": {
"name": "locationAssignmentWaitingList"
}
}
},
"description": "LocationAssignmentWaitingListList model (no description)",
"example": {
"locationAssignmentWaitingLists": [
{
"id": 1,
"beginDate": "2012-08-02",
"beginTime": "10:11:00.000",
"endDate": "2012-08-02",
"endTime": "12:13:00.000",
"clientObjectId": 2,
"locationObjectId": 3,
"moveDate": "2012-08-02",
"locationAssignmentType": "WAITING_LIST",
"residence": false,
"mainLocation": false,
"medicineLocation": false,
"waitingFor": "BESCHIKBARE_PLEK",
"status": "ACTIEF_PLAATSEN",
"description": "Client wacht met smart. Contact direct met client, niet via ouders.",
"classification": "DREIGENDE_CRISIS_THUIS",
"closingReason": "GEPLAATST"
}
]
},
"xml": {
"name": "locationAssignmentWaitingLists"
}
},
"list.ClientList": {
"type": "object",
"properties": {
"clients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Client"
},
"nullable": true,
"xml": {
"name": "client"
}
}
},
"description": "ClientList model (no description)",
"example": {
"clients": [
{
"id": 1,
"firstName": "Mike",
"dateOfBirth": "2012-08-02",
"birthName": "Wazowski"
}
]
},
"xml": {
"name": "clients"
}
},
"list.ClientSearchResultList": {
"type": "object",
"properties": {
"clientSearchResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClientSearchResult"
},
"xml": {
"name": "clientSearchResult"
}
}
},
"description": "ClientSearchResultList model (no description)",
"example": {
"clientSearchResults": [
{
"id": 1929,
"identificationNo": "7777777",
"name": "Dhr. PJ Paulusma",
"firstName": "Pieter Johan",
"lastName": "Paulusma",
"givenName": "Piet",
"gender": "M",
"dateOfBirth": "1956-12-31",
"secretClient": false,
"addressString": "Dorpstraat 1, Het Dorp",
"birthName": "Paulusma",
"partnerName": "none",
"birthNamePrefix": "none",
"partnerNamePrefix": "none",
"initials": "PJ",
"preferredNameType": "birthname",
"group": "UNGROUPED"
}
]
},
"xml": {
"name": "clientSearchResults"
}
},
"ClientSearchResult": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "the id of this object",
"format": "int64",
"x-cupido-id": true
},
"identificationNo": {
"type": "string",
"description": "The client number for this Client; e.g. \"234567\""
},
"name": {
"type": "string",
"description": "The full name of this client; e.g. \"Petrus Johannes Paulusma\""
},
"firstName": {
"type": "string",
"description": "This Client's first name; e.g. \"Petrus Johannes\""
},
"lastName": {
"type": "string",
"description": "This Client's last name; e.g. \"Paulusma\""
},
"givenName": {
"type": "string",
"description": "This Client's given name; e.g. \"Piet\""
},
"gender": {
"type": "string",
"description": "This Client's gender; can be male, female or unknown"
},
"pronouns": {
"type": "string",
"description": "This Client's pronouns; e.g. \"zij/haar\", \"hij/zijn\" etc. "
},
"preferredName": {
"type": "string",
"description": "Preferred name of this client. In case a client prefers a different name over the official name; e.g. \"Petra Paulusma\""
},
"dateOfBirth": {
"type": "string",
"description": "Date of birth, formatted yyyy-mm-dd",
"format": "date"
},
"secretClient": {
"type": "boolean",
"description": "Boolean for celebrities"
},
"addressString": {
"type": "string",
"description": "This Client's address; e.g. \"Parallelweg 2, 7141 DC, Groenlo\""
},
"birthName": {
"type": "string",
"description": "This Client's surname at birth"
},
"partnerName": {
"type": "string",
"description": "This Client's partner's surname at birth"
},
"birthNamePrefix": {
"type": "string",
"description": "This Client's prefix; e.g. \"van\""
},
"partnerNamePrefix": {
"type": "string",
"description": "This client's partner's prefix; e.g. \"van de\""
},
"initials": {
"type": "string",
"description": "This Client's initials; e.g. \"PJ\""
},
"preferredNameType": {
"type": "string",
"description": "This Client's preferred name type; e.g. \"partnerName\""
},
"group": {
"allOf": [
{
"$ref": "#/components/schemas/ClientSearchResultGroup"
}
],
"description": "The group to which this result belongs.\nThis is only set after calling the 'searchGrouped' API.",
"default": "UNGROUPED"
}
},
"description": "Search Result after querying OnsAdmin",
"example": {
"id": 1,
"identificationNo": "12345",
"name": "Dhr. PJ Paulusma",
"firstName": "Pieter Johan",
"lastName": "Paulusma",
"givenName": "Piet",
"gender": "M",
"pronouns": "zij/haar",
"preferredName": "Petra Paulusma",
"dateOfBirth": "1956-12-31",
"secretClient": false,
"addressString": "Dorpstraat 1, Het Dorp",
"birthName": "Paulusma",
"partnerName": "none",
"birthNamePrefix": "none",
"partnerNamePrefix": "none",
"initials": "PJ",
"preferredNameType": "0",
"group": "WAITINGLIST"
},
"xml": {
"name": "clientSearchResult"
}
},
"ClientSearchResultGroup": {
"type": "string",
"oneOf": [
{
"title": "UNGROUPED",
"enum": [
"UNGROUPED"
]
},
{
"title": "EXACT",
"enum": [
"EXACT"
]
},
{
"title": "BEGINNING",
"enum": [
"BEGINNING"
]
},
{
"title": "WILDCARD",
"enum": [
"WILDCARD"
]
},
{
"title": "WAITINGLIST",
"enum": [
"WAITINGLIST"
]
},
{
"title": "OUTOFCARE",
"enum": [
"OUTOFCARE"
]
}
],
"description": "The group to which this result belongs.\nThis is only set after calling the 'searchGrouped' API.",
"example": "UNGROUPED"
},
"list.ClientObjectIdList": {
"type": "object",
"properties": {
"clientObjectIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClientObjectId"
}
}
},
"description": "List of clientObjectIds",
"example": {
"clientObjectIds": [
{
"value": 54321
},
{
"value": 42
}
]
},
"xml": {
"name": "clientObjectIds"
}
},
"ClientObjectId": {
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"type": "integer",
"format": "int64"
}
},
"description": "id of a Client object",
"example": {
"value": 54321
}
},
"payroll.list.CollectiveAgreementAssignmentList": {
"type": "object",
"properties": {
"collectiveAgreementAssignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payroll.CollectiveAgreementAssignment"
}
}
},
"description": "CollectiveAgreementAssignmentList model (no description)",
"example": {
"collectiveAgreementAssignments": [
{
"id": 1,
"employeeId": 1,
"collectiveAgreementId": 1,
"beginDate": "2015-01-01",
"endDate": "2020-01-01"
}
]
}
},
"payroll.CollectiveAgreementRule": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"collectiveAgreementId": {
"type": "integer",
"format": "int64"
},
"beginDate": {
"type": "string",
"format": "date"
},
"endDate": {
"type": "string",
"format": "date"
},
"calculateTravelTime": {
"type": "boolean"
}
},
"description": "CollectiveAgreementRule model\n\nCreated on 06/05/21.",
"example": {
"id": 1,
"collectiveAgreementId": 1,
"beginDate": "2015-01-01",
"endDate": "2020-01-01",
"calculateTravelTime": true
},
"xml": {
"name": "collectiveAgreementRule"
}
},
"payroll.list.CollectiveAgreementRuleList": {
"type": "object",
"properties": {
"collectiveAgreementRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payroll.CollectiveAgreementRule"
}
}
},
"description": "CollectiveAgreementRuleList model (no description)",
"example": {
"collectiveAgreementRules": [
{
"id": 1,
"collectiveAgreementId": 1,
"beginDate": "2015-01-01",
"endDate": "2020-01-01",
"calculateTravelTime": true
}
]
}
},
"payroll.list.CollectiveAgreementList": {
"type": "object",
"properties": {
"collectiveAgreements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payroll.CollectiveAgreement"
},
"xml": {
"name": "collectiveAgreement"
}
}
},
"description": "CollectiveAgreementList model (no description)",
"example": {
"collectiveAgreements": [
{
"id": 1,
"name": "Thuiszorg (extramuraal) - 2014"
}
]
},
"xml": {
"name": "collectiveAgreements"
}
},
"payroll.CollectiveAgreement": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"name": {
"type": "string"
}
},
"description": "CollectiveAgreement model\n\nCreated on 06/05/21.",
"example": {
"id": 1,
"name": "Thuiszorg (extramuraal) - 2014"
},
"xml": {
"name": "collectiveAgreement"
}
},
"payroll.ContractType": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"name": {
"type": "string"
},
"importCode": {
"type": "string"
},
"payHoursDirectly": {
"type": "boolean"
},
"removed": {
"type": "boolean"
}
},
"description": "ContractType model\n\nCreated on 22/04/15.",
"example": {
"id": 1,
"name": "Dummy",
"importCode": "Dummy",
"payHoursDirectly": true,
"removed": true
},
"xml": {
"name": "contractType"
}
},
"list.CostCenterSelectionOptionList": {
"type": "object",
"properties": {
"costCenterSelectionOptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CostCenterSelectionOption"
},
"xml": {
"name": "costCenterSelectionOption"
}
}
},
"description": "CostCenterSelectionOptionList model (no description)",
"example": {
"costCenterSelectionOptions": [
{
"clusterObjectId": 5000,
"category": "OWN_TEAM",
"name": "Carstens Team",
"identificationNumber": "AB12"
},
{
"clusterObjectId": 5001,
"category": "CLIENT_COSTCENTER",
"name": "Backoffice",
"identificationNumber": "CD34"
},
{
"clusterObjectId": 5002,
"category": "OTHER",
"name": "Nedap Healthcare",
"identificationNumber": "EF56"
},
{
"clusterObjectId": 5003,
"category": "OTHER",
"name": "Nedap Livestock",
"identificationNumber": "XZ78"
}
]
},
"xml": {
"name": "costCenterSelectionOptions"
}
},
"CostCenterSelectionOption": {
"type": "object",
"properties": {
"clusterObjectId": {
"type": "integer",
"format": "int32",
"x-cupido-id": true
},
"category": {
"allOf": [
{
"$ref": "#/components/schemas/CostCenterSelectionOptionCategory"
}
],
"description": "A category about the cost center; can be COMMON/OWN_TEAM/CLIENT_COSTCENTER/OTHER."
},
"name": {
"type": "string",
"description": "Name"
},
"identificationNumber": {
"type": "string",
"description": "Identification number"
}
},
"description": "CostCenterSelectionOption model (no description)",
"example": {
"clusterObjectId": 5000,
"category": "OWN_TEAM",
"name": "Carstens Team",
"identificationNumber": "AB12"
},
"xml": {
"name": "costCenterSelectionOption"
}
},
"CostCenterSelectionOptionCategory": {
"enum": [
"COMMON",
"OWN_TEAM",
"CLIENT_COSTCENTER",
"OTHER"
],
"type": "string",
"description": "A category about the cost center; can be COMMON/OWN_TEAM/CLIENT_COSTCENTER/OTHER.",
"example": "OTHER"
},
"list.DashboardProfileList": {
"type": "object",
"properties": {
"dashboardProfiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DashboardProfile"
}
}
},
"description": "List of dashboard profiles",
"example": {
"dashboardProfiles": [
{
"id": 1,
"name": "Intramuraal"
}
]
},
"xml": {
"name": "dashboardProfiles"
}
},
"DashboardProfile": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The objectId of this dashboard profile",
"format": "int64",
"x-cupido-key": true
},
"name": {
"type": "string",
"description": "The name of this dashboard profile"
}
},
"description": "Dashboard profile in Ons Administratie",
"example": {
"id": 1,
"name": "Intramuraal"
},
"xml": {
"name": "dashboardProfile"
}
},
"dbc.DBCSubTraject": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"source": {
"type": "string"
},
"dbcIdentifier": {
"type": "string"
},
"clientId": {
"type": "integer",
"format": "int64"
},
"clientIdentifier": {
"type": "string"
},
"financeTypeId": {
"type": "integer",
"format": "int64"
},
"contactPerson": {
"type": "string"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
},
"issueDate": {
"type": "string",
"format": "date-time"
},
"startDateClipped": {
"type": "string",
"format": "date-time"
},
"endDateClipped": {
"type": "string",
"format": "date-time"
},
"debtorId": {
"type": "integer",
"format": "int64"
},
"comments": {
"type": "string"
},
"dbcDiagnosisCode": {
"type": "string"
},
"endOfCare": {
"type": "string",
"format": "date-time"
},
"afsluitingsCode": {
"type": "string"
},
"zorgTypeCode": {
"type": "string"
},
"resignationDestination": {
"type": "string",
"deprecated": true,
"x-deprecated-since": "24-08-2026"
},
"dischargeDestinationId": {
"type": "integer",
"format": "int64"
},
"transport": {
"type": "boolean"
},
"grouperCheck": {
"type": "boolean"
},
"dbcTrajectId": {
"type": "integer",
"format": "int64"
}
},
"description": "DBC sub traject, a.k.a. DBCCareOrder in Administration.",
"example": {
"updatedAt": "2014-09-17T00:00:00.000+02:00",
"createdAt": "2014-09-17T00:00:00.000+02:00",
"createdBy": "Dummy",
"id": 1,
"source": "Dummy",
"dbcIdentifier": "Dummy",
"clientId": 1,
"clientIdentifier": "Dummy",
"financeTypeId": 1,
"contactPerson": "Dummy",
"startDate": "2014-09-17T00:00:00.000+02:00",
"endDate": "2014-09-17T00:00:00.000+02:00",
"issueDate": "2014-09-17T00:00:00.000+02:00",
"startDateClipped": "2014-09-17T00:00:00.000+02:00",
"endDateClipped": "2014-09-17T00:00:00.000+02:00",
"debtorId": 1,
"comments": "Dummy",
"dbcDiagnosisCode": "Dummy",
"endOfCare": "2014-09-17T00:00:00.000+02:00",
"afsluitingsCode": "Dummy",
"zorgTypeCode": "Dummy",
"resignationDestination": "Dummy",
"dischargeDestinationId": 1,
"transport": true,
"grouperCheck": true,
"dbcTrajectId": 1
},
"xml": {
"name": "dbcSubTraject"
}
},
"dbc.list.DBCSubTrajectList": {
"type": "object",
"properties": {
"dbcSubTrajects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dbc.DBCSubTraject"
},
"xml": {
"name": "dbcSubTraject"
}
}
},
"description": "DBCSubTrajectList model (no description)",
"example": {
"dbcSubTrajects": [
{
"updatedAt": "2014-09-17T00:00:00.000+02:00",
"createdAt": "2014-09-17T00:00:00.000+02:00",
"createdBy": "Dummy",
"id": 1,
"source": "Dummy",
"dbcIdentifier": "Dummy",
"clientId": 1,
"clientIdentifier": "Dummy",
"financeTypeId": 1,
"contactPerson": "Dummy",
"startDate": "2014-09-17T00:00:00.000+02:00",
"endDate": "2014-09-17T00:00:00.000+02:00",
"issueDate": "2014-09-17T00:00:00.000+02:00",
"startDateClipped": "2014-09-17T00:00:00.000+02:00",
"endDateClipped": "2014-09-17T00:00:00.000+02:00",
"debtorId": 1,
"comments": "Dummy",
"dbcDiagnosisCode": "Dummy",
"endOfCare": "2014-09-17T00:00:00.000+02:00",
"afsluitingsCode": "Dummy",
"zorgTypeCode": "Dummy",
"resignationDestination": "Dummy",
"dischargeDestinationId": 1,
"transport": true,
"grouperCheck": true,
"dbcTrajectId": 1
}
]
},
"xml": {
"name": "dbcSubTrajects"
}
},
"dbc.DBCTraject": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"clientId": {
"type": "integer",
"format": "int64"
},
"dbcIdentifier": {
"type": "string"
},
"clientIdentifier": {
"type": "string"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
},
"koppelNummer": {
"type": "string"
},
"parentDBCTraject": {
"type": "string"
},
"referringDBCTraject": {
"type": "string"
},
"verwijzendSpecialismeCode": {
"type": "string"
},
"verwijzendZorgtrajectnummer": {
"type": "string"
},
"hospitalName": {
"type": "string"
},
"hospitalAgbCode": {
"type": "string"
},
"specialistName": {
"type": "string"
},
"specialistAgbCode": {
"type": "string"
}
},
"description": "DBC traject, a.k.a. DBCCarePlan in Administration.",
"example": {
"updatedAt": "2014-09-17T00:00:00.000+02:00",
"createdAt": "2014-09-17T00:00:00.000+02:00",
"createdBy": "user",
"id": 1,
"clientId": 1,
"dbcIdentifier": "Dummy",
"clientIdentifier": "Dummy",
"startDate": "2014-09-17T00:00:00.000+02:00",
"endDate": "2014-09-17T00:00:00.000+02:00",
"koppelNummer": "Dummy",
"parentDBCTraject": "Dummy",
"referringDBCTraject": "Dummy",
"verwijzendSpecialismeCode": "Dummy",
"verwijzendZorgtrajectnummer": "Dummy",
"hospitalName": "Dummy",
"hospitalAgbCode": "Dummy",
"specialistName": "Dummy",
"specialistAgbCode": "Dummy"
},
"xml": {
"name": "dbcTraject"
}
},
"dbc.list.DBCTrajectList": {
"type": "object",
"properties": {
"dbcTrajects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dbc.DBCTraject"
}
}
},
"description": "DBCTrajectList model (no description)",
"example": {
"dbcTrajects": [
{
"id": 1,
"clientId": 1,
"dbcIdentifier": "Dummy",
"clientIdentifier": "Dummy",
"startDate": "2014-09-17T00:00:00.000+02:00",
"endDate": "2014-09-17T00:00:00.000+02:00",
"koppelNummer": "Dummy",
"parentDBCTraject": "Dummy",
"referringDBCTraject": "Dummy",
"verwijzendSpecialismeCode": "Dummy",
"verwijzendZorgtrajectnummer": "Dummy",
"hospitalName": "Dummy",
"hospitalAgbCode": "Dummy",
"specialistName": "Dummy",
"specialistAgbCode": "Dummy"
}
]
}
},
"dossier.list.ActionList": {
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.Action"
},
"xml": {
"name": "action"
}
}
},
"description": "ActionList model (no description)",
"example": {
"actions": [
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2482,
"domainId": 2052,
"goalId": 2421,
"definition": "Bespreekbaar maken van het belang van een schoon huis",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2483,
"domainId": 2052,
"goalId": 2421,
"definition": "Met verwant bespreekbaar maken",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2484,
"domainId": 2052,
"goalId": 2421,
"definition": "Tijd maken voor kennismaken met huishoudelijk medewerkster",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2485,
"domainId": 2052,
"goalId": 2422,
"definition": "Leren was sorteren",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2486,
"domainId": 2052,
"goalId": 2422,
"definition": "Uitleg wasmachine",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2487,
"domainId": 2052,
"goalId": 2422,
"definition": "Wassen onder begeleiding",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2488,
"domainId": 2052,
"goalId": 2422,
"definition": "Wassen volgens weekschema",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2489,
"domainId": 2052,
"goalId": 2423,
"definition": "Cliënt stimuleren tot schoonmaken",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2490,
"domainId": 2052,
"goalId": 2423,
"definition": "Controle door begeleiding",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2491,
"domainId": 2052,
"goalId": 2423,
"definition": "Dagelijks na de avondmaaltijd vuile was opruimen",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2492,
"domainId": 2052,
"goalId": 2423,
"definition": "Samen met begeleiding opruimen",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2493,
"domainId": 2052,
"goalId": 2423,
"definition": "Schoonmaak volgens schema",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2494,
"domainId": 2052,
"goalId": 2423,
"definition": "Schoonmaken met begeleiding",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2495,
"domainId": 2052,
"goalId": 2423,
"definition": "Zo nodig in gesprek met cliënt",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2496,
"domainId": 2052,
"goalId": 2424,
"definition": "Begeleiding houdt contact met civiel ondersteuners",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2497,
"domainId": 2052,
"goalId": 2424,
"definition": "Bij gemeente bijzondere bijstand aanvragen",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2498,
"domainId": 2052,
"goalId": 2424,
"definition": "Cliënt stimuleren tot schoonmaken",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2499,
"domainId": 2052,
"goalId": 2424,
"definition": "Dagelijkse controle door begeleiding",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2500,
"domainId": 2052,
"goalId": 2424,
"definition": "Ondersteuning door:",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2501,
"domainId": 2052,
"goalId": 2424,
"definition": "Schoonmaak volgens schema",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2502,
"domainId": 2052,
"goalId": 2424,
"definition": "Schoonmaken met begeleiding",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2503,
"domainId": 2052,
"goalId": 2424,
"definition": "Zo nodig in gesprek met cliënt",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2013-12-16T16:36:45.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2504,
"domainId": 2052,
"goalId": 2425,
"definition": "Aanpassingen in de keuken",
"instructionUrl": "https://basisvvt.ioservice.net/download/document/3620",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2505,
"domainId": 2052,
"goalId": 2426,
"definition": "Afstandsbediening aanschaffen binnen",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2506,
"domainId": 2052,
"goalId": 2426,
"definition": "iO Open installeren",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2507,
"domainId": 2052,
"goalId": 2427,
"definition": "Douche/toilet aanpassen ivm veiligheid/comfort/zelfredzaamheid",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2508,
"domainId": 2052,
"goalId": 2427,
"definition": "Handgrepen en douchestoel bestellen en installeren",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2509,
"domainId": 2052,
"goalId": 2427,
"definition": "Ondersteuning en oefeningen bieden die zelfstandigheid vergroten",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2510,
"domainId": 2052,
"goalId": 2427,
"definition": "Zorgstoel installeren",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2511,
"domainId": 2052,
"goalId": 2428,
"definition": "Bepaal wat voor hulp nodig is (maaltijden, vervoer, huishoudelijk werk)",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2512,
"domainId": 2052,
"goalId": 2428,
"definition": "Bepalen welke hulpmiddelen nodig zijn",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2513,
"domainId": 2052,
"goalId": 2429,
"definition": "Cliënt voert uit, begeleiding kijkt mee",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2514,
"domainId": 2052,
"goalId": 2429,
"definition": "Gebruiksaanwijzing doornemen",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2515,
"domainId": 2052,
"goalId": 2429,
"definition": "Oefenen met begeleiding",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2516,
"domainId": 2052,
"goalId": 2430,
"definition": "Rollator bestellen en instructie geven",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2517,
"domainId": 2052,
"goalId": 2431,
"definition": "Begeleiding gaat hierover in gesprek met cliënt",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2518,
"domainId": 2052,
"goalId": 2431,
"definition": "Begeleiding oefent met cliënt",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2519,
"domainId": 2052,
"goalId": 2431,
"definition": "Bepalen welke hulpmiddelen nodig zijn",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2520,
"domainId": 2052,
"goalId": 2431,
"definition": "Controle door begeleiding",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2521,
"domainId": 2052,
"goalId": 2432,
"definition": "Onderzoek naar aanpassingen die zelfstandig blijven wonen mogelijk maken",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2522,
"domainId": 2052,
"goalId": 2432,
"definition": "Trap lift bestellen en installeren",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2523,
"domainId": 2052,
"goalId": 2432,
"definition": "Warme maaltijd wordt aangeleverd",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2524,
"domainId": 2052,
"goalId": 2432,
"definition": "wensen en behoeften voor individuele aanpassingen bespreken met de cliënt",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2525,
"domainId": 2052,
"goalId": 2432,
"definition": "Woning aanpassen aan leeftijd en zorgvraag",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2526,
"domainId": 2052,
"goalId": 2432,
"definition": "Zoveel mogelijk contactmomenten",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2527,
"domainId": 2052,
"goalId": 2433,
"definition": "Alarminstallatie aanbrengen",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2528,
"domainId": 2052,
"goalId": 2433,
"definition": "Onderzoek naar eventuele veiligheidsaanpassingen",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2529,
"domainId": 2052,
"goalId": 2433,
"definition": "Onderzoek naar veiligheid woning",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2530,
"domainId": 2052,
"goalId": 2434,
"definition": "Aanbrengen alarmeringssysteem",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2531,
"domainId": 2052,
"goalId": 2434,
"definition": "Aanbrengen van iO open aan de voordeur",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2532,
"domainId": 2052,
"goalId": 2434,
"definition": "Brandblusapparaat oefenen met cliënt",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2533,
"domainId": 2052,
"goalId": 2434,
"definition": "Nachtlampje aanschaffen",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2534,
"domainId": 2052,
"goalId": 2434,
"definition": "Oefenen met cliënt wat te doen bij brand",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2535,
"domainId": 2052,
"goalId": 2434,
"definition": "Oefenen met opvolging alarmsysteem",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2536,
"domainId": 2052,
"goalId": 2434,
"definition": "Sloten aanbrengen op deuren en kasten",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2537,
"domainId": 2052,
"goalId": 2434,
"definition": "Valrisico verlagen in de woning (zie protocol)",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2538,
"domainId": 2052,
"goalId": 2435,
"definition": "Persoonlijk begeleider blijft zorg dragen dat hulpmiddelen up to date zijn",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2539,
"domainId": 2052,
"goalId": 2436,
"definition": "Bepalen welke hulpmiddelen nodig zijn",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2540,
"domainId": 2052,
"goalId": 2436,
"definition": "Cliënt helpen met uitzoeken van de juiste spullen voor de woning",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2541,
"domainId": 2052,
"goalId": 2437,
"definition": "Contact met cliënt / verwant houden over toekomst wonen",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2542,
"domainId": 2052,
"goalId": 2437,
"definition": "Samen met cliënt plan maken voor inrichting woning",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2543,
"domainId": 2052,
"goalId": 2437,
"definition": "Woonsituatie aanpassen aan leeftijd en zorgvraag",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2544,
"domainId": 2052,
"goalId": 2437,
"definition": "Zorgloket benaderen voor herindicatie",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2545,
"domainId": 2052,
"goalId": 2438,
"definition": "Aanpassingen aan de woning laten maken door ergotherapie",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2546,
"domainId": 2052,
"goalId": 2439,
"definition": "Aanpassingen aan de woonkamerverlichting doen",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2547,
"domainId": 2052,
"goalId": 2439,
"definition": "Wensenlijstje en inkopen doen",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2548,
"domainId": 2052,
"goalId": 2440,
"definition": "Samen met cliënt plan maken voor inrichting woning",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2549,
"domainId": 2052,
"goalId": 2441,
"definition": "Inventariseren van woonwensen van de cliënt",
"allowTitleOverride": false,
"allowComment": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3688,
"domainId": 2052,
"goalId": 2421,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3689,
"domainId": 2052,
"goalId": 2422,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3690,
"domainId": 2052,
"goalId": 2423,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3691,
"domainId": 2052,
"goalId": 2424,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3692,
"domainId": 2052,
"goalId": 3607,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3693,
"domainId": 2052,
"goalId": 3608,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3694,
"domainId": 2052,
"goalId": 2437,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3695,
"domainId": 2052,
"goalId": 2425,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2013-12-04T17:08:50.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3696,
"domainId": 2052,
"goalId": 2426,
"definition": "Actie",
"instructionUrl": "http://www.deuren.nl",
"allowTitleOverride": true,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3697,
"domainId": 2052,
"goalId": 2427,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3698,
"domainId": 2052,
"goalId": 3609,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3699,
"domainId": 2052,
"goalId": 2429,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3700,
"domainId": 2052,
"goalId": 2438,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3701,
"domainId": 2052,
"goalId": 2430,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3702,
"domainId": 2052,
"goalId": 3610,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3703,
"domainId": 2052,
"goalId": 2439,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3704,
"domainId": 2052,
"goalId": 2433,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3705,
"domainId": 2052,
"goalId": 2434,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3706,
"domainId": 2052,
"goalId": 2431,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3707,
"domainId": 2052,
"goalId": 2432,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3708,
"domainId": 2052,
"goalId": 2435,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3709,
"domainId": 2052,
"goalId": 2440,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3710,
"domainId": 2052,
"goalId": 2441,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2012-02-08T12:08:12.000+01:00",
"createdAt": "2010-12-08T16:14:45.000+01:00",
"id": 3728,
"domainId": 2052,
"goalId": 2164,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:48.000+01:00",
"createdAt": "2010-12-08T16:14:48.000+01:00",
"id": 3743,
"domainId": 2052,
"goalId": 3643,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:48.000+01:00",
"createdAt": "2010-12-08T16:14:48.000+01:00",
"id": 3744,
"domainId": 2052,
"goalId": 3644,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:48.000+01:00",
"createdAt": "2010-12-08T16:14:48.000+01:00",
"id": 3745,
"domainId": 2052,
"goalId": 3645,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:48.000+01:00",
"createdAt": "2010-12-08T16:14:48.000+01:00",
"id": 3746,
"domainId": 2052,
"goalId": 3646,
"definition": "Actie",
"allowTitleOverride": false,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2012-02-08T12:07:52.000+01:00",
"createdAt": "2012-02-08T12:07:52.000+01:00",
"id": 16350,
"domainId": 2052,
"goalId": 16050,
"definition": "training fysio",
"allowTitleOverride": true,
"allowComment": true,
"hidden": false
},
{
"updatedAt": "2013-06-13T10:45:46.000+02:00",
"createdAt": "2013-06-13T10:45:46.000+02:00",
"id": 39851,
"domainId": 2052,
"goalId": 39802,
"definition": "test`112",
"allowTitleOverride": true,
"allowComment": false,
"hidden": false
}
]
},
"xml": {
"name": "actions"
}
},
"dossier.list.ActionEntryList": {
"type": "object",
"properties": {
"actionEntries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.ActionEntry"
}
}
},
"description": "ActionEntryList model (no description)",
"example": {
"actionEntries": [
{
"updatedAt": "2011-09-26T12:13:40.000+02:00",
"createdAt": "2011-09-26T12:13:40.000+02:00",
"id": 10561,
"carePlanEntryId": 10510,
"actionId": 350,
"comment": "Gebruik van hulpmiddelen aanleren; rollator les bij ergo"
},
{
"updatedAt": "2011-09-26T12:13:40.000+02:00",
"createdAt": "2011-09-26T12:13:40.000+02:00",
"id": 10562,
"carePlanEntryId": 10510,
"actionId": 350,
"comment": "Conditie verbeteren door dagelijks 3 maal 15 minuten oefenen achter rollator"
}
]
}
},
"dossier.list.CarePlanReportRightList": {
"type": "object",
"properties": {
"carePlanReportRights": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.CarePlanReportRight"
},
"xml": {
"name": "carePlanReportRight"
}
}
},
"description": "CarePlanReportRightList model (no description)",
"example": {
"carePlanReportRights": [
{
"updatedAt": "2018-07-18T00:00:00.000+02:00",
"createdAt": "2018-07-18T00:00:00.000+02:00",
"createdBy": "Dummy",
"id": 1,
"educationObjectId": 1,
"expertiseGroupObjectId": 1,
"type": "RIGHT",
"actionEmployeeId": 1,
"actionDateFinished": "2018-08-18"
}
]
},
"xml": {
"name": "carePlanReportRights"
}
},
"dossier.CarePlanReportRight": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"report": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.Report"
}
],
"description": "The report for which this report right applies"
},
"educationObjectId": {
"type": "integer",
"description": "The education linked to this report right",
"format": "int64"
},
"expertiseGroupObjectId": {
"type": "integer",
"description": "The expertise group linked to this report right",
"format": "int64"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.ReportRightType"
}
],
"default": "RIGHT"
},
"actionEmployeeId": {
"type": "integer",
"format": "int64"
},
"actionDateFinished": {
"type": "string",
"format": "date"
}
},
"description": "CarePlanReportRight model (no description)",
"example": {
"updatedAt": "2018-07-18T00:00:00.000+02:00",
"createdAt": "2018-07-18T00:00:00.000+02:00",
"createdBy": "Dummy",
"id": 1,
"report": {
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"uuid": "example",
"reportingDate": "2014-12-29T00:00:00.000+01:00",
"comment": "example",
"flagged": true,
"confidential": true,
"hidden": true,
"hidingReason": "example",
"parentId": 1,
"parentType": "example",
"carenId": 1,
"carenName": "example",
"carenRole": "example",
"status": 1,
"clientId": 1,
"employeeId": 1,
"reportTypeId": 1,
"carePlanEntryId": 1,
"reportEntries": [
{
"name": "example",
"value": "example",
"format": "example",
"unit": "example",
"displayName": "example"
},
{
"name": "example",
"value": "example",
"format": "example",
"unit": "example",
"displayName": "example"
}
],
"expertiseProfile": {
"id": 1,
"description": "example",
"visible": true,
"beginDate": "2014-12-29T00:00:00.000+01:00",
"endDate": "2014-12-29T00:00:00.000+01:00",
"allowDossierActions": true,
"allowDossierConfidential": true,
"hourTypeIds": [
1,
1
]
},
"reportActions": [
{
"id": 1,
"carePlanId": 1,
"expertiseProfileId": 1,
"expertiseGroupObjectId": 1,
"employeeId": 1,
"dateFinished": "2014-12-29T00:00:00.000+01:00"
},
{
"id": 1,
"carePlanId": 1,
"expertiseProfileId": 1,
"expertiseGroupObjectId": 1,
"employeeId": 1,
"dateFinished": "2014-12-29T00:00:00.000+01:00"
}
],
"reportAuthorizations": [
{
"id": 1,
"carePlanId": 1,
"expertiseProfileId": 1,
"expertiseGroupObjectId": 1
},
{
"id": 1,
"carePlanId": 1,
"expertiseProfileId": 1,
"expertiseGroupObjectId": 1
}
],
"soapReportEntries": [
{
"soapPart": "example",
"confidential": true,
"content": "example",
"expertiseProfileIds": [
1,
1
],
"expertiseGroupIds": [
1,
1
]
},
{
"soapPart": "example",
"confidential": true,
"content": "example",
"expertiseProfileIds": [
1,
1
],
"expertiseGroupIds": [
1,
1
]
}
],
"episodeId": 1,
"episodeIds": [
1,
1
],
"restrictiveMeasureId": 1,
"reportLinkId": 1,
"reportLinkType": "NEXT_DOSSIER"
},
"educationObjectId": 1,
"expertiseGroupObjectId": 1,
"type": "RIGHT",
"actionEmployeeId": 1,
"actionDateFinished": "2018-08-18"
},
"xml": {
"name": "carePlanReportRight"
}
},
"dossier.ReportRightType": {
"enum": [
"RIGHT",
"ACTION"
],
"type": "string",
"description": "ReportRightType enum (no description)",
"example": "RIGHT"
},
"dossier.list.CarePlanEntryList": {
"type": "object",
"properties": {
"carePlanEntries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.CarePlanEntry"
}
}
},
"description": "CarePlanEntryList model (no description)",
"example": {
"carePlanEntries": [
{
"updatedAt": "2014-04-01T17:00:00.000+02:00",
"createdAt": "2013-12-01T17:00:00.000+01:00",
"id": 10,
"carePlanId": 60,
"demandEntryId": 30,
"goalEntryId": 40,
"percentageRealized": 20,
"percentageTarget": 0,
"importantForCarePlanGroupId": 50
},
{
"updatedAt": "2014-04-01T17:00:00.000+02:00",
"createdAt": "2013-12-01T17:00:00.000+01:00",
"id": 1,
"carePlanId": 6,
"demandEntryId": 3,
"goalEntryId": 4,
"percentageRealized": 20,
"percentageTarget": 40,
"importantForCarePlanGroupId": 5
}
]
}
},
"dossier.list.CarePlanList": {
"type": "object",
"properties": {
"carePlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.CarePlan"
}
}
},
"description": "CarePlanList model (no description)",
"example": {
"carePlans": [
{
"updatedAt": "2014-04-01T17:00:00.000+02:00",
"createdAt": "2013-12-01T17:00:00.000+01:00",
"id": 1,
"clientId": 1,
"employeeId": 1,
"status": "ACTIVE",
"beginDate": "2014-01-01T08:00:00.000+01:00",
"endDate": "2014-05-01T17:00:00.000+02:00"
},
{
"updatedAt": "2014-04-01T17:00:00.000+02:00",
"createdAt": "2013-12-01T17:00:00.000+01:00",
"id": 10,
"clientId": 10,
"employeeId": 10,
"status": "DRAFT",
"beginDate": "2014-01-01T08:00:00.000+01:00",
"endDate": "2014-05-01T17:00:00.000+02:00"
},
{
"updatedAt": "2014-04-01T17:00:00.000+02:00",
"createdAt": "2013-12-01T17:00:00.000+01:00",
"id": 11,
"clientId": 11,
"employeeId": 11,
"status": "OLD",
"beginDate": "2014-01-01T08:00:00.000+01:00",
"endDate": "2014-05-01T17:00:00.000+02:00"
},
{
"updatedAt": "2014-04-01T17:00:00.000+02:00",
"createdAt": "2013-12-01T17:00:00.000+01:00",
"id": 12,
"clientId": 12,
"employeeId": 12,
"status": "OLD",
"beginDate": "2014-01-01T08:00:00.000+01:00",
"endDate": "2014-05-01T17:00:00.000+02:00"
}
]
}
},
"dossier.list.ClientNoteList": {
"type": "object",
"properties": {
"clientNotes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.ClientNote"
}
}
},
"description": "ClientNoteList model (no description)",
"example": {
"clientNotes": [
{
"id": 1,
"content": "Dummy",
"visibleOnWorksheet": true,
"deleted": true,
"startDate": "2014-06-16",
"endDate": "2014-06-16",
"updatedByAuthorId": 1,
"authorId": 1,
"updatedAt": "2014-06-16T02:00:00.000+02:00",
"createdAt": "2014-06-16T02:00:00.000+02:00",
"createdBy": "Dummy",
"clientId": 1
},
{
"id": 2,
"content": "Dummy",
"visibleOnWorksheet": true,
"deleted": true,
"startDate": "2014-06-16",
"endDate": "2014-06-16",
"updatedByAuthorId": 2,
"authorId": 2,
"updatedAt": "2014-06-16T02:00:00.000+02:00",
"createdAt": "2014-06-16T02:00:00.000+02:00",
"createdBy": "Dummy",
"clientId": 2
}
]
}
},
"dossier.list.GoalList": {
"type": "object",
"properties": {
"goals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.Goal"
},
"xml": {
"name": "goal"
}
}
},
"description": "GoalList model (no description)",
"example": {
"goals": [
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2421,
"domainId": 2052,
"demandId": 2131,
"definition": "Cliënt accepteert huishoudelijke ondersteuning",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2422,
"domainId": 2052,
"demandId": 2131,
"definition": "Cliënt doet zelfstandig de was",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2423,
"domainId": 2052,
"demandId": 2131,
"definition": "Cliënt heeft een opgeruimde kamer",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2424,
"domainId": 2052,
"demandId": 2131,
"definition": "Cliënt heeft een schoon huis",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2013-02-12T11:24:30.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2425,
"domainId": 2052,
"demandId": 2132,
"definition": "Cliënt kan zelf maaltijden klaarmaken",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": true,
"hidden": false
},
{
"updatedAt": "2013-12-04T17:11:24.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2426,
"domainId": 2052,
"demandId": 2132,
"definition": "Cliënt kan zelfstandig deuren openen en sluiten",
"allowTitleOverride": true,
"allowComment": true,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2427,
"domainId": 2052,
"demandId": 2132,
"definition": "Cliënt kan zelfstandig douchen",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2428,
"domainId": 2052,
"demandId": 2131,
"definition": "Cliënt kan zelfstandig het huishouden verzorgen",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2429,
"domainId": 2052,
"demandId": 2131,
"definition": "Cliënt kan zelfstandig huishoudelijke apparaten bedienen",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2430,
"domainId": 2052,
"demandId": 2132,
"definition": "Cliënt kan zelfstandig naar het toilet",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2431,
"domainId": 2052,
"demandId": 2131,
"definition": "Cliënt voert lichte poets- en opruimwerkzaamheden zelf uit",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2432,
"domainId": 2052,
"demandId": 2132,
"definition": "Cliënt wil zelfstandig blijven wonen",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2433,
"domainId": 2052,
"demandId": 2133,
"definition": "Cliënt voelt zich veilig in de woning",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2434,
"domainId": 2052,
"demandId": 2133,
"definition": "Cliënt voelt zich veilig in huis",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2435,
"domainId": 2052,
"demandId": 2133,
"definition": "Cliënt woont in een veilige woonomgeving",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2436,
"domainId": 2052,
"demandId": 2131,
"definition": "Cliënt is tevreden met de situatie in huis",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2437,
"domainId": 2052,
"demandId": 2133,
"definition": "Cliënt is tevreden over woonsituatie",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2438,
"domainId": 2052,
"demandId": 2133,
"definition": "Cliënt kan zelfstandig huishoudelijke apparaten en gereedschap onderhouden",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2439,
"domainId": 2052,
"demandId": 2133,
"definition": "Cliënt voelt zich prettig bij inrichting van de woning",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2440,
"domainId": 2052,
"demandId": 2133,
"definition": "Woning is comfortabel voor cliënt",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2441,
"domainId": 2052,
"demandId": 2133,
"definition": "Woonwensen cliënt zijn duidelijk",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3607,
"domainId": 2052,
"demandId": 2930,
"definition": "Client heeft voldoende privacy",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3608,
"domainId": 2052,
"demandId": 2131,
"definition": "Client is tevreden met de situatie in huis",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3609,
"domainId": 2052,
"demandId": 2131,
"definition": "Client kan zelfstandig het huishouden verzorgen",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 3610,
"domainId": 2052,
"demandId": 2131,
"definition": "Cliënt kan zelfstandig schoonmaken",
"allowTitleOverride": false,
"allowComment": false,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2013-01-21T22:22:18.000+01:00",
"createdAt": "2010-12-08T16:14:48.000+01:00",
"id": 3643,
"domainId": 2052,
"demandId": 2132,
"definition": "Doel",
"allowTitleOverride": true,
"allowComment": true,
"reportProgress": true,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:48.000+01:00",
"createdAt": "2010-12-08T16:14:48.000+01:00",
"id": 3644,
"domainId": 2052,
"demandId": 2133,
"definition": "Doel",
"allowTitleOverride": false,
"allowComment": true,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:48.000+01:00",
"createdAt": "2010-12-08T16:14:48.000+01:00",
"id": 3645,
"domainId": 2052,
"demandId": 2930,
"definition": "Doel",
"allowTitleOverride": false,
"allowComment": true,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:48.000+01:00",
"createdAt": "2010-12-08T16:14:48.000+01:00",
"id": 3646,
"domainId": 2052,
"demandId": 2131,
"definition": "Doel",
"allowTitleOverride": false,
"allowComment": true,
"reportProgress": false,
"hidden": false
},
{
"updatedAt": "2013-01-21T22:26:24.000+01:00",
"createdAt": "2012-02-08T12:06:31.000+01:00",
"id": 16050,
"domainId": 2052,
"demandId": 2132,
"definition": "verbeteren Bewegingsmogelijkheden",
"allowTitleOverride": true,
"allowComment": true,
"reportProgress": true,
"hidden": false
},
{
"updatedAt": "2013-06-13T10:45:26.000+02:00",
"createdAt": "2013-06-13T10:45:26.000+02:00",
"id": 39802,
"domainId": 2052,
"demandId": 25500,
"definition": "test123",
"allowTitleOverride": true,
"allowComment": true,
"reportProgress": false,
"hidden": false
}
]
},
"xml": {
"name": "goals"
}
},
"dossier.list.DemandList": {
"type": "object",
"properties": {
"demands": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.Demand"
},
"xml": {
"name": "demand"
}
}
},
"description": "DemandList model (no description)",
"example": {
"demands": [
{
"updatedAt": "2010-12-08T12:32:42.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2131,
"domainId": 2052,
"definition": "Woonruimte en zich thuis voelen: Opgeruimd en schoon",
"hidden": false
},
{
"updatedAt": "2012-03-14T14:08:08.000+01:00",
"createdAt": "2010-12-08T12:32:42.000+01:00",
"id": 2132,
"domainId": 2052,
"definition": "Bewegingsmogelijkheden, mobiliteit: U heeft aanpassingen en speciale hulpmiddelen nodig om zelfstandig te kunnen lopen",
"hidden": false
},
{
"updatedAt": "2010-12-08T12:32:43.000+01:00",
"createdAt": "2010-12-08T12:32:43.000+01:00",
"id": 2133,
"domainId": 2052,
"definition": "Woonruimte en zich thuis voelen: De woning en woonomgeving",
"hidden": false
},
{
"updatedAt": "2010-12-08T16:14:43.000+01:00",
"createdAt": "2010-12-08T16:14:43.000+01:00",
"id": 2930,
"domainId": 2052,
"definition": "Woonruimte en zich thuis voelen: Levenssfeer en privacy",
"hidden": false
},
{
"updatedAt": "2012-08-13T10:14:41.000+02:00",
"createdAt": "2012-08-13T10:14:41.000+02:00",
"id": 25500,
"domainId": 2052,
"definition": "Woonomgeving status",
"hidden": false
}
]
},
"xml": {
"name": "demands"
}
},
"dossier.list.DomainList": {
"type": "object",
"properties": {
"domains": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.Domain"
},
"xml": {
"name": "domain"
}
}
},
"description": "DomainList model (no description)",
"example": {
"domains": [
{
"updatedAt": "2014-04-01T17:00:00.000+02:00",
"createdAt": "2013-12-01T17:00:00.000+01:00",
"id": 1,
"name": "Domein naam",
"hidden": false
}
]
},
"xml": {
"name": "domains"
}
},
"dossier.list.MedicalNoteList": {
"type": "object",
"properties": {
"medicalNotes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.MedicalNote"
}
}
},
"description": "MedicalNoteList model (no description)",
"example": {
"medicalNotes": [
{
"id": 1,
"content": "Dummy",
"visibleOnWorksheet": true,
"deleted": true,
"startDate": "2014-06-16",
"endDate": "2014-06-16",
"updatedByAuthorId": 1,
"authorId": 1,
"updatedAt": "2014-06-16T02:00:00.000+02:00",
"createdAt": "2014-06-16T02:00:00.000+02:00",
"createdBy": "Dummy",
"clientId": 1
},
{
"id": 1,
"content": "Dummy",
"visibleOnWorksheet": true,
"deleted": true,
"startDate": "2014-06-16",
"endDate": "2014-06-16",
"updatedByAuthorId": 1,
"authorId": 2,
"updatedAt": "2014-06-16T02:00:00.000+02:00",
"createdAt": "2014-06-16T02:00:00.000+02:00",
"createdBy": "Dummy",
"clientId": 2
}
]
}
},
"dossier.list.ReportTypeList": {
"type": "object",
"properties": {
"reportTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.ReportType"
},
"xml": {
"name": "reportType"
}
}
},
"description": "ReportTypeList model (no description)",
"example": {
"reportTypes": [
{
"updatedAt": "2013-08-05T13:31:28.000+02:00",
"createdAt": "2009-07-01T00:00:00.000+02:00",
"id": 101,
"name": "Rapportage",
"valueType": "Comment",
"defaultValue": 0,
"hasTime": true,
"iconSrc": "zorgplan_blauw.png",
"enabled": true
},
{
"updatedAt": "2009-09-30T00:00:00.000+02:00",
"createdAt": "2009-09-30T00:00:00.000+02:00",
"id": 102,
"name": "Gewicht",
"valueType": "BMI",
"format": "%.1f",
"unit": "kg",
"defaultValue": 0,
"hasTime": true,
"iconSrc": "gewicht_blauw.png",
"enabled": true
},
{
"updatedAt": "2009-10-01T00:00:00.000+02:00",
"createdAt": "2009-10-01T00:00:00.000+02:00",
"id": 103,
"name": "Bloeddruk",
"valueType": "BloodPressure",
"defaultValue": 0,
"hasTime": true,
"iconSrc": "hartslag_blauw.png",
"enabled": true
},
{
"updatedAt": "2009-10-02T00:00:00.000+02:00",
"createdAt": "2009-10-02T00:00:00.000+02:00",
"id": 104,
"name": "Temperatuur",
"valueType": "Decimal",
"format": "%.1f",
"unit": "°C",
"defaultValue": 0,
"hasTime": true,
"iconSrc": "temperatuur_blauw.png",
"enabled": true
},
{
"updatedAt": "2010-05-05T00:00:00.000+02:00",
"createdAt": "2010-05-05T00:00:00.000+02:00",
"id": 105,
"name": "Bloedsuiker",
"valueType": "Decimal",
"format": "%.1f",
"unit": "mmol/l",
"defaultValue": 0,
"hasTime": true,
"iconSrc": "bloedsuiker_blauw.png",
"enabled": true
},
{
"updatedAt": "2010-05-05T00:00:00.000+02:00",
"createdAt": "2010-05-05T00:00:00.000+02:00",
"id": 106,
"name": "Vocht inname",
"valueType": "Decimal",
"unit": "ml",
"defaultValue": 0,
"hasTime": true,
"iconSrc": "vochtinname_blauw.png",
"enabled": true
},
{
"updatedAt": "2010-05-05T00:00:00.000+02:00",
"createdAt": "2010-05-05T00:00:00.000+02:00",
"id": 107,
"name": "Vocht uitscheiding",
"valueType": "Decimal",
"unit": "ml",
"defaultValue": 0,
"hasTime": true,
"iconSrc": "vochtuitscheiding_blauw.png",
"enabled": true
},
{
"updatedAt": "2013-01-09T11:37:39.000+01:00",
"createdAt": "2010-08-01T00:00:00.000+02:00",
"id": 109,
"name": "Medisch",
"valueType": "Comment",
"defaultValue": 0,
"hasTime": false,
"iconSrc": "zorg_blauw.png",
"enabled": true
},
{
"updatedAt": "2010-08-01T00:00:00.000+02:00",
"createdAt": "2010-08-01T00:00:00.000+02:00",
"id": 108,
"name": "Defaecatie",
"valueType": "Comment",
"defaultValue": 0,
"hasTime": true,
"iconSrc": "ondersteek_blauw.png",
"enabled": true
},
{
"updatedAt": "2013-02-12T11:34:42.000+01:00",
"createdAt": "2010-08-31T00:00:00.000+02:00",
"id": 110,
"name": "Voortgang",
"valueType": "ProgressReport",
"format": "%.1f",
"unit": "%",
"defaultValue": 0,
"hasTime": false,
"iconSrc": "procent_blauw.png",
"enabled": true
},
{
"updatedAt": "2012-12-06T15:27:05.000+01:00",
"createdAt": "2011-06-01T00:00:00.000+02:00",
"id": 111,
"name": "Familie communicatie",
"valueType": "FamilyCommunication",
"defaultValue": 0,
"hasTime": false,
"iconSrc": "caren_blauw.png",
"enabled": true
},
{
"updatedAt": "2012-07-24T14:38:36.000+02:00",
"createdAt": "2011-07-01T00:00:00.000+02:00",
"id": 212,
"name": "Wondbehandeling",
"valueType": "Comment",
"defaultValue": 0,
"hasTime": false,
"iconSrc": "zorg_blauw.png",
"enabled": false
},
{
"updatedAt": "2013-08-20T14:30:10.000+02:00",
"createdAt": "2011-07-01T00:00:00.000+02:00",
"id": 220,
"name": "Saturatie",
"valueType": "Decimal",
"format": "%.1f",
"unit": "%",
"defaultValue": 0,
"hasTime": false,
"iconSrc": "bloedsuiker_blauw.png",
"enabled": false
},
{
"updatedAt": "2012-09-11T16:29:42.000+02:00",
"createdAt": "2011-07-01T00:00:00.000+02:00",
"id": 221,
"name": "INR",
"valueType": "Decimal",
"format": "%.1f",
"defaultValue": 0,
"hasTime": false,
"iconSrc": "bloedsuiker_blauw.png",
"enabled": false
},
{
"updatedAt": "2013-08-26T15:13:01.000+02:00",
"createdAt": "2013-06-11T18:07:22.000+02:00",
"id": 112,
"name": "Keten communicatie",
"valueType": "ExternalCommunication",
"defaultValue": 0,
"hasTime": true,
"iconSrc": "caren_keten_blauw.png",
"enabled": true
}
]
},
"xml": {
"name": "reportTypes"
}
},
"dossier.list.ReportList": {
"type": "object",
"properties": {
"reports": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.Report"
},
"xml": {
"name": "report"
}
}
},
"description": "ReportList model (no description)",
"example": {
"reports": [
{
"updatedAt": "2014-04-01T17:00:00.000+02:00",
"createdAt": "2013-12-01T17:00:00.000+01:00",
"id": 1,
"reportingDate": "2014-04-01T17:00:00.000+02:00",
"comment": "Goed geplast",
"flagged": true,
"confidential": false,
"hidden": false,
"parentType": "careplanreport",
"carenId": 10,
"carenName": "Foeken",
"carenRole": "Mantelzorger",
"status": 1,
"reportTypeId": 101
},
{
"updatedAt": "2014-04-01T17:00:00.000+02:00",
"createdAt": "2013-12-01T17:00:00.000+01:00",
"id": 2,
"reportingDate": "2014-04-01T17:00:00.000+02:00",
"comment": "Goed geplast",
"flagged": true,
"confidential": false,
"hidden": false,
"parentType": "careplanreport",
"carenId": 10,
"carenName": "Foeken",
"carenRole": "Mantelzorger",
"status": 1,
"reportTypeId": 101
}
]
},
"xml": {
"name": "reports"
}
},
"dossier.list.ReportAuthorizationList": {
"type": "object",
"properties": {
"reportAuthorizations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.ReportAuthorization"
},
"xml": {
"name": "reportAuthorization"
}
}
},
"description": "ReportAuthorizationList model (no description)",
"example": {
"reportAuthorizations": [
{
"id": 1,
"expertiseProfileId": 1,
"expertiseGroupObjectId": 2
},
{
"id": 2,
"expertiseProfileId": 2,
"expertiseGroupObjectId": 1
}
]
},
"xml": {
"name": "reportAuthorizations"
}
},
"dossier.list.SystemNoteList": {
"type": "object",
"properties": {
"systemNotes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.SystemNote"
}
}
},
"description": "SystemNoteList model (no description)",
"example": {
"systemNotes": [
{
"id": 1,
"content": "Dummy",
"visibleOnWorksheet": true,
"deleted": true,
"startDate": "2014-06-16",
"endDate": "2014-06-16",
"updatedByAuthorId": 1,
"authorId": 1,
"updatedAt": "2014-06-16T02:00:00.000+02:00",
"createdAt": "2014-06-16T02:00:00.000+02:00",
"createdBy": "Dummy"
},
{
"id": 1,
"content": "Dummy",
"visibleOnWorksheet": true,
"deleted": true,
"startDate": "2014-06-16",
"endDate": "2014-06-16",
"updatedByAuthorId": 1,
"authorId": 2,
"updatedAt": "2014-06-16T02:00:00.000+02:00",
"createdAt": "2014-06-16T02:00:00.000+02:00",
"createdBy": "Dummy"
}
]
}
},
"list.PractitionerAgbCodeList": {
"type": "object",
"properties": {
"practitionerAgbCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PractitionerAgbCode"
}
}
},
"description": "PractitionerAgbCodeList model (no description)",
"example": {
"practitionerAgbCodes": [
{
"id": 1,
"employeeObjectId": 1,
"code": "12345678",
"beginDate": "2022-01-01",
"endDate": "2022-12-31",
"primary": true
}
]
}
},
"list.PractitionerBigCodeList": {
"type": "object",
"properties": {
"practitionerBigCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PractitionerBigCode"
}
}
},
"description": "PractitionerBigCodeList model (no description)",
"example": {
"practitionerBigCodes": [
{
"id": 1,
"employeeObjectId": 1,
"code": "12345678"
}
]
}
},
"list.TeamList": {
"type": "object",
"properties": {
"teams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Team"
},
"xml": {
"name": "team"
}
}
},
"description": "TeamList model (no description)",
"example": {
"teams": [
{
"id": 1,
"beginDate": "1999-12-31T23:00:00.000+01:00",
"externCode": "",
"identificationNo": "0001",
"name": "Nedap Demo",
"poolTeam": false,
"costCenterNumber": "0001",
"parentObjectId": 0
}
]
},
"xml": {
"name": "teams"
}
},
"Team": {
"title": "Team",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"beginDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"externCode": {
"type": "string",
"nullable": true
},
"identificationNo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"poolTeam": {
"type": "boolean",
"nullable": true
},
"costCenterNumber": {
"type": "string",
"nullable": true
},
"parentObjectId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamAddress"
},
"nullable": true
}
},
"description": "Team (Cluster)",
"example": {
"id": 1,
"beginDate": "2000-01-01T00:00:00.000+01:00",
"endDate": "2001-01-01T00:00:00.000+01:00",
"externCode": "agb",
"identificationNo": "0001",
"name": "Nedap Demo",
"poolTeam": false,
"costCenterNumber": "0001",
"parentObjectId": 0,
"addresses": []
},
"xml": {
"name": "team"
}
},
"payroll.list.ContractList": {
"type": "object",
"properties": {
"contracts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payroll.Contract"
},
"xml": {
"name": "contract"
}
}
},
"description": "ContractList model (no description)",
"example": {
"contracts": [
{
"id": 1,
"employeeId": 1,
"fixed": 1.234,
"var": 1.234,
"contractTypeId": 1,
"beginDate": "2015-01-01",
"endDate": "2020-01-01"
}
]
},
"xml": {
"name": "contracts"
}
},
"list.ExpertiseProfileAssignmentList": {
"type": "object",
"properties": {
"expertiseProfileAssignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpertiseProfileAssignment"
},
"xml": {
"name": "expertiseProfileAssignment"
}
}
},
"description": "ExpertiseProfileAssignmentList model (no description)",
"example": {
"expertiseProfileAssignments": [
{
"id": 1,
"startTime": "2012-08-02T11:48:46.836+02:00",
"endTime": "2012-08-02T11:48:46.836+02:00",
"employeeObjectId": 9941,
"expertiseProfileObjectId": 2
}
]
},
"xml": {
"name": "expertiseProfileAssignments"
}
},
"ExpertiseProfileAssignment": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"startTime": {
"type": "string",
"format": "date-time"
},
"endTime": {
"type": "string",
"format": "date-time"
},
"employeeObjectId": {
"type": "integer",
"format": "int64"
},
"expertiseProfileObjectId": {
"type": "integer",
"format": "int64"
}
},
"description": "Expertise profile assignment.",
"example": {
"id": 1,
"startTime": "2012-08-02T13:48:46.836+02:00",
"endTime": "2012-08-02T13:48:46.836+02:00",
"employeeObjectId": 9941,
"expertiseProfileObjectId": 2
},
"xml": {
"name": "expertiseProfileAssignment"
}
},
"list.ExpertiseProfileList": {
"type": "object",
"properties": {
"expertiseProfiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpertiseProfile"
},
"xml": {
"name": "expertiseProfile"
}
}
},
"description": "ExpertiseProfileList model (no description)",
"example": {
"expertiseProfiles": [
{
"id": 5,
"description": "Helpenden",
"visible": true
}
]
},
"xml": {
"name": "expertiseProfiles"
}
},
"list.PractitionerProfessionList": {
"type": "object",
"properties": {
"practitionerProfessions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PractitionerProfession"
}
}
},
"description": "PractitionerProfessionList model (no description)",
"example": {
"practitionerProfessions": [
{
"id": 1,
"employeeObjectId": 1,
"code": "9992",
"name": "VK.OB.overig",
"info": "Overig",
"type": "COD878_GZ_BEROEPZORGVERLENER",
"professionType": 0,
"beginDate": "2018-01-01",
"endDate": "2018-12-31"
}
]
}
},
"list.TeamAssignmentList": {
"type": "object",
"properties": {
"teamAssignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamAssignment"
},
"xml": {
"name": "teamAssignment"
}
}
},
"description": "TeamAssignmentList model (no description)",
"example": {
"teamAssignments": [
{
"id": 1,
"beginDate": "2012-08-02",
"endDate": "2012-08-02",
"employeeObjectId": 8948,
"teamObjectId": 337
}
]
},
"xml": {
"name": "teamAssignments"
}
},
"WeeksheetProfile": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"description": {
"type": "string"
},
"registrationActivities": {
"type": "boolean"
},
"registrationWithDossierReport": {
"type": "boolean"
},
"registrationIndirectActivitiesInFutureAllowed": {
"type": "boolean"
},
"allowCreateBeforeVerifyDate": {
"type": "boolean"
},
"directProfilePolicy": {
"$ref": "#/components/schemas/ProfilePolicy"
},
"indirectProfilePolicy": {
"$ref": "#/components/schemas/ProfilePolicy"
},
"timeWindowDate": {
"type": "string",
"format": "date-time"
},
"allowEditCostCenterOnsAgenda": {
"type": "boolean"
},
"allowEditCostCenterIome": {
"type": "boolean"
},
"allowEditTravelSettingsIoMe": {
"type": "boolean"
},
"allowDistributeClientTime": {
"type": "boolean"
},
"allowCreateVisitOnsVandaag": {
"type": "boolean"
},
"allowEditVisitPlanning": {
"type": "boolean"
},
"allowDeleteVisitPlanning": {
"type": "boolean"
}
},
"description": "The weeksheet profile. It contains information about registration deadlines and permissions.",
"example": {
"id": 10,
"description": "Klinisch Verpleegkundige",
"registrationActivities": true,
"registrationWithDossierReport": true,
"registrationIndirectActivitiesInFutureAllowed": true,
"allowCreateBeforeVerifyDate": false,
"directProfilePolicy": {
"id": 1,
"type": 1,
"createPerm": true,
"createDossier": true,
"hideDefaultBookingDossier": true,
"createBetween": true,
"createBetweenTimegab": 1,
"updateIoserver": true,
"updateIome": true,
"updateIodevice": true,
"updateMoves": true,
"updateOnsAgenda": true,
"updateOnsVandaag": true,
"deleteIoserver": true,
"deleteIome": true,
"deleteIodevice": true,
"deleteMoves": true,
"deleteOnsAgenda": true,
"deleteOnsVandaag": true
},
"indirectProfilePolicy": {
"id": 1,
"type": 1,
"createPerm": true,
"createDossier": true,
"hideDefaultBookingDossier": true,
"createBetween": true,
"createBetweenTimegab": 1,
"updateIoserver": true,
"updateIome": true,
"updateIodevice": true,
"updateMoves": true,
"updateOnsAgenda": true,
"updateOnsVandaag": true,
"deleteIoserver": true,
"deleteIome": true,
"deleteIodevice": true,
"deleteMoves": true,
"deleteOnsAgenda": true,
"deleteOnsVandaag": true
},
"timeWindowDate": "2012-08-02T13:48:46.836+02:00",
"allowEditCostCenterOnsAgenda": true,
"allowEditCostCenterIome": false,
"allowEditTravelSettingsIoMe": true,
"allowDistributeClientTime": true,
"allowCreateVisitOnsVandaag": true,
"allowEditVisitPlanning": true,
"allowDeleteVisitPlanning": true
},
"xml": {
"name": "weeksheetProfile"
}
},
"ProfilePolicy": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "not part of the shared model",
"format": "int64",
"deprecated": true,
"x-cupido-id": true
},
"type": {
"type": "integer",
"format": "int32"
},
"createPerm": {
"type": "boolean"
},
"createDossier": {
"type": "boolean"
},
"hideDefaultBookingDossier": {
"type": "boolean"
},
"createBetween": {
"type": "boolean"
},
"createBetweenTimegab": {
"type": "integer",
"format": "int32"
},
"updateIoserver": {
"type": "boolean"
},
"updateIome": {
"type": "boolean"
},
"updateIodevice": {
"type": "boolean"
},
"updateMoves": {
"type": "boolean"
},
"updateOnsAgenda": {
"type": "boolean"
},
"updateOnsVandaag": {
"type": "boolean"
},
"deleteIoserver": {
"type": "boolean"
},
"deleteIome": {
"type": "boolean"
},
"deleteIodevice": {
"type": "boolean"
},
"deleteMoves": {
"type": "boolean"
},
"deleteOnsAgenda": {
"type": "boolean"
},
"deleteOnsVandaag": {
"type": "boolean"
}
},
"description": "Contains the weeksheet profile policy",
"example": {
"id": 1,
"type": 1,
"createPerm": true,
"createDossier": true,
"hideDefaultBookingDossier": true,
"createBetween": true,
"createBetweenTimegab": 1,
"updateIoserver": true,
"updateIome": true,
"updateIodevice": true,
"updateMoves": true,
"updateOnsAgenda": true,
"updateOnsVandaag": true,
"deleteIoserver": true,
"deleteIome": true,
"deleteIodevice": true,
"deleteMoves": true,
"deleteOnsAgenda": true,
"deleteOnsVandaag": true
}
},
"list.ProfileActivityAssignmentList": {
"type": "object",
"properties": {
"profileActivityAssignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfileActivityAssignment"
}
}
},
"description": "ProfileActivityAssignmentList model (no description)",
"example": {
"profileActivityAssignments": [
{
"id": 1,
"type": 3,
"mobile": false,
"ioMe": false
}
]
}
},
"ProfileActivityAssignment": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"type": {
"type": "integer",
"format": "int32",
"default": 0
},
"mobile": {
"type": "boolean",
"default": false
},
"ioMe": {
"type": "boolean",
"default": false
},
"hourType": {
"$ref": "#/components/schemas/HourType"
},
"expenseType": {
"$ref": "#/components/schemas/expense.ExpenseType"
}
},
"description": "The difference hourtypes from the employees weekcard profile (direct, indirect (time), indirect (duration))",
"example": {
"id": 1,
"type": 3,
"mobile": false,
"ioMe": true,
"hourType": {
"id": 1,
"description": "Activiteiten begeleiding - patiëntgebonden handelen",
"identificationNo": "194822",
"activityGroupObjectId": 1,
"externalCode3": "3",
"active": true,
"payrolling": true,
"direct": true,
"systemDefined": false,
"travelTime": false,
"activityType": "Payrolling",
"groupCare": false,
"quantityBased": true
},
"expenseType": {
"id": 1,
"name": "Kilometers",
"unit": "KM",
"inputType": "Value",
"format": "Float",
"icon": "Walk",
"exportCode": "KMP",
"exportCodeGreaterThanTen": "KMD",
"compensationInCents": 19,
"compensationInCentsGreaterThanTen": 27,
"removed": false,
"travelCalculationEnabled": true,
"beginDate": "1973-12-20T17:00:00.000+01:00",
"endDate": "2015-12-20T17:00:00.000+01:00"
}
}
},
"HourType": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "An unique ID of this hourtype",
"format": "int64",
"x-cupido-id": true
},
"description": {
"type": "string",
"description": "A description of this hourtype"
},
"identificationNo": {
"type": "string"
},
"activityGroupObjectId": {
"type": "integer",
"format": "int64"
},
"externalCode3": {
"type": "string"
},
"active": {
"type": "boolean",
"description": "Indicates if the hourtype is active and can be used in presencelogs"
},
"payrolling": {
"type": "boolean"
},
"direct": {
"type": "boolean",
"description": "Indicates if the hourtype is for client time a.k.a. direct time"
},
"systemDefined": {
"type": "boolean"
},
"travelTime": {
"type": "boolean"
},
"activityType": {
"type": "string"
},
"groupCare": {
"type": "boolean",
"description": "Indicates if the hourtype is meant for group care"
},
"transport": {
"type": "boolean"
},
"quantityBased": {
"type": "boolean"
},
"directAllowed": {
"type": "boolean",
"description": "Indicates it is allowed to write direct clienttime on a presence log with this hourtype"
},
"indirectAllowed": {
"type": "boolean",
"description": "Indicates it is allowed to write indirect clienttime on a presence log with this hourtype"
},
"travelAllowed": {
"type": "boolean",
"description": "Indicates it is allowed to write travel clienttime on a presence log with this hourtype"
},
"noShow": {
"type": "boolean",
"description": "Indicates if the hour type is a no show hourtype"
},
"snomedCode": {
"type": "string",
"description": "Corresponding snomed code used for data exchange with zibs"
},
"travelCalculationDisabled": {
"type": "boolean",
"description": "When set to true, this hourtype will not be used in travel calculations like travel time or distances"
},
"absenceAllowed": {
"type": "boolean",
"description": "Indicates if client(s) are allowed to be partially absent during an activity with this hourtype"
},
"splitHourtype": {
"type": "boolean",
"description": "When set to true, this hourtype will be divided in Administration"
}
},
"description": "A.K.A. Activity.",
"example": {
"id": 1,
"description": "Activiteiten begeleiding - patiëntgebonden handelen",
"identificationNo": "194822",
"activityGroupObjectId": 1,
"externalCode3": "3",
"active": true,
"payrolling": true,
"direct": true,
"systemDefined": false,
"travelTime": false,
"activityType": "Payrolling",
"groupCare": false,
"transport": false,
"quantityBased": true,
"directAllowed": true,
"indirectAllowed": true,
"travelAllowed": true,
"noShow": true,
"snomedCode": "1234",
"travelCalculationDisabled": false,
"absenceAllowed": false,
"splitHourtype": false
},
"xml": {
"name": "hourType"
}
},
"expense.ExpenseType": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"name": {
"type": "string",
"description": "The name of this expenseType"
},
"unit": {
"type": "string",
"description": "The unit in which this expensetype is calculated (km or days)"
},
"inputType": {
"type": "string",
"description": "The type of input used to input expenses made with this unit;\nan input field in case of kilometers or a checkbox in case of days"
},
"format": {
"type": "string",
"description": "the format of the value in which an expense is stored in the database:\n0 for decimal, 1 for float"
},
"icon": {
"type": "string",
"description": "The path to the icon used for this expensetype."
},
"exportCode": {
"type": "string",
"description": "The exportcode for this expenseType"
},
"exportCodeGreaterThanTen": {
"type": "string",
"description": "The exportcode for this expenseType used in case there are more than 10km a day"
},
"compensationInCents": {
"type": "integer",
"description": "The compensation per km for this expensetype in Eurocents.\nUnless the EMIS export is used, the compensation in cents fields are for future use and have no effect",
"format": "int64"
},
"compensationInCentsGreaterThanTen": {
"type": "integer",
"description": "The compensation per km for this expensetype in Eurocents used in case there are more than 10km a day.\nUnless the EMIS export is used, the compensation in cents fields are for future use and have no effect",
"format": "int64"
},
"commuteCode": {
"type": "string",
"description": "The exportcode for this expenseType used for commute km"
},
"commuteCompensationInCents": {
"type": "integer",
"description": "The compensation per km for this expensetype in Eurocents used for commute km.\nUnless the EMIS export is used, the compensation in cents fields are for future use and have no effect",
"format": "int64"
},
"commuteMaxKm": {
"type": "integer",
"description": "The maximum number of commute km for this expenseType",
"format": "int64"
},
"removed": {
"type": "boolean",
"description": "A field denoting whether or not this expenseType has been removed"
},
"travelCalculationEnabled": {
"type": "boolean",
"description": "A field denoting whether or not travel distances should be calculated automatically"
},
"beginDate": {
"type": "string",
"description": "The begindate for this expenseType",
"format": "date-time"
},
"endDate": {
"type": "string",
"description": "The enddate for this expenseType",
"format": "date-time"
},
"alternativeToTravelCalc": {
"type": "boolean"
}
},
"description": "ExpenseType domain model used by Cupido system.\nAn Expensetype is a type of expense for which an employee may be compensated.",
"example": {
"id": 1,
"name": "Kilometers",
"unit": "KM",
"inputType": "Value",
"format": "Float",
"icon": "Walk",
"exportCode": "KMP",
"exportCodeGreaterThanTen": "KMD",
"compensationInCents": 777,
"compensationInCentsGreaterThanTen": 888,
"commuteCode": "WW",
"commuteCompensationInCents": 555,
"commuteMaxKm": 30,
"removed": true,
"travelCalculationEnabled": true,
"beginDate": "1973-12-20T17:00:00.000+01:00",
"endDate": "2015-12-20T17:00:00.000+01:00",
"alternativeToTravelCalc": true
},
"xml": {
"name": "expenseType"
}
},
"ons_administration.list.WorkdayNormSettingsModelList": {
"type": "object",
"properties": {
"workdayNormSettingsModels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ons_administration.WorkdayNormSettingsModel"
}
}
},
"description": "List of WorkdayNormSettingsModels",
"example": {
"workdayNormSettingsModels": [
{
"id": 7,
"employeeObjectId": 42,
"startDate": "2025-12-29",
"endDate": "2026-12-27",
"workdayNormTotal": 20,
"normPeriod": 4,
"optOut": false
},
{
"id": 8,
"employeeObjectId": 42,
"startDate": "2026-12-28",
"workdayNormTotal": 8,
"normPeriod": 2,
"optOut": false
}
]
}
},
"list.EmployeeList": {
"type": "object",
"properties": {
"employees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Employee"
},
"xml": {
"name": "employee"
}
}
},
"description": "EmployeeList model (no description)",
"example": {
"employees": [
{
"id": 1,
"firstName": "Mike",
"dateOfBirth": "2012-08-02",
"birthName": "Wazowski"
}
]
},
"xml": {
"name": "employees"
}
},
"ProblemResponse": {
"required": [
"type",
"title"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "A URI reference [RFC3986] that identifies the problem type. The specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML). We require type to be present, but consider relative URIs that do not return human-readable documentation acceptable.",
"nullable": false
},
"title": {
"type": "string",
"description": "A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see RFC7231, Section 3.4)",
"nullable": false
},
"status": {
"type": "integer",
"description": "The HTTP status code (RFC7231, Section 6) generated by the origin server for this occurrence of the problem",
"nullable": false
},
"detail": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"instance": {
"type": "string",
"description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced."
},
"provider": {
"type": "string",
"description": "A string that identifies the application that provided the error message"
},
"reasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProblemResponseReason"
},
"description": "List of individual error reasons found, with details and a pointer to the location of each."
}
},
"description": "Problem JSON response format, mostly following RFC 9457, but slightly adapted to Nedap's needs.",
"example": {
"type": "/validation-error",
"title": "Your request is not valid.",
"status": 422,
"provider": "Nedap Planning"
}
},
"ProblemResponseReason": {
"required": [
"code",
"pointer"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Code identifying the error. ValidationType.java in ioserver defines the following, it is suggested to try and reuse these when possible: DUPLICATE_KEY, MISSING_FIELD, INVALID_FORMAT, INVALID_STATE, NOT_FOUND, TIME_CONFLICT"
},
"detail": {
"type": "string",
"description": "A human-readable explanation specific to this reason."
},
"pointer": {
"type": "string",
"description": "A JSON pointer to locate the problem within the request's content using a JSON Pointer",
"example": "#/profile/color"
}
},
"description": "Reasons for a problem response, lists attributes of the main or nested object sent",
"example": {
"code": "MISSING_FIELD",
"detail": "Name can't be blank",
"pointer": "#/name"
}
},
"ons_administration.list.TimeCompensationFactorModelList": {
"type": "object",
"properties": {
"timeCompensationFactorModels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ons_administration.TimeCompensationFactorModel"
}
}
},
"description": "List of TimeCompensationFactorModels",
"example": {
"timeCompensationFactorModels": [
{
"employeeId": 7,
"startDate": "2026-01-01",
"endDate": "2026-03-15",
"factor": 0.16,
"status": "COMPENSATION_IN_TIME"
},
{
"employeeId": 8,
"startDate": "2026-02-01",
"endDate": "2026-04-30",
"factor": 0.12,
"status": "DEFAULT_COMPENSATION_IN_TIME"
}
]
}
},
"ons_administration.TimeCompensationFactorModel": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"description": "The object id of the employee",
"format": "int64",
"readOnly": true
},
"endDate": {
"type": "string",
"description": "The end date of the period for which the factor is valid",
"format": "date",
"readOnly": true
},
"factor": {
"type": "number",
"description": "The value of the factor (minimum wage divided by hourly wage)",
"format": "double",
"readOnly": true
},
"startDate": {
"type": "string",
"description": "The start date of the period for which the factor is valid",
"format": "date",
"readOnly": true
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/ons_administration.TimeCompensationFactorStatus"
}
],
"readOnly": true
}
},
"description": "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",
"example": {
"employeeId": 7,
"startDate": "2026-01-01",
"endDate": "2026-03-15",
"factor": 0.16715909090909092,
"status": "COMPENSATION_IN_TIME"
}
},
"ons_administration.TimeCompensationFactorStatus": {
"enum": [
"COMPENSATION_IN_TIME",
"COMPENSATION_IN_MONEY",
"COMPENSATION_IN_TIME_WITH_MISSING_HOURLY_WAGE",
"DEFAULT_COMPENSATION_IN_MONEY",
"DEFAULT_COMPENSATION_IN_TIME"
],
"type": "string",
"description": "Information on the factor computation: COMPENSATION_IN_TIME, COMPENSATION_IN_MONEY, COMPENSATION_IN_TIME_WITH_MISSING_HOURLY_WAGE, DEFAULT_COMPENSATION_IN_MONEY, DEFAULT_COMPENSATION_IN_TIME",
"example": "COMPENSATION_IN_TIME"
},
"ons_administration.list.WorkdayNormPeriodModelList": {
"type": "object",
"properties": {
"workdayNormPeriodModels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ons_administration.WorkdayNormPeriodModel"
}
}
},
"description": "List of WorkdayNormPeriodModels",
"example": {
"workdayNormPeriodModels": [
{
"employeeObjectId": 7,
"startDate": "2025-12-01",
"endDate": "2025-12-28",
"normPeriod": 4,
"optOut": false,
"workdayNorm": 4,
"workdays": [
"2025-12-03",
"2025-12-04"
]
},
{
"employeeObjectId": 9,
"startDate": "2025-12-01",
"endDate": "2025-12-07",
"normPeriod": 1,
"optOut": true,
"workdayNorm": 1,
"workdays": [
"2025-12-03",
"2025-12-04",
"2025-12-05"
]
}
]
}
},
"ons_administration.WorkdayNormPeriodModel": {
"type": "object",
"properties": {
"employeeObjectId": {
"type": "integer",
"description": "The object id of the employee",
"format": "int64",
"readOnly": true
},
"endDate": {
"type": "string",
"description": "The end date of the current period",
"format": "date",
"readOnly": true
},
"normPeriod": {
"type": "integer",
"description": "The measurement period in weeks of the current period",
"format": "int32",
"readOnly": true
},
"optOut": {
"type": "boolean",
"description": "If true, the employee is opted out of the workday norm",
"readOnly": true
},
"startDate": {
"type": "string",
"description": "The start date of the current period",
"format": "date",
"readOnly": true
},
"workdayNorm": {
"type": "integer",
"description": "The total number of workdays the employee has to work in the current period",
"format": "int32",
"readOnly": true
},
"workdays": {
"type": "array",
"items": {
"type": "string",
"description": "The list of dates the employee has registered work in the current period",
"format": "date",
"readOnly": true
},
"description": "The list of dates the employee has registered work in the current period",
"readOnly": true
}
},
"description": "Model for a workday norm period. This model contains the current state of the workday norm for a given\nemployee. This model contains norm, length and already registered workdays for the given employee.\n",
"readOnly": true,
"example": {
"employeeObjectId": 7,
"startDate": "2025-12-01",
"endDate": "2025-12-28",
"normPeriod": 4,
"optOut": false,
"workdayNorm": 4,
"workdays": [
"2025-12-03",
"2025-12-04"
]
}
},
"ons_administration.list.EmployeeWorkdaysOverviewModelList": {
"type": "object",
"properties": {
"employeeWorkdaysOverviewModels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ons_administration.EmployeeWorkdaysOverviewModel"
}
}
},
"description": "List of EmployeeWorkdaysOverviewModel",
"example": {
"employeeWorkdaysOverviewModels": [
{
"employeeObjectId": 42,
"startDate": "2025-12-29",
"endDate": "2026-01-04",
"workdays": [
"2026-12-30",
"2026-01-02",
"2026-01-03"
]
},
{
"employeeObjectId": 43,
"startDate": "2025-12-29",
"endDate": "2026-01-04",
"workdays": [
"2026-12-29",
"2026-01-30",
"2026-01-03",
"2026-01-04"
]
}
]
}
},
"ons_administration.EmployeeWorkdaysOverviewModel": {
"type": "object",
"properties": {
"employeeObjectId": {
"type": "integer",
"description": "The object id of the employee",
"format": "int64",
"readOnly": true
},
"endDate": {
"type": "string",
"description": "The end date of the overview period",
"format": "date",
"readOnly": true
},
"startDate": {
"type": "string",
"description": "The start date of the overview period",
"format": "date",
"readOnly": true
},
"workdays": {
"type": "array",
"items": {
"type": "string",
"description": "The list of dates the employee has registered work in the overview period",
"format": "date",
"readOnly": true
},
"description": "The list of dates the employee has registered work in the overview period",
"readOnly": true
}
},
"description": "Model for the workday overview for the workday norm clause. Note that this can deviate from workday counts\nproduced bij salary exports or reports, since these counts can be filtered by the export profiles.\n",
"readOnly": true,
"example": {
"employeeObjectId": 42,
"startDate": "2025-12-29",
"endDate": "2026-01-04",
"workdays": [
"2026-12-30",
"2026-01-02",
"2026-01-03"
]
}
},
"evs.EvsAbility": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Ability"
}
],
"properties": {
"label": {
"type": "string"
},
"redirectUrl": {
"type": "string"
}
},
"description": "EvsAbility model (no description)",
"example": {
"enabled": true,
"possible": false,
"message": "This client is not yet in the Evs. If you continue the client will be synchronized.",
"label": "Prescribe",
"redirectUrl": "/view/client/42/prescribe"
}
},
"expense.list.ExpenseTypeList": {
"type": "object",
"properties": {
"expenseTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/expense.ExpenseType"
},
"xml": {
"name": "expenseType"
}
}
},
"description": "ExpenseTypeList model (no description)",
"example": {
"expenseTypes": [
{
"id": 1,
"name": "Kilometers",
"unit": "KM",
"inputType": "Value",
"format": "Float",
"icon": "Walk",
"exportCode": "KMP",
"exportCodeGreaterThanTen": "KMD",
"compensationInCents": 777,
"compensationInCentsGreaterThanTen": 888,
"removed": true,
"travelCalculationEnabled": true,
"beginDate": "1973-12-20T17:00:00.000+01:00",
"endDate": "2015-12-20T17:00:00.000+01:00"
}
]
},
"xml": {
"name": "expenseTypes"
}
},
"expense.list.ExpenseList": {
"type": "object",
"properties": {
"expenses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/expense.Expense"
},
"xml": {
"name": "expense"
}
}
},
"description": "ExpenseList model (no description)",
"example": {
"expenses": [
{
"id": 1,
"expenseDate": "2015-09-15",
"verifyDate": "2015-10-15",
"expenseTypeObjectId": 1,
"employeeObjectId": 1,
"amount": 11.23,
"calculatedAmount": 1.23,
"deviation": 10.5,
"description": "The bridge was open"
},
{
"id": 1,
"expenseDate": "2015-09-15",
"verifyDate": "2015-10-15",
"expenseTypeObjectId": 1,
"employeeObjectId": 1,
"amount": 11.23,
"calculatedAmount": 1.23,
"deviation": 10.5,
"description": "The bridge was open"
}
]
},
"xml": {
"name": "expenses"
}
},
"list.ExpertiseGroupList": {
"type": "object",
"properties": {
"expertiseGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExpertiseGroup"
},
"xml": {
"name": "expertiseGroup"
}
}
},
"description": "ExpertiseGroupList model (no description)",
"example": {
"expertiseGroups": [
{
"id": 1,
"name": "Alphahulp",
"beginDate": "2016-01-01",
"endDate": "2021-12-31",
"expertiseProfiles": [
{
"id": 5,
"description": "Helpenden A",
"visible": true,
"beginDate": "2015-01-01T12:00:00.000+01:00",
"endDate": "2020-01-01T12:00:00.000+01:00",
"allowDossierActions": true,
"allowDossierConfidential": false
},
{
"id": 6,
"description": "Helpenden B",
"visible": true,
"beginDate": "2015-01-01T12:00:00.000+01:00",
"endDate": "2020-01-01T12:00:00.000+01:00",
"allowDossierActions": true,
"allowDossierConfidential": false
}
]
}
]
},
"xml": {
"name": "expertiseGroups"
}
},
"list.HourTypeList": {
"type": "object",
"properties": {
"hourTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HourType"
},
"xml": {
"name": "hourType"
}
}
},
"description": "HourTypeList model (no description)",
"example": {
"hourTypes": [
{
"id": 1,
"description": "Activiteiten begeleiding - patiëntgebonden handelen",
"identificationNo": "194822",
"activityGroupObjectId": 1,
"externalCode3": "3",
"active": true,
"payrolling": true,
"direct": true,
"systemDefined": false,
"travelTime": false,
"activityType": "Payrolling",
"groupCare": false,
"noShow": true,
"travelCalculationDisabled": false,
"absenceAllowed": false
}
]
},
"xml": {
"name": "hourTypes"
}
},
"export.ExportUuid": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
}
},
"description": "Export Status entry returned from Cupido.",
"example": {
"uuid": "af99a660-c49d-11e7-abc4-cec278b6b50a"
},
"xml": {
"name": "exportUuid"
}
},
"export.list.ExportPresenceLogList": {
"type": "object",
"properties": {
"exportPresenceLogs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/export.ExportPresenceLog"
},
"xml": {
"name": "exportPresenceLog"
}
}
},
"description": "ExportPresenceLogList model (no description)",
"example": {
"exportPresenceLogs": [
{
"clientId": 234,
"employeeId": 123,
"teamId": 345,
"locationId": 456,
"employeeContractId": "567",
"productName": "name",
"isDuration": true,
"beginDate": "1973-12-20T17:00:00.000+01:00",
"endDate": "2015-12-20T17:23:59.999+01:00",
"duration": true
}
]
},
"xml": {
"name": "exportPresenceLogs"
}
},
"export.ExportPresenceLog": {
"type": "object",
"properties": {
"clientId": {
"type": "integer",
"format": "int64"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"teamId": {
"type": "integer",
"format": "int64"
},
"locationId": {
"type": "integer",
"format": "int64"
},
"employeeContractId": {
"type": "string"
},
"productName": {
"type": "string"
},
"isDuration": {
"type": "boolean",
"default": false
},
"beginDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
},
"duration": {
"type": "boolean",
"description": "Deprecated since: 2022-06-28, use is_duration instead",
"deprecated": true
}
},
"description": "Export presence log entry returned from Cupido.",
"example": {
"clientId": 234,
"employeeId": 123,
"teamId": 345,
"locationId": 456,
"employeeContractId": "567",
"productName": "name",
"isDuration": true,
"beginDate": "1973-12-20T17:00:00.000+01:00",
"endDate": "2015-12-20T17:23:59.999+01:00",
"duration": true
},
"xml": {
"name": "exportPresenceLog"
}
},
"export.ExportStatus": {
"type": "object",
"properties": {
"exportUuid": {
"$ref": "#/components/schemas/export.ExportUuid"
},
"exportStatusType": {
"$ref": "#/components/schemas/export.ExportStatusType"
},
"exportSettings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/export.ExportSetting"
},
"xml": {
"wrapped": true
}
}
},
"description": "Export Status entry returned from Cupido.",
"example": {
"exportUuid": {
"uuid": "af99a660-c49d-11e7-abc4-cec278b6b50a"
},
"exportStatusType": "RUNNING",
"exportSettings": [
{
"key": "start date",
"value": "2015-12-20T17:23:59.999+01:00"
}
]
},
"xml": {
"name": "exportStatus"
}
},
"export.ExportStatusType": {
"enum": [
"STARTED",
"RUNNING",
"FINISHED",
"ERROR",
"UNKNOWN"
],
"type": "string",
"description": "ExportStatusType enum (no description)",
"example": "STARTED"
},
"export.ExportSetting": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"description": "ExportSetting model (no description)",
"example": {
"key": "start date",
"value": "2015-12-20T17:23:59.999+01:00"
},
"xml": {
"name": "exportSetting"
}
},
"finance.list.GroupActivityModelList": {
"type": "object",
"properties": {
"groupActivities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/finance.GroupActivityModel"
}
}
},
"description": "List of group activity models",
"example": {
"groupActivities": [
{
"id": 1234,
"name": "Group Activity Name",
"distinctFinanceTypeCount": 5
},
{
"id": 2345,
"name": "Another Group Activity",
"distinctFinanceTypeCount": 0
}
]
}
},
"finance.GroupActivityModel": {
"required": [
"name"
],
"type": "object",
"properties": {
"distinctFinanceTypeCount": {
"type": "integer",
"format": "int32"
},
"financeTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/finance.NamedItemModel"
}
},
"id": {
"type": "integer",
"description": "Required for UPDATE or DELETE operations, not required for CREATE",
"format": "int64"
},
"name": {
"type": "string",
"description": "Name of the group activity. Required for create and update operations.",
"example": "Group Activity Name"
}
},
"description": "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 payload when reading group activities. Field guidance:\n- id: database identifier, optional for create and required for update/delete.\n- name: human-readable label for the group activity (required).\n- financeTypeCount: number of distinct finance types associated with this group activity; clients may omit this and the server can compute it from the `financeTypes` list.\n- financeTypes: optional list of finance types (id + name) attached to this group activity; provide these to explicitly set associations on create/update.",
"example": {
"id": 1234,
"name": "Group Activity Name",
"distinctFinanceTypeCount": 2,
"financeTypes": [
{
"id": 1,
"name": "Finance Type A"
},
{
"id": 2,
"name": "Finance Type B"
}
]
}
},
"finance.NamedItemModel": {
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique object identifier for the referenced entity. Required when referencing an existing item.",
"format": "int64",
"example": 123
},
"name": {
"type": "string",
"description": "Human-friendly name or label for the referenced entity. Required.",
"example": "Item name"
}
},
"description": "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 and display label.",
"example": {
"id": 123,
"name": "Item name"
}
},
"finance.list.GroupActivitySuggestionModelList": {
"type": "object",
"properties": {
"groupActivitySuggestions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/finance.GroupActivitySuggestionModel"
}
}
},
"description": "List of group activity suggestions",
"example": {
"groupActivitySuggestions": [
{
"activityObjectId": 10,
"clientObjectId": 200,
"surchargeActivityObjectIds": [
100,
101
]
}
]
}
},
"finance.GroupActivitySuggestionModel": {
"required": [
"clientObjectId",
"surchargeActivityObjectIds"
],
"type": "object",
"properties": {
"activityObjectId": {
"type": "integer",
"description": "Optional selected activity object id recommended for the client. May be null to indicate 'no suggestion'.",
"format": "int64",
"example": 101
},
"clientObjectId": {
"type": "integer",
"description": "Client object id for which the suggestion applies. Required.",
"format": "int64",
"example": 200
},
"surchargeActivityObjectIds": {
"type": "array",
"items": {
"type": "integer",
"description": "List of surcharge activity object ids associated with the suggestion. Required (empty list if none).",
"format": "int64"
},
"description": "List of surcharge activity object ids associated with the suggestion. Required (empty list if none).",
"example": [
300,
301
]
}
},
"description": "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.",
"example": {
"clientObjectId": 200,
"activityObjectId": 101,
"surchargeActivityObjectIds": [
300,
301
]
}
},
"finance.list.CareOrderProductList": {
"type": "object",
"properties": {
"careOrderProducts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/finance.CareOrderProduct"
},
"xml": {
"name": "careOrderProduct"
}
}
},
"description": "CareOrderProductList model (no description)",
"example": {
"careOrderProducts": [
{
"id": 1,
"careOrderId": 1,
"userIdentifier": "Dummy",
"quantity": 1,
"quantityUnit": "Dummy",
"comments": "Dummy",
"productId": 1,
"financeTypeId": 1,
"instellingsCode": "Dummy",
"functietype": "Dummy",
"debtorId": 1,
"beginDate": "2014-12-29T00:00:00.000+01:00",
"endDate": "2014-12-29T00:00:00.000+01:00",
"clippedBeginDate": "2014-12-29T00:00:00.000+01:00",
"clippedEndDate": "2014-12-29T00:00:00.000+01:00"
}
]
},
"xml": {
"name": "careOrderProducts"
}
},
"finance.list.CareOrderList": {
"type": "object",
"properties": {
"careOrders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/finance.CareOrder"
},
"xml": {
"name": "careOrder"
}
}
},
"description": "CareOrderList model (no description)",
"example": {
"careOrders": [
{
"id": 1,
"userIdentifier": "Dummy",
"clientIdentifier": "Dummy",
"beschikkingsNummer": "Dummy",
"lawIdentification": "Dummy",
"indicatieorgaanCode": "Dummy",
"aanvraagNummer": "Dummy",
"issueDate": "2014-12-29T00:00:00.000+01:00",
"contactPerson": "Dummy",
"comments": "Dummy",
"beginDate": "2014-12-29T00:00:00.000+01:00",
"endDate": "2014-12-29T00:00:00.000+01:00",
"clientId": 1,
"financeTypeId": 1,
"debtorId": 1,
"careOrderProducts": [
{
"id": 1,
"careOrderId": 1,
"userIdentifier": "1",
"quantity": 1,
"quantityUnit": "MinutesPerWeek",
"magnitudeQuantityValue": 1,
"magnitudeUnitQuantity": 1,
"magnitudeUnitType": "MINUTE",
"magnitudeFrequency": "PER_WEEK",
"comments": "comments",
"productId": 1,
"financeTypeId": 1,
"instellingsCode": "ABCD",
"functietype": "ZZP",
"debtorId": 1,
"beginDate": "2014-12-29T00:00:00.000+01:00",
"endDate": "2014-12-29T00:00:00.000+01:00",
"clippedBeginDate": "2014-12-29T00:00:00.000+01:00",
"clippedEndDate": "2014-12-29T00:00:00.000+01:00"
},
{
"id": 2,
"careOrderId": 1,
"userIdentifier": "1",
"quantity": 2,
"quantityUnit": "MinutesPerWeek",
"magnitudeQuantityValue": 1,
"magnitudeUnitQuantity": 1,
"magnitudeUnitType": "MINUTE",
"magnitudeFrequency": "PER_WEEK",
"comments": "comments",
"productId": 1,
"financeTypeId": 1,
"instellingsCode": "ABCD",
"functietype": "ZZP",
"debtorId": 1,
"beginDate": "2014-12-29T00:00:00.000+01:00",
"endDate": "2014-12-29T00:00:00.000+01:00",
"clippedBeginDate": "2014-12-29T00:00:00.000+01:00",
"clippedEndDate": "2014-12-29T00:00:00.000+01:00"
}
]
}
]
},
"xml": {
"name": "careOrders"
}
},
"finance.list.ClientFinancedProductList": {
"type": "object",
"properties": {
"clientFinancedProducts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/finance.ClientFinancedProduct"
},
"xml": {
"name": "clientFinancedProduct"
}
}
},
"description": "ClientFinancedProductList model (no description)",
"example": {
"clientFinancedProducts": [
{
"clientObjectId": 1,
"financeTypeObjectId": 2,
"financedProducts": [
{
"productObjectId": 2,
"startDate": "2018-01-01",
"endDate": "2018-01-31"
},
{
"productObjectId": 3,
"startDate": "2018-02-01",
"endDate": "2018-03-01"
}
]
}
]
},
"xml": {
"name": "clientFinancedProducts"
}
},
"finance.ClientFinancedProduct": {
"type": "object",
"properties": {
"clientObjectId": {
"type": "integer",
"description": "The client for which we produce a list of products which are legally financed",
"format": "int64"
},
"financeTypeObjectId": {
"type": "integer",
"format": "int64"
},
"financedProducts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/finance.FinancedProduct"
},
"description": "The list of products",
"xml": {
"wrapped": true
}
}
},
"description": "ClientFinancedProduct model (no description)",
"example": {
"clientObjectId": 1,
"financeTypeObjectId": 2,
"financedProducts": [
{
"productObjectId": 2,
"startDate": "2018-01-01",
"endDate": "2018-01-31"
},
{
"productObjectId": 3,
"startDate": "2018-02-01",
"endDate": "2018-03-01"
}
]
},
"xml": {
"name": "clientFinancedProduct"
}
},
"finance.FinancedProduct": {
"type": "object",
"properties": {
"productObjectId": {
"type": "integer",
"description": "The product that the client has legal financial rights for",
"format": "int64"
},
"startDate": {
"type": "string",
"description": "The start date the product has legal financial rights",
"format": "date"
},
"endDate": {
"type": "string",
"description": "The end date (inclusive) the product has financial rights",
"format": "date"
}
},
"description": "FinancedProduct model (no description)",
"example": {
"productObjectId": 2,
"startDate": "2018-01-01",
"endDate": "2018-01-31"
},
"xml": {
"name": "financedProduct"
}
},
"finance.list.DeclarationRuleList": {
"type": "object",
"properties": {
"declarationRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/finance.DeclarationRule"
},
"xml": {
"name": "declarationRule"
}
}
},
"description": "DeclarationRuleList model (no description)",
"example": {
"declarationRules": [
{
"id": 1,
"clientObjectId": 1,
"beginDate": "2017-06-06",
"endDate": "2017-06-06",
"createdAt": "2017-06-06",
"updatedAt": "2017-06-06",
"tariff": 1,
"priority": 1,
"employeeObjectId": 1,
"productObjectId": 1,
"indicatieBesluitObjectId": 1,
"source": "manual",
"instellingscode": "42420993",
"zorgkantoorcode": "5521",
"weekday1": 1,
"weekday2": 1,
"weekday3": 1,
"weekday4": 1,
"weekday5": 1,
"weekday6": 1,
"weekday7": 1,
"declareOnResidence": true,
"zzpType": "zzp declaration",
"type": 1,
"careOrderProductObjectId": 1,
"clientScheduleObjectId": 1,
"amount": 1,
"declarablePeriods": [
{
"start": "2017-06-06",
"end": "2017-06-06"
}
]
}
]
},
"xml": {
"name": "declarationRules"
}
},
"BooleanWithReason": {
"required": [
"result"
],
"type": "object",
"properties": {
"result": {
"type": "boolean",
"description": "Answer to the question"
},
"reason": {
"type": "string"
}
},
"description": "This class is used to answer a simple true/false question with an optional reason.",
"example": {
"result": true,
"reason": "Just Because!"
},
"xml": {
"name": "booleanWithReason"
}
},
"DateWrapper": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The wrapped date",
"format": "date"
}
},
"description": "DateWrapper can be used to return date's from API calls. ",
"example": {
"date": "2018-03-26"
},
"xml": {
"name": "dateWrapper"
}
},
"finance.list.ProductList": {
"type": "object",
"properties": {
"products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/finance.Product"
},
"xml": {
"name": "product"
}
}
},
"description": "ProductList model (no description)",
"example": {
"products": [
{
"id": 1,
"productCode": "Dummy",
"code": "Dummy",
"userIdentifier": "Dummy",
"type": 1,
"description": "Dummy",
"financeTypeId": 1,
"beginDate": "2016-01-28",
"endDate": "2016-01-29",
"declarable": true
}
]
},
"xml": {
"name": "products"
}
},
"finance.Product": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"productCode": {
"type": "string",
"description": "Product code as defined by standards, i.e., as filled in for declarations and invoices.\nNot set for self-defined (non declaration standard) products (i.e., custom invoicing), or grouped products (municipality product groups).\nPrimary care products are an exception here in that they use the code field for this."
},
"code": {
"type": "string",
"description": "Product code, when defined it can be used for importing (xml).\nPrimary care products use this field for the declaration standard."
},
"userIdentifier": {
"type": "string"
},
"type": {
"type": "integer",
"description": "Indicates a type of product;\n0, 5 = self defined\n1, 2, 3, 4 = WLZ\n6 = DBC\n7 = primary care\n8 = municipality\n9 = product category (for JW/WMO)\n10, 11 = forensic care\n12, 13, 14, 15 = *GGZ",
"format": "int32"
},
"description": {
"type": "string"
},
"financeTypeId": {
"type": "integer",
"format": "int64"
},
"beginDate": {
"type": "string",
"format": "date"
},
"endDate": {
"type": "string",
"format": "date"
},
"declarable": {
"type": "boolean"
}
},
"description": "Product model (no description)",
"example": {
"id": 1,
"productCode": "Dummy",
"code": "Dummy",
"userIdentifier": "Dummy",
"type": 1,
"description": "Dummy",
"financeTypeId": 1,
"beginDate": "2016-01-28",
"endDate": "2016-01-29",
"declarable": true
},
"xml": {
"name": "product"
}
},
"finance.list.InvoiceProviderGroupList": {
"type": "object",
"properties": {
"invoiceProviderGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/finance.InvoiceProviderGroup"
},
"xml": {
"name": "invoiceProviderGroup"
}
}
},
"description": "InvoiceProviderGroupList model (no description)",
"example": {
"invoiceProviderGroups": [
{
"id": 1,
"beginDate": "2018-01-28T00:00:00.000+01:00",
"active": true,
"updatedAt": "2018-02-07T00:00:00.000+01:00",
"koepelCode": "12345678",
"debtorIds": [
1,
2,
3,
4
],
"providers": [
"11111111",
"22222222"
]
},
{
"id": 2,
"beginDate": "2018-01-28T00:00:00.000+01:00",
"active": false,
"updatedAt": "2018-02-07T00:00:00.000+01:00",
"koepelCode": "87654321",
"debtorIds": [
5
],
"providers": [
"33333333",
"44444444"
]
}
]
},
"xml": {
"name": "invoiceProviderGroups"
}
},
"finance.InvoiceProviderGroup": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Reference to export profile (where this model is based on).",
"format": "int64",
"x-cupido-id": true
},
"beginDate": {
"type": "string",
"description": "Begin date from which this 'koepel' has been active.",
"format": "date-time"
},
"active": {
"type": "boolean",
"description": "Whether the invoice provider group is currently active.\nIn case it is not active it has been inactive since 'updatedAt'.",
"default": false
},
"updatedAt": {
"type": "string",
"description": "When the last change has been made.",
"format": "date-time"
},
"koepelCode": {
"type": "string",
"description": "Code that will be used as 'koepel' to group a set of providers."
},
"debtorIds": {
"type": "array",
"items": {
"type": "integer",
"description": "When empty no filter should be applied, otherwise a filter for which\nthis 'koepel' is applicable.",
"format": "int64",
"xml": {
"name": "debtorId"
}
},
"description": "When empty no filter should be applied, otherwise a filter for which\nthis 'koepel' is applicable.",
"xml": {
"wrapped": true
}
},
"providers": {
"type": "array",
"items": {
"type": "string",
"description": "When empty, all providers are part of the 'koepel' otherwise a set of\nproviders that are part of the 'koepel'.",
"xml": {
"name": "provider"
}
},
"description": "When empty, all providers are part of the 'koepel' otherwise a set of\nproviders that are part of the 'koepel'.",
"xml": {
"wrapped": true
}
}
},
"description": "An 'InvoiceProviderGroup' models a specific type of 'ExportProfile', i.e.,\nexport profiles for which it holds that they have a property set for 'koepel' and have an export category of invoice.",
"example": {
"id": 1,
"beginDate": "2018-01-28T00:00:00.000+01:00",
"active": true,
"updatedAt": "2018-02-07T00:00:00.000+01:00",
"koepelCode": "12345678",
"debtorIds": [
1,
2,
3,
4
],
"providers": [
"11111111",
"22222222"
]
},
"xml": {
"name": "invoiceProviderGroup"
}
},
"finance.list.ParallelCareOrderList": {
"type": "object",
"properties": {
"parallelCareOrders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/finance.ParallelCareOrder"
}
}
},
"description": "ParallelCareOrderList model (no description)",
"example": {
"parallelCareOrders": [
{
"careOrder": {
"id": 1,
"userIdentifier": "Bggz-12345",
"clientIdentifier": "12345",
"beschikkingsNummer": "321",
"lawIdentification": "321",
"indicatieorgaanCode": "0710",
"aanvraagNummer": "123",
"issueDate": "2014-12-29T00:00:00.000+01:00",
"contactPerson": "Dhr. Psycholoog",
"comments": "Client kan agressief reageren op de kleur rood",
"beginDate": "2014-12-29T00:00:00.000+01:00",
"endDate": "2014-12-29T00:00:00.000+01:00",
"clientId": 1,
"financeTypeId": 1,
"debtorId": 1
},
"hourTypes": [
{
"id": 1,
"description": "Activiteiten begeleiding - patiëntgebonden handelen",
"identificationNo": "194822",
"activityGroupObjectId": 1,
"externalCode3": "3",
"active": true,
"payrolling": true,
"direct": true,
"systemDefined": false,
"travelTime": false,
"activityType": "Payrolling",
"groupCare": false,
"quantityBased": true
}
],
"productName": "bggzkort",
"totalRegisteredAmount": 5,
"maxRegisteredAmount": 10,
"registeredUnit": "QUARTERS",
"errorMessage": "",
"referringDiagnosisCode": "1234"
}
]
}
},
"finance.ParallelCareOrder": {
"type": "object",
"properties": {
"careOrder": {
"$ref": "#/components/schemas/finance.CareOrder"
},
"hourTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HourType"
}
},
"productName": {
"type": "string"
},
"totalRegisteredAmount": {
"type": "integer",
"description": "The total amount already registered",
"format": "int32",
"default": 0
},
"maxRegisteredAmount": {
"type": "integer",
"description": "The maximal allowed amount that is allowed to registered",
"format": "int32",
"default": 0
},
"registeredUnit": {
"allOf": [
{
"$ref": "#/components/schemas/RegisteredUnit"
}
],
"description": "The unit of totalRegisteredAmount and maxRegisteredAmount"
},
"errorMessage": {
"type": "string"
},
"referringDiagnosisCode": {
"type": "string",
"description": "The corresponding referring diagnosis code of an Paramedische Eerstelijnszorg Careorder"
}
},
"description": "Model class holding\n\n@Author joel.witteveen",
"example": {
"careOrder": {
"id": 1,
"userIdentifier": "Bggz-12345",
"clientIdentifier": "12345",
"beschikkingsNummer": "321",
"lawIdentification": "321",
"indicatieorgaanCode": "0710",
"aanvraagNummer": "123",
"issueDate": "2014-12-29T00:00:00.000+01:00",
"contactPerson": "Dhr. Psycholoog",
"comments": "Client kan agressief reageren op de kleur rood",
"beginDate": "2014-12-29T00:00:00.000+01:00",
"endDate": "2014-12-29T00:00:00.000+01:00",
"clientId": 1,
"financeTypeId": 1,
"debtorId": 1
},
"hourTypes": [
{
"id": 1,
"description": "Activiteiten begeleiding - patiëntgebonden handelen",
"identificationNo": "194822",
"activityGroupObjectId": 1,
"externalCode3": "3",
"active": true,
"payrolling": true,
"direct": true,
"systemDefined": false,
"travelTime": false,
"activityType": "Payrolling",
"groupCare": false,
"quantityBased": true
}
],
"productName": "bggzkort",
"totalRegisteredAmount": 5,
"maxRegisteredAmount": 10,
"registeredUnit": "QUARTERS",
"errorMessage": "",
"referringDiagnosisCode": "1234"
}
},
"RegisteredUnit": {
"enum": [
"PIECES",
"MINUTES",
"QUARTERS",
"HOURS"
],
"type": "string",
"description": "The unit of totalRegisteredAmount and maxRegisteredAmount",
"example": "PIECES"
},
"payroll.holiday.list.HolidayList": {
"type": "object",
"properties": {
"holidays": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payroll.holiday.Holiday"
},
"xml": {
"name": "holiday"
}
}
},
"description": "HolidayList model (no description)",
"example": {
"holidays": [
{
"id": 1,
"name": "Nieuwjaarsdag",
"compensationMinutes": 250,
"date": "2016-01-01"
},
{
"id": 1234,
"name": "Geen EK voor nederland dag",
"compensationMinutes": 125,
"date": "2016-06-01"
}
]
},
"xml": {
"name": "holidays"
}
},
"payroll.holiday.Holiday": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"name": {
"type": "string"
},
"compensationMinutes": {
"type": "integer",
"format": "int32",
"default": 0
},
"date": {
"type": "string",
"format": "date"
}
},
"description": "Holiday model (no description)",
"example": {
"id": 1,
"name": "Nieuwjaarsdag",
"compensationMinutes": 250,
"date": "2016-01-01"
},
"xml": {
"name": "holiday"
}
},
"list.HourTypeCategoryList": {
"type": "object",
"properties": {
"hourTypeCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HourTypeCategory"
},
"xml": {
"name": "hourTypeCategory"
}
}
},
"description": "HourTypeCategoryList model (no description)",
"example": {
"hourTypeCategories": [
{
"id": 1,
"description": "Vervoer dagbesteding WLZ 2019"
}
]
},
"xml": {
"name": "hourTypeCategories"
}
},
"HourTypeCategory": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"description": {
"type": "string"
}
},
"description": "Category for {@link HourType}.",
"example": {
"id": 1,
"description": "Vervoer dagbesteding WLZ 2019"
},
"xml": {
"name": "hourTypeCategory"
}
},
"list.HourTypeProductAssignmentList": {
"type": "object",
"properties": {
"hourTypeProductAssignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HourTypeProductAssignment"
},
"xml": {
"name": "hourTypeProductAssignment"
}
}
},
"description": "HourTypeProductAssignmentList model (no description)",
"example": {
"hourTypeProductAssignments": [
{
"id": 1,
"productId": 1,
"debtorId": 1,
"hourTypeId": 1,
"expertiseProfileId": 1,
"agbCode": "12345678",
"rank": 1,
"declarableProductId": 1,
"leveringsvoorwaardePerClient": false,
"beginDate": "2022-01-01",
"endDate": "2022-12-31",
"percentage": 100
}
]
},
"xml": {
"name": "hourTypeProductAssignments"
}
},
"HourTypeProductAssignment": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique ID of this HourTypeProductAssignment",
"format": "int64",
"x-cupido-id": true
},
"productId": {
"type": "integer",
"description": "Id of the {@link Product} in the {@link CareOrderProduct} this assignment matches on.",
"format": "int64"
},
"debtorId": {
"type": "integer",
"description": "Optional id of the {@link Debtor} this assignment matches on.",
"format": "int64"
},
"hourTypeId": {
"type": "integer",
"description": "Id of the {@link HourType} this assignment belongs to.",
"format": "int64"
},
"expertiseProfileId": {
"type": "integer",
"description": "Optional id of the {@link ExpertiseProfile} this assignment matches on.",
"format": "int64"
},
"agbCode": {
"type": "string",
"description": "Optional AGB code this assignment matches on."
},
"rank": {
"type": "integer",
"description": "Rank of this assignment in the assignment matching sequence for the {@link HourType} this assignment belongs to. A lower number means a higher priority.",
"format": "int32"
},
"declarableProductId": {
"type": "integer",
"description": "Id of the {@link Product} is used for invoicing when this assignment matches.",
"format": "int64"
},
"leveringsvoorwaardePerClient": {
"type": "boolean",
"description": "This field indicates if the leveringsvoorwaarde should be used when matching the assignment. It is only used for old AWBZ {@link CareOrder}s."
},
"beginDate": {
"type": "string",
"description": "Begin date of the validity period for this assignment.",
"format": "date"
},
"endDate": {
"type": "string",
"description": "End date of the validity period for this assignment.",
"format": "date"
},
"percentage": {
"type": "integer",
"description": "Percentage that this rule contributes to the final invoice",
"format": "int32"
}
},
"description": "A.K.A. ProductActivityAssignment in IOServer",
"example": {
"id": 1,
"productId": 1,
"debtorId": 1,
"hourTypeId": 1,
"expertiseProfileId": 1,
"agbCode": "12345678",
"rank": 1,
"declarableProductId": 1,
"leveringsvoorwaardePerClient": false,
"beginDate": "2022-01-01",
"endDate": "2022-12-31",
"percentage": 100
},
"xml": {
"name": "hourTypeProductAssignment"
}
},
"ons_administration.list.WorkdayHourTypeModelList": {
"type": "object",
"properties": {
"workdayHourTypeModels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ons_administration.WorkdayHourTypeModel"
}
}
},
"description": "List of WorkdayHourTypeModels",
"example": {
"workdayHourTypeModels": [
{
"hourTypeObjectId": 13,
"validPeriods": [
{
"start": "2025-12-29"
}
]
},
{
"hourTypeObjectId": 42,
"validPeriods": [
{
"start": "2025-12-29",
"end": "2026-06-28"
},
{
"start": "2026-12-27"
}
]
}
]
}
},
"ons_administration.WorkdayHourTypeModel": {
"required": [
"hourTypeObjectId"
],
"type": "object",
"properties": {
"hourTypeObjectId": {
"type": "integer",
"description": "The object id of the hour type (activity)",
"format": "int64"
},
"validPeriods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Period"
},
"description": "The list of periods during which this hour type is counted as a workday"
}
},
"description": "This model describes when a given hour type (activity) will be counted as a workday according to the workday norm.\n",
"example": {
"hourTypeObjectId": 7,
"validPeriods": [
{
"start": "2025-12-29",
"end": "2026-12-27"
},
{
"start": "2027-12-27"
}
]
}
},
"payroll.HourlyWage": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"wageInCents": {
"type": "integer",
"format": "int32"
},
"beginDate": {
"type": "string",
"format": "date"
},
"endDate": {
"type": "string",
"format": "date"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"description": "HourlyWage model (no description)",
"example": {
"id": 1,
"employeeId": 10,
"wageInCents": 1500,
"beginDate": "2017-01-01",
"endDate": "2017-10-01",
"createdAt": "2017-10-23T00:00:00.000+02:00",
"updatedAt": "2017-10-23T00:00:00.000+02:00"
},
"xml": {
"name": "hourlyWage"
}
},
"payroll.list.HourlyWageList": {
"type": "object",
"properties": {
"hourlyWages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payroll.HourlyWage"
}
}
},
"description": "HourlyWageList model (no description)",
"example": {
"hourlyWages": [
{
"id": 1,
"employeeId": 10,
"wageInCents": 1500,
"beginDate": "2017-01-01",
"endDate": "2017-10-01",
"createdAt": "2017-10-23T00:00:00.000+02:00",
"updatedAt": "2017-10-23T00:00:00.000+02:00"
}
]
}
},
"list.LocationAssignmentResidenceList": {
"type": "object",
"properties": {
"locationAssignmentResidences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LocationAssignmentResidence"
}
}
},
"description": "LocationAssignmentResidenceList model (no description)",
"example": {
"locationAssignmentResidences": [
{
"id": 1,
"beginDate": "2012-08-02",
"beginTime": "10:11:00.000",
"endDate": "2012-08-02",
"endTime": "12:13:00.000",
"clientObjectId": 2,
"locationObjectId": 3,
"moveDate": "2012-08-02",
"locationAssignmentType": "MAIN",
"residence": false,
"mainLocation": true,
"medicineLocation": false
}
]
}
},
"list.NavigationAvailabilityList": {
"type": "object",
"properties": {
"navigationAvailabilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NavigationAvailability"
},
"xml": {
"name": "navigationAvailability"
}
}
},
"description": "List of navigation items with their availability",
"example": {
"navigationAvailabilities": [
{
"key": "VERIFY_DECLARATION_RULES",
"value": "AVAILABLE"
}
]
},
"xml": {
"name": "navigationAvailabilities"
}
},
"NavigationAvailability": {
"type": "object",
"properties": {
"key": {
"allOf": [
{
"$ref": "#/components/schemas/NavigationAvailabilityKey"
}
],
"description": "Item for navigation availability request"
},
"value": {
"allOf": [
{
"$ref": "#/components/schemas/NavigationAvailabilityState"
}
],
"description": "State of the navigation availability"
}
},
"description": "A navigation item with its availability",
"example": {
"key": "VERIFY_DECLARATION_RULES",
"value": "AVAILABLE"
},
"xml": {
"name": "navigationAvailability"
}
},
"NavigationAvailabilityKey": {
"enum": [
"VERIFY_DECLARATION_RULES"
],
"type": "string",
"description": "Item for navigation availability request",
"example": "VERIFY_DECLARATION_RULES"
},
"NavigationAvailabilityState": {
"enum": [
"AVAILABLE",
"DISABLED",
"UNAVAILABLE"
],
"type": "string",
"description": "Item for navigation availability request",
"example": "AVAILABLE"
},
"dossier.omaha.list.InterventionCategoryList": {
"type": "object",
"properties": {
"omahaInterventionCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.omaha.InterventionCategory"
},
"xml": {
"name": "omahaInterventionCategory"
}
}
},
"description": "InterventionCategoryList model (no description)",
"example": {
"omahaInterventionCategories": [
{
"classificationId": "intervention.category.teaching_guidance_counseling",
"name": "Adviseren, Instrueren, Begeleiden"
},
{
"classificationId": "intervention.category.treatments_and_procedures",
"name": "Behandelen en procedures toepassen"
}
]
},
"xml": {
"name": "omahaInterventionCategories"
}
},
"dossier.omaha.list.InterventionTargetList": {
"type": "object",
"properties": {
"omahaInterventionTargets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.omaha.InterventionTarget"
},
"xml": {
"name": "omahaInterventionTarget"
}
}
},
"description": "InterventionTargetList model (no description)",
"example": {
"omahaInterventionTargets": [
{
"classificationId": "intervention.target.respiratory_therapy_care",
"name": "Ademhalingstherapie"
},
{
"classificationId": "intervention.target.anatomy_physiology",
"name": "Anatomie/fysiologie"
}
]
},
"xml": {
"name": "omahaInterventionTargets"
}
},
"dossier.omaha.list.ProblemList": {
"type": "object",
"properties": {
"omahaProblems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.omaha.Problem"
},
"xml": {
"name": "omahaProblem"
}
}
},
"description": "ProblemList model (no description)",
"example": {
"omahaProblems": [
{
"classificationId": "classification.problem.health.physical_activity",
"name": "Fysieke activiteit"
},
{
"classificationId": "classification.problem.health.substance_use",
"name": "Gebruik van verslavende middelen"
}
]
},
"xml": {
"name": "omahaProblems"
}
},
"payroll.PayableHoursAverage": {
"required": [
"value",
"perDay",
"employeeId"
],
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "The average number of payable hours for the requested period for the specified employee.",
"format": "float"
},
"perDay": {
"type": "boolean",
"description": "Indicating that the value is per day, or otherwise per week."
},
"dayOfWeek": {
"type": "integer",
"description": "ISO8601 day of week number, where Monday (1) is the first day of the week, and Sunday (7) is the last, idnicating which day of the week this {@code PayableHoursAverage} represents.\nOnly set when {@code perDay} is {@code true}",
"format": "int32"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"validFrom": {
"type": "string",
"format": "date"
},
"validTo": {
"type": "string",
"description": "the last date for which this average is valid, inclusive",
"format": "date"
}
},
"description": "PayableHoursAverage model (no description)",
"example": {
"value": 123.45,
"perDay": false,
"dayOfWeek": 4,
"employeeId": 1,
"validFrom": "2021-12-16",
"validTo": "2021-12-16"
},
"xml": {
"name": "payableHoursAverage"
}
},
"payroll.list.PayableHoursAverageList": {
"type": "object",
"properties": {
"payableHoursAverages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payroll.PayableHoursAverage"
}
}
},
"description": "PayableHoursAverageList model (no description)",
"example": {
"payableHoursAverages": [
{
"value": 123.45,
"perDay": true,
"dayOfWeek": 4,
"employeeId": 1,
"validFrom": "2021-12-16",
"validTo": "2021-12-16"
},
{
"value": 456.78,
"perDay": true,
"dayOfWeek": 5,
"employeeId": 1,
"validFrom": "2021-12-17",
"validTo": "2021-12-17"
}
]
}
},
"list.PersonalRelationTypeList": {
"type": "object",
"properties": {
"personalRelationTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PersonalRelationType"
}
}
},
"description": "PersonalRelationTypeList model (no description)",
"example": {
"personalRelationTypes": [
{
"id": 6,
"name": "Father",
"primary": true,
"exclusive": true,
"negative": false,
"active": true,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"id": 7,
"name": "Standard"
},
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00"
}
]
}
},
"PersonalRelationType": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/RelationType"
}
],
"description": "PersonalRelationType model (no description)",
"example": {
"id": 6,
"name": "Father",
"tag": "tag",
"primary": true,
"exclusive": true,
"relevant": true,
"negative": false,
"active": true,
"legal": true,
"vbmResponsible": false,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user",
"id": 7,
"name": "Standard"
},
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user"
}
},
"Practitioner": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Person"
}
],
"properties": {
"agbCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PractitionerAgbCode"
},
"description": "The personal AGB registration(s) for an employee",
"xml": {
"wrapped": true
}
},
"bigCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PractitionerBigCode"
},
"description": "The personal BIG registration(s) for an employee",
"xml": {
"wrapped": true
}
},
"skjCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PractitionerSkjCode"
},
"description": "The personal SKJ registration(s) for an employee"
},
"professions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PractitionerProfession"
},
"description": "The profession(s) for an employee.\nThe available professions to 'choose' from is a predefined list",
"xml": {
"wrapped": true
}
}
},
"description": "A practitioner is an employee with some extra attributes\nThose attributes are used to give extra meaning to an employee in a certain context.\n\nFor instance: In the mental healthcare domain,\nsome employees need and agbcode and/or a BIG registration to perform treatments on clients.",
"example": {
"id": 1,
"firstName": "Henny",
"name": "Bosbes",
"identificationNo": "12345",
"dateOfBirth": "1982-03-28",
"preferredNameType": "0",
"lastName": "Bosbes",
"birthName": "Bosbes",
"partnerName": "Knaak",
"initials": "H",
"prefix": "ir",
"birthNamePrefix": "de",
"partnerNamePrefix": "de",
"gender": "M",
"emailAddress": "hennybosbes@example.com",
"mobilePhone": "06123456789",
"freeField1": "Free field 1 description",
"freeField2": "Free field 2 description",
"freeField3": "Free field 3 description",
"freeField4": "Free field 4 description",
"updatedAt": "2017-05-09T00:00:00.000+02:00",
"createdAt": "2017-05-09T00:00:00.000+02:00",
"agbCodes": [
{
"employeeObjectId": 1,
"code": "12345678"
}
],
"bigCodes": [
{
"employeeObjectId": 1,
"code": "12345678"
}
],
"skjCodes": [],
"professions": [
{
"employeeObjectId": 1,
"code": "9992",
"name": "VK.OB.overig",
"info": "Overig",
"type": "COD878_GZ_BEROEPZORGVERLENER",
"beginDate": "2022-01-01"
}
]
},
"xml": {
"name": "practitioner"
}
},
"PractitionerSkjCode": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"employeeObjectId": {
"type": "integer",
"format": "int64"
},
"code": {
"type": "string",
"description": "This is a unique code, registred at skjeugd.nl"
},
"firstRegistrationDate": {
"type": "string",
"description": "The date at which the skj code is first registered",
"format": "date"
},
"beginDate": {
"type": "string",
"description": "The date at which the skj code is beginning",
"format": "date"
},
"endDate": {
"type": "string",
"description": "The date at which the skj code is ending. Null means no ending.",
"format": "date"
}
},
"description": "An SKJ registration is a registration at Kwaliteitsregister Jeugd",
"example": {
"id": 1,
"employeeObjectId": 1,
"code": "12345678",
"firstRegistrationDate": "2024-01-01",
"beginDate": "2024-01-01",
"endDate": "2024-12-31"
}
},
"list.PractitionerList": {
"type": "object",
"properties": {
"practitioners": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Practitioner"
},
"xml": {
"name": "practitioner"
}
}
},
"description": "PractitionerList model (no description)",
"example": {
"practitioners": [
{
"id": 1,
"firstName": "Henny",
"name": "Bosbes",
"identificationNo": "12345",
"dateOfBirth": "1982-03-28",
"preferredNameType": "0",
"lastName": "Bosbes",
"birthName": "Bosbes",
"partnerName": "Knaak",
"initials": "H",
"prefix": "ir",
"birthNamePrefix": "de",
"partnerNamePrefix": "de",
"gender": "M",
"emailAddress": "hennybosbes@example.com",
"mobilePhone": "06123456789",
"updatedAt": "2017-05-09T00:00:00.000+02:00",
"createdAt": "2017-05-09T00:00:00.000+02:00",
"agbCodes": [
{
"employeeObjectId": 1,
"code": "12345678"
}
],
"bigCodes": [
{
"employeeObjectId": 1,
"code": "12345678"
}
],
"professions": [
{
"employeeObjectId": 1,
"code": "9992",
"name": "VK.OB.overig",
"info": "Overig",
"type": "COD878_GZ_BEROEPZORGVERLENER",
"beginDate": "2022-01-01"
}
]
}
]
},
"xml": {
"name": "practitioners"
}
},
"list.ReferralList": {
"type": "object",
"properties": {
"referrals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Referral"
}
}
},
"description": "ReferralList model (no description)",
"example": {
"referrals": [
{
"id": 1,
"clientId": 2,
"documentId": 1,
"date": "2017-01-01",
"referrerType": "01",
"referrerCategory": "02",
"agbCode": "12345678",
"referrer": "naam",
"specialism": "0100",
"institution": 2
}
]
}
},
"list.ReferrerCategoryList": {
"type": "object",
"properties": {
"referrerCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferrerCategory"
},
"xml": {
"name": "referrerCategory"
}
}
},
"description": "ReferrerCategoryList model (no description)",
"example": {
"referrerCategories": [
{
"code": "01",
"description": "GGZ",
"requiresDocument": true,
"referrerTypes": [
{
"code": "01",
"description": "Verwezen patiënt vanuit de eerste lijn"
},
{
"code": "02",
"description": "Verwezen patiënt vanuit een (andere) GGZ-instelling, instelling MSZ of GGZ-praktijk"
},
{
"code": "03",
"description": "Verwezen patiënt vanuit de crisiszorg of spoedeisende hulp"
},
{
"code": "04",
"description": "Eigen patiënt"
},
{
"code": "05",
"description": "Verwezen patiënt, maar verwijzer heeft geen AGB-code"
},
{
"code": "06",
"description": "Zelfverwijzer"
},
{
"code": "07",
"description": "Bemoeizorg"
},
{
"code": "08",
"description": "Verwijzing langdurige GGZ"
}
]
},
{
"code": "02",
"description": "Jeugd-GGZ",
"requiresDocument": true,
"referrerTypes": [
{
"code": "01",
"description": "Gemeente"
},
{
"code": "02",
"description": "Huisarts"
},
{
"code": "03",
"description": "Jeugdarts"
},
{
"code": "04",
"description": "Gecertificeerde instelling"
},
{
"code": "05",
"description": "Medisch specialist"
},
{
"code": "06",
"description": "Zelfverwijzer / geen verwijzer"
},
{
"code": "07",
"description": "Onbekend"
},
{
"code": "08",
"description": "Rechter, Raad voor de Kinderbescherming of Officier van Justitie"
}
]
},
{
"code": "03",
"description": "DBC-OZP",
"requiresDocument": true,
"referrerTypes": [
{
"code": "01",
"description": "Zelfverwijzer SEH"
},
{
"code": "02",
"description": "Zelfverwijzer niet-SEH"
},
{
"code": "03",
"description": "Verwezen patiënt SEH"
},
{
"code": "04",
"description": "Verwezen patiënt niet-SEH vanuit eerstelijn"
},
{
"code": "05",
"description": "Verwezen patiënt niet-SEH vanuit ander specialisme binnen dezelfde instelling"
},
{
"code": "06",
"description": "Verwezen patiënt niet-SEH vanuit andere instelling"
},
{
"code": "07",
"description": "Eigen patiënt"
},
{
"code": "08",
"description": "Verwezen patiënt niet-SEH vanuit eerstelijn, maar verwijzer heeft geen AGB-code"
},
{
"code": "09",
"description": "Patiënt welke gebruik maakt van directe toegang tot paramedische hulp"
}
]
},
{
"code": "04",
"description": "ZVW-GZSP",
"requiresDocument": false,
"referrerTypes": []
},
{
"code": "05",
"description": "ELV",
"requiresDocument": false,
"referrerTypes": []
},
{
"code": "06",
"description": "GGZ-Eigen-Patient",
"requiresDocument": false,
"referrerTypes": [
{
"code": "04",
"description": "Eigen patiënt"
}
]
}
]
},
"xml": {
"name": "referrerCategories"
}
},
"ReferrerCategory": {
"type": "object",
"properties": {
"code": {
"type": "string",
"x-cupido-id": true
},
"description": {
"type": "string"
},
"requiresDocument": {
"type": "boolean",
"default": false
},
"referrerTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReferrerType"
},
"xml": {
"wrapped": true
}
}
},
"description": "ReferrerCategory model (no description)",
"example": {
"code": "01",
"description": "GGZ",
"requiresDocument": true,
"referrerTypes": [
{
"code": "01",
"description": "Verwezen patiënt vanuit de eerste lijn"
},
{
"code": "02",
"description": "Verwezen patiënt vanuit een (andere) GGZ-instelling, instelling MSZ of GGZ-praktijk"
},
{
"code": "03",
"description": "Verwezen patiënt vanuit de crisiszorg of spoedeisende hulp"
},
{
"code": "04",
"description": "Eigen patiënt"
},
{
"code": "05",
"description": "Verwezen patiënt, maar verwijzer heeft geen AGB-code"
},
{
"code": "06",
"description": "Zelfverwijzer"
},
{
"code": "07",
"description": "Bemoeizorg"
},
{
"code": "08",
"description": "Verwijzing langdurige GGZ"
}
]
},
"xml": {
"name": "referrerCategory"
}
},
"ReferrerType": {
"type": "object",
"properties": {
"code": {
"type": "string",
"x-cupido-id": true
},
"description": {
"type": "string"
}
},
"description": "ReferrerType model (no description)",
"example": {
"code": "01",
"description": "Verwezen patiënt vanuit de eerste lijn"
},
"xml": {
"name": "referrerType"
}
},
"Skn": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"clientObjectId": {
"type": "integer",
"format": "int64"
},
"skn": {
"type": "string"
}
},
"description": "Skn model (no description)",
"example": {
"id": 1,
"clientObjectId": 12344,
"skn": "123456789012345"
},
"xml": {
"name": "skn"
}
},
"status.ApplicationStatus": {
"type": "object",
"properties": {
"anonymizeType": {
"allOf": [
{
"$ref": "#/components/schemas/status.AnonymizeType"
}
],
"description": "the {@link com.nedap.healthcare.domain.status.AnonymizeType} to this application status"
}
},
"description": "ApplicationStatus model (no description)",
"example": {
"anonymizeType": "fully_anonymized"
},
"xml": {
"name": "applicationStatus"
}
},
"status.AnonymizeType": {
"type": "string",
"oneOf": [
{
"title": "NOT_ANONYMIZED",
"enum": [
"not_anonymized"
]
},
{
"title": "PARTLY_ANONYMIZED",
"enum": [
"partly_anonymized"
]
},
{
"title": "FULLY_ANONYMIZED",
"enum": [
"fully_anonymized"
]
}
],
"description": "the {@link com.nedap.healthcare.domain.status.AnonymizeType} to this application status",
"example": "not_anonymized"
},
"survey.list.SurveyResultList": {
"type": "object",
"properties": {
"surveyResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/survey.SurveyResult"
},
"xml": {
"name": "surveyResult"
}
}
},
"description": "SurveyResultList model (no description)",
"example": {
"surveyResults": [
{
"id": 111,
"surveyObjectId": 555,
"clientObjectId": 333,
"employeeObjectId": 444,
"version": 1,
"completedAt": "2012-08-02T11:48:46.836+02:00",
"status": "New",
"linkedToActiveCarePlan": true,
"isAnyCarePlanUsingThisResult": true
}
]
},
"xml": {
"name": "surveyResults"
}
},
"survey.list.AnswerDefinitionGroupList": {
"type": "object",
"properties": {
"answerDefinitionGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/survey.AnswerDefinitionGroup"
},
"xml": {
"name": "answerDefinitionGroup"
}
}
},
"description": "AnswerDefinitionGroupList model (no description)",
"example": {
"answerDefinitionGroups": [
{
"id": 11,
"description": "ADG test",
"readOnly": false
}
]
},
"xml": {
"name": "answerDefinitionGroups"
}
},
"survey.list.SurveyList": {
"type": "object",
"properties": {
"surveys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/survey.Survey"
},
"xml": {
"name": "survey"
}
}
},
"description": "SurveyList model (no description)",
"example": {
"surveys": [
{
"createdAt": "2012-08-02T11:48:46.836+02:00",
"createdBy": "jan-willem mooij",
"id": 11,
"description": "vragenlijst omschr",
"title": "intake",
"active": true,
"useWorkflow": true,
"useStrictEditAuthorization": true,
"copyingAllowed": true,
"signalNonClosed": true,
"signalTitle": "let op niet afgehandeld"
}
]
},
"xml": {
"name": "surveys"
}
},
"transport.ClientTransport": {
"required": [
"clientId",
"date",
"individualTransport",
"hasWeelchairAssignment",
"wlz",
"hourTypes"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"clientId": {
"type": "integer",
"description": "Id of {@link com.nedap.healthcare.domain.Client} for which these details are valid",
"format": "int64"
},
"date": {
"type": "string",
"description": "Date for which the transport details for the given client is retrieved",
"format": "date"
},
"individualTransport": {
"type": "boolean",
"description": "Is individual transport needed for this client at the given date",
"default": false
},
"hasWeelchairAssignment": {
"type": "boolean",
"description": "Has this client a wheelchair assigned at the given date",
"default": false
},
"wlz": {
"type": "boolean",
"description": "Receives this client WLZ care at the given date",
"default": false
},
"contractedTransport": {
"type": "boolean",
"description": "Indicates whether the client uses contracted transport",
"default": false
},
"hourTypes": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/HourType"
},
"description": "Set of all {@link HourType} instances that can be used for this client",
"xml": {
"wrapped": true
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"description": "ClientTransport the transport details for a client, financed in the WLZ, on a certain date",
"example": {
"id": 1,
"clientId": 3,
"date": "2018-01-01",
"individualTransport": false,
"hasWeelchairAssignment": false,
"wlz": false,
"contractedTransport": true,
"hourTypes": [
{
"id": 1,
"description": "Vervoer dagbesteding ghz - cat 1",
"identificationNo": "881",
"activityGroupObjectId": 1,
"active": true,
"payrolling": true,
"direct": true,
"systemDefined": true,
"travelTime": true,
"activityType": "Payrolling",
"groupCare": true,
"travelCalculationDisabled": false
},
{
"id": 2,
"description": "Vervoer dagbesteding ghz - cat 2",
"identificationNo": "882",
"activityGroupObjectId": 1,
"active": true,
"payrolling": true,
"direct": true,
"systemDefined": true,
"travelTime": true,
"activityType": "Payrolling",
"groupCare": true,
"travelCalculationDisabled": false
}
],
"createdAt": "2018-01-01T01:02:03.000+01:00",
"updatedAt": "2018-01-01T01:02:03.000+01:00"
},
"xml": {
"name": "clientTransport"
}
},
"TreatmentLocation": {
"required": [
"id",
"isInstitution",
"locationObjectId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"isInstitution": {
"type": "boolean"
},
"locationObjectId": {
"type": "integer",
"format": "int64"
}
},
"description": "TreatmentLocation model (no description)",
"example": {
"id": 1,
"isInstitution": true,
"locationObjectId": 1
},
"xml": {
"name": "treatmentLocation"
}
},
"UserStatus": {
"type": "object",
"properties": {
"userLoginAllowed": {
"type": "boolean",
"description": "true if the user is allowed to log in"
},
"loginDescription": {
"type": "string",
"description": "describes why the user can (not) log in"
},
"type": {
"type": "string",
"description": "describes the state as enum name\n- APPLICATION_LOCK_DOWN\n- CONTRACT_REQUIRED_USER_NEEDS_NO_CONTRACT\n- CONTRACT_REQUIRED_USER_HAS_ACTIVE_CONTRACT\n- CONTRACT_REQUIRED_USER_HAS_ACTIVE_CONTRACT_IN_NEAR_FUTURE\n- CONTRACT_REQUIRED_USER_HAS_NO_ACTIVE_CONTRACT_IN_NEAR_FUTURE\n- CONTRACT_REQUIRED_USER_HAS_NO_CONTRACTS\n- CONTRACT_NOT_REQUIRED_USER_HAS_CONTRACT_WITH_NO_ENDDATE\n- CONTRACT_NOT_REQUIRED_USER_HAS_NO_CONTRACTS\n- CONTRACT_NOT_REQUIRED_USER_HAS_ACTIVE_CONTRACT\n- CONTRACT_NOT_REQUIRED_USER_HAS_NO_ACTIVE_CONTRACT"
}
},
"description": "UserStatus model (no description)",
"example": {
"userLoginAllowed": true,
"loginDescription": "User can log in",
"type": "CONTRACT_REQUIRED_USER_NEEDS_NO_CONTRACT"
}
},
"list.UserList": {
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
},
"xml": {
"name": "user"
}
}
},
"description": "UserList model (no description)",
"example": {
"users": [
{
"id": 100,
"employeeObjectId": 100,
"userName": "rick.devries",
"ssoEnabled": true,
"ssoId": "user@domain.com",
"ssoProviderId": "12345",
"contractRequiredAtLogin": true
}
]
},
"xml": {
"name": "users"
}
},
"list.WeeksheetProfileList": {
"type": "object",
"properties": {
"weeksheetProfiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WeeksheetProfile"
}
}
},
"description": "WeeksheetprofileList model (no description)",
"example": {
"weeksheetProfiles": [
{
"id": 10,
"description": "Klinisch Verpleegkundige",
"registrationActivities": true,
"registrationWithDossierReport": true,
"registrationIndirectActivitiesInFutureAllowed": true,
"allowCreateBeforeVerifyDate": false,
"timeWindowDate": "2012-08-02T13:48:46.836+02:00"
}
]
}
},
"payroll.list.WorkHoursBalanceList": {
"type": "object",
"properties": {
"workHoursBalances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payroll.WorkHoursBalance"
}
}
},
"description": "WorkHoursBalanceList model (no description)",
"example": {
"workHoursBalances": [
{
"employeeId": 4,
"accountTypeId": 3,
"unverifiedBalance": 2,
"verifiedBalance": 1,
"date": "2016-01-02",
"verifiedUntil": "2016-01-15"
},
{
"employeeId": 1,
"accountTypeId": 2,
"unverifiedBalance": 3,
"verifiedBalance": 4,
"date": "2016-02-15",
"verifiedUntil": "2016-02-27"
}
]
}
},
"payroll.WorkHoursBalance": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"accountTypeId": {
"type": "integer",
"format": "int64"
},
"unverifiedBalance": {
"type": "integer",
"format": "int64"
},
"verifiedBalance": {
"type": "integer",
"format": "int64"
},
"date": {
"type": "string",
"format": "date"
},
"verifiedUntil": {
"type": "string",
"format": "date"
}
},
"description": "WorkHoursBalance model (no description)",
"example": {
"employeeId": 4,
"accountTypeId": 3,
"unverifiedBalance": 2,
"verifiedBalance": 1,
"date": "2016-01-02",
"verifiedUntil": "2016-01-15"
}
},
"payroll.WorkLoad": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"contractMinutes": {
"type": "integer",
"description": "The total amount of contracted minutes in the specified year",
"format": "int64"
},
"payedMinutes": {
"type": "integer",
"description": "The total amount of payable minutes in the specified year",
"format": "int64"
},
"year": {
"type": "integer",
"description": "The year for which the results apply.\nIn case of the current year, results are given until last Sunday",
"format": "int32"
}
},
"description": "WorkLoad model (no description)",
"example": {
"employeeId": 1,
"contractMinutes": 100,
"payedMinutes": 120,
"year": 2019
}
},
"worksheet.Worksheet": {
"required": [
"content"
],
"type": "object",
"properties": {
"content": {
"type": "string",
"description": "The contents of the generated worksheet in base64 encoded pdf format.",
"format": "binary"
}
},
"description": "Worksheet model (no description)",
"example": {
"content": "U2VuZCByZWluZm9yY2VtZW50cw=="
}
},
"zpm.list.ZpmGbggzProfielList": {
"type": "object",
"properties": {
"zpmGbggzProfielen": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/zpm.ZpmGbggzProfiel"
}
],
"xml": {
"name": "zpmGbggzProfiel"
}
},
"xml": {
"name": "zpmGbggzProfiel"
}
}
},
"description": "ZpmGbggzProfielList model (no description)",
"example": {
"zpmGbggzProfielen": [
{
"updatedAt": "2021-08-05T14:23:23.000+02:00",
"createdAt": "2021-08-05T14:23:23.000+02:00",
"createdBy": "user",
"id": 1,
"code": "GBG01",
"name": "Onvolledig behandeltraject",
"beginDate": "2021-01-01",
"endDate": "2022-12-31"
}
]
},
"xml": {
"name": "zpmGbggzProfielen"
}
},
"zpm.ZpmGbggzProfiel": {
"required": [
"code",
"name",
"beginDate"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"description": "Object identifier.",
"format": "int64",
"x-cupido-id": true
},
"code": {
"type": "string",
"description": "Profiel code."
},
"name": {
"type": "string",
"description": "Profiel name."
},
"beginDate": {
"type": "string",
"description": "Validity begin date.",
"format": "date"
},
"endDate": {
"type": "string",
"description": "Validity end date.",
"format": "date"
}
},
"description": "Generalistische basis ggz (gb-ggz) patientprofiel.",
"example": {
"updatedAt": "2021-08-05T14:23:23.000+02:00",
"createdAt": "2021-08-05T14:23:23.000+02:00",
"createdBy": "user",
"id": 1,
"code": "GBG01",
"name": "Onvolledig behandeltraject",
"beginDate": "2021-01-01",
"endDate": "2022-12-31"
},
"xml": {
"name": "zpmGbggzProfiel"
}
},
"zpm.list.ZpmSettingList": {
"type": "object",
"properties": {
"zpmSettings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zpm.ZpmSetting"
},
"xml": {
"name": "zpmSetting"
}
}
},
"description": "ZpmSettingList model (no description)",
"example": {
"zpmSettings": [
{
"updatedAt": "2021-08-09T16:17:11.000+02:00",
"createdAt": "2021-06-28T13:21:32.000+02:00",
"id": 1,
"code": "S01",
"legalBegin": "2021-01-01",
"activeBegin": "2022-01-01",
"activeEnd": "2022-12-31",
"name": "Ambulant - kwaliteitsstatuut sectie II"
}
]
},
"xml": {
"name": "zpmSettings"
}
},
"zpm.ZpmSetting": {
"required": [
"code",
"legalBegin",
"activeBegin",
"name"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"description": "Object identifier.",
"format": "int64",
"x-cupido-id": true
},
"code": {
"type": "string",
"description": "Setting code."
},
"legalBegin": {
"type": "string",
"description": "Legal begin date.",
"format": "date"
},
"legalEnd": {
"type": "string",
"description": "Legal end date.",
"format": "date"
},
"activeBegin": {
"type": "string",
"description": "Date that this setting becomes active for the tenant.",
"format": "date"
},
"activeEnd": {
"type": "string",
"description": "Date that this setting stops being active for this tenant.",
"format": "date"
},
"name": {
"type": "string",
"description": "Setting name."
}
},
"description": "Setting (context, environment) in which care is being delivered.",
"example": {
"updatedAt": "2021-08-09T16:17:11.000+02:00",
"createdAt": "2021-06-28T13:21:32.000+02:00",
"createdBy": "user",
"id": 1,
"code": "S01",
"legalBegin": "2021-01-01",
"legalEnd": "2022-12-31",
"activeBegin": "2022-01-01",
"activeEnd": "2022-12-31",
"name": "Ambulant - kwaliteitsstatuut sectie II"
},
"xml": {
"name": "zpmSetting"
}
},
"zpm.list.ZpmZorglabelList": {
"type": "object",
"properties": {
"zpmZorglabels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zpm.ZpmZorglabel"
},
"xml": {
"name": "zpmZorglabel"
}
}
},
"description": "ZpmZorglabelList model (no description)",
"example": {
"zpmZorglabels": [
{
"updatedAt": "2021-08-09T10:52:25.000+02:00",
"createdAt": "2021-08-09T10:52:25.000+02:00",
"id": 4,
"code": "N04",
"name": "Toeslag inzet tolk",
"valueEditable": true,
"allowedValues": "Talentolk;Gebarentolk",
"branchIndication": 0,
"beginDate": "2022-01-01"
}
]
},
"xml": {
"name": "zpmZorglabels"
}
},
"zpm.ZpmZorglabel": {
"required": [
"code",
"name",
"valueEditable",
"branchIndication",
"beginDate"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"description": "Object identifier.",
"format": "int64",
"x-cupido-id": true
},
"code": {
"type": "string",
"description": "Zorglabel code."
},
"name": {
"type": "string",
"description": "Zorglabel name."
},
"valueEditable": {
"type": "boolean",
"description": "Indicates if a variable value can be specified with the assigned\nzorglabel.",
"default": false
},
"allowedValues": {
"type": "string",
"description": "Contains a semicolon-separated list of values that may be specified\nwith the assigned zorglabel."
},
"branchIndication": {
"type": "integer",
"description": "Indicates if the zorglabel can be used for GGZ, FZ or both.\n\nPossible values:\n\n
",
"format": "int32"
},
"beginDate": {
"type": "string",
"description": "Validity begin date.",
"format": "date"
},
"endDate": {
"type": "string",
"description": "Validity end date.",
"format": "date"
}
},
"description": "Indicates extra information linked to activities.",
"example": {
"updatedAt": "2021-08-09T10:52:25.000+02:00",
"createdAt": "2021-08-09T10:52:25.000+02:00",
"createdBy": "user",
"id": 4,
"code": "N04",
"name": "Toeslag inzet tolk",
"valueEditable": true,
"allowedValues": "Talentolk;Gebarentolk",
"branchIndication": 0,
"beginDate": "2022-01-01",
"endDate": "2022-12-31"
},
"xml": {
"name": "zpmZorglabel"
}
},
"agenda.list.RegistrationStatusList": {
"title": "RegistrationStatusList",
"type": "object",
"properties": {
"registrationStatuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/agenda.RegistrationStatus"
}
}
},
"description": "RegistrationStatusList model (no description)",
"example": {
"registrationStatuses": [
{
"undeclared": 1,
"failed": 1,
"type": "employee",
"typeId": 1
}
]
}
},
"agenda.RegistrationStatus": {
"title": "RegistrationStatus",
"type": "object",
"properties": {
"undeclared": {
"type": "integer",
"description": "Amount of undeclared registrations",
"format": "int32"
},
"failed": {
"type": "integer",
"description": "Amount of failed registrations",
"format": "int32"
},
"type": {
"type": "string",
"description": "Type\n\nPossible values:\nclient\nemployee\nteam\nlocation\n
"
},
"typeId": {
"type": "integer",
"description": "Type ID",
"format": "int32"
}
},
"description": "Ons Agenda - Registrations status domain model used by Cupido system.",
"example": {
"undeclared": 1,
"failed": 1,
"type": "employee",
"typeId": 1
}
},
"agenda.ClientAbsenceOccurrence": {
"title": "ClientAbsenceOccurrence",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of this object",
"nullable": true,
"x-cupido-id": true
},
"startDate": {
"type": "string",
"description": "The start date of this occurrence",
"format": "date",
"nullable": true
},
"endDate": {
"type": "string",
"description": "The end date of this occurrence",
"format": "date",
"nullable": true
},
"startTime": {
"type": "string",
"description": "The start time of this occurrence",
"format": "time",
"nullable": true
},
"endTime": {
"type": "string",
"description": "The end date of this occurrence",
"format": "time",
"nullable": true
},
"recurrenceType": {
"allOf": [
{
"$ref": "#/components/schemas/RecurrenceType"
}
],
"description": "The recurrence type of this occurrence; can be \"single\", \"daily\", \"weekly\", \"monthly_on_day\", \"monthly_on_week\"\nor \"yearly\""
},
"cycleInterval": {
"type": "integer",
"description": "The interval of the recurrences",
"format": "int32",
"nullable": true
},
"validFrom": {
"type": "string",
"description": "The date on which the series this occurrence belongs to starts",
"format": "date",
"nullable": true
},
"validTo": {
"type": "string",
"description": "The date on which the series this occurrence belongs to ends",
"format": "date",
"nullable": true
},
"timelineId": {
"type": "integer",
"description": "The id of the timeline this series belongs to",
"format": "int32",
"nullable": true
},
"note": {
"type": "string",
"description": "A note about the absence; can be any string of text put in by the employee.",
"nullable": true
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/agenda.ClientAbsenceStatus"
}
],
"description": "A status about the absence; can be created/updated/deleted."
},
"monday": {
"type": "boolean",
"description": "Boolean that defines whether the absence recurs on Mondays",
"nullable": true
},
"tuesday": {
"type": "boolean",
"description": "Boolean that defines whether the absence recurs on Tuesdays",
"nullable": true
},
"wednesday": {
"type": "boolean",
"description": "Boolean that defines whether the absence recurs on Wednesdays",
"nullable": true
},
"thursday": {
"type": "boolean",
"description": "Boolean that defines whether the absence recurs on Thursdays",
"nullable": true
},
"friday": {
"type": "boolean",
"description": "Boolean that defines whether the absence recurs on Fridays",
"nullable": true
},
"saturday": {
"type": "boolean",
"description": "Boolean that defines whether the absence recurs on Saturdays",
"nullable": true
},
"sunday": {
"type": "boolean",
"description": "Boolean that defines whether the absence recurs on Sundays",
"nullable": true
},
"clientAbsenceReasonId": {
"type": "integer",
"description": "The id of the reason of absence",
"format": "int32",
"nullable": true
},
"clientId": {
"type": "integer",
"description": "The id of the client",
"format": "int32",
"nullable": true
}
},
"description": "Client absence occurrence domain in Agenda.",
"example": {
"id": "07e4618393",
"startDate": "2020-06-24",
"endDate": "2020-07-24",
"startTime": "08:10:00.000",
"endTime": "08:20:00.000",
"recurrenceType": "single",
"cycleInterval": 1,
"validFrom": "2020-06-24",
"validTo": "2020-12-24",
"timelineId": 42,
"note": "Omdat het kan",
"status": "CREATED",
"monday": true,
"tuesday": false,
"wednesday": true,
"thursday": true,
"friday": false,
"saturday": true,
"sunday": false,
"clientAbsenceReasonId": 1,
"clientId": 142
}
},
"agenda.ClientAbsenceStatus": {
"enum": [
"CREATED",
"UPDATED",
"DELETED"
],
"type": "string",
"description": "A status about the absence; can be created/updated/deleted.",
"nullable": true,
"example": "CREATED"
},
"agenda.list.ClientAbsenceOccurrenceList": {
"title": "ClientAbsenceOccurrenceList",
"type": "object",
"properties": {
"clientAbsenceOccurrences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/agenda.ClientAbsenceOccurrence"
}
}
},
"description": "ClientAbsenceOccurrenceList model (no description)",
"example": {
"clientAbsenceOccurrences": [
{
"id": "07e4618393",
"startDate": "2020-06-24",
"endDate": "2020-07-24",
"startTime": "08:10:00.000",
"endTime": "08:20:00.000",
"recurrenceType": "single",
"cycleInterval": 1,
"validFrom": "2020-06-24",
"validTo": "2020-12-24",
"timelineId": 42,
"note": "Omdat het kan",
"status": "CREATED",
"monday": true,
"tuesday": false,
"wednesday": true,
"thursday": true,
"friday": false,
"saturday": true,
"sunday": false,
"clientAbsenceReasonId": 1,
"clientId": 142
},
{
"id": "07e4618394",
"startDate": "2020-06-25",
"endDate": "2020-07-25",
"startTime": "08:10:00.000",
"endTime": "08:20:00.000",
"recurrenceType": "single",
"cycleInterval": 1,
"validFrom": "2020-06-25",
"validTo": "2020-12-25",
"timelineId": 42,
"note": "Omdat het kan 2",
"status": "CREATED",
"monday": true,
"tuesday": false,
"wednesday": true,
"thursday": true,
"friday": false,
"saturday": true,
"sunday": false,
"clientAbsenceReasonId": 1,
"clientId": 142
}
]
}
},
"agenda.list.AgendaOccurrenceList": {
"title": "EventOccurrenceList",
"type": "object",
"properties": {
"agendaOccurrences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/agenda.AgendaOccurrence"
}
}
},
"description": "AgendaOccurrenceList model (no description)",
"example": {
"agendaOccurrences": [
{
"id": "2@2012-08-02",
"occurrenceDate": "2012-08-02",
"uuid": "abca58ed-0138-4aec-87c6-5d391e98161b",
"name": "fysio",
"comment": "no comment",
"validFrom": "2012-08-02",
"validTo": "2012-08-03",
"startTime": "08:10:00.000",
"endTime": "08:20:00.000",
"startsAt": "2022-08-02T08:10:00.000+02:00",
"endsAt": "2022-08-02T08:20:00.000+02:00",
"duration": 0,
"recurrenceType": "single",
"cycleInterval": 1
}
]
}
},
"agenda.ReservationOccurrenceResponse": {
"title": "ReservationOccurrenceResponse",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/agenda.ReservationOccurrence"
}
}
},
"description": "Response wrapping a list of reservation occurrences.",
"example": {
"data": [
{
"occurrenceId": "07ea6051",
"startsAt": "2025-06-05T08:10:00.000+02:00",
"endsAt": "2025-06-05T08:20:00.000+02:00",
"labels": [
{
"id": 1,
"name": "Telefonisch"
}
]
}
]
}
},
"agenda.ReservationOccurrence": {
"title": "ReservationOccurrence",
"type": "object",
"properties": {
"occurrenceId": {
"type": "string",
"description": "Id of the occurrence"
},
"startsAt": {
"type": "string",
"description": "Start moment of reservation. Must be on same day as endsAt.",
"format": "date-time"
},
"endsAt": {
"type": "string",
"description": "End moment (exclusive) of reservation. Must be on same day as startsAt.",
"format": "date-time"
},
"labels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/agenda.Label"
},
"description": "List of labels assigned to this reservation"
}
},
"description": "",
"example": {
"occurrenceId": "07ea6051",
"startsAt": "2025-06-05T08:10:00.000+02:00",
"endsAt": "2025-06-05T08:20:00.000+02:00",
"labels": [
{
"id": 1,
"name": "Telefonisch"
}
]
}
},
"agenda.list.LabelList": {
"title": "LabelList",
"type": "object",
"properties": {
"labels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/agenda.Label"
}
}
},
"description": "LabelList model (no description)",
"example": {
"labels": [
{
"id": 1,
"name": "Telefonisch"
}
]
}
},
"herald.AnnouncementCount": {
"required": [
"count"
],
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "The number of unread announcements",
"format": "int32"
}
},
"description": "AnnouncementCount model (no description)",
"example": {
"count": 10
}
},
"toezicht.list.AuditList": {
"required": [
"audits"
],
"type": "object",
"properties": {
"audits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/toezicht.Audit"
}
}
},
"description": "List of exported audits.",
"example": {
"audits": [
{
"activeIdentity": {
"employeeId": 10,
"userName": "administrator"
},
"createdAt": "2024-01-01T01:35:19.498+01:00",
"deploymentType": "PlanningDeployment",
"description": "Sync Notes.",
"failed": false,
"name": "SyncClient::NotesSyncJob",
"references": {
"clients": [
10,
12
]
},
"title": "Overnemen cliëntnotities uit Ons Dossier"
}
]
}
},
"toezicht.Audit": {
"required": [
"createdAt"
],
"type": "object",
"properties": {
"activeIdentity": {
"$ref": "#/components/schemas/toezicht.AuditIdentity"
},
"createdAt": {
"type": "string"
},
"deploymentType": {
"type": "string"
},
"description": {
"type": "string"
},
"failed": {
"type": "boolean"
},
"name": {
"type": "string"
},
"references": {
"$ref": "#/components/schemas/toezicht.AuditReferences"
},
"title": {
"type": "string"
}
},
"description": "A single exported audit",
"example": {
"activeIdentity": {
"employeeId": 10,
"userName": "administrator"
},
"createdAt": "2024-01-01T01:35:19.498+01:00",
"deploymentType": "PlanningDeployment",
"description": "Sync Notes.",
"failed": false,
"name": "SyncClient::NotesSyncJob",
"references": {
"clients": [
10,
12
]
},
"title": "Overnemen cliëntnotities uit Ons Dossier"
}
},
"toezicht.AuditIdentity": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"description": "Some audits store the employee_id captured when the audit event was created. For audits without a stored employee_id, this value is resolved from other ONS data sources at the moment of export. It may not be available in all cases. If the user is removed from Administration, the employee_id may no longer be available for audits of some types."
},
"userName": {
"type": "string"
}
},
"description": "Identity linked to an exported Audit",
"example": {
"employeeId": 10,
"userName": "administrator"
}
},
"toezicht.AuditReferences": {
"type": "object",
"properties": {
"clients": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"description": "References linked to an exported Audit",
"example": {
"clients": [
10,
12
]
}
},
"authorization.provisioning.list.RoleList": {
"type": "object",
"properties": {
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/authorization.provisioning.Role"
}
}
},
"description": "RoleList model (no description)",
"example": {
"roles": [
{
"uuid": "ea9e0f20-2232-4087-9a43-8f894e79b6f0",
"name": "Rol naam"
}
]
}
},
"authorization.provisioning.Role": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"x-cupido-id": true
},
"name": {
"type": "string"
}
},
"description": "Role model (no description)",
"example": {
"uuid": "ea9e0f20-2232-4087-9a43-8f894e79b6f0",
"name": "Rol naam"
}
},
"kamino.Error": {
"required": [
"error",
"message"
],
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Machine-parseable error code.\n\nAt least the following errors can be returned:\n* `401 Unauthorized: token_missing`\n* `401 Unauthorized: token_unauthorized`\n* `401 Unauthorized: token_expired`\n* `401 Unauthorized: token_missing`\n* `403 Forbidden: employee_without_team`\n* `404 Not Found: not_found`\n* `422 Unprocessable Entity: validation_failed`\n* `500 Internal Server Error: internal_server_error`\n* `503 Service Unavailable: service_unavailable`\n",
"example": "validation_failed"
},
"message": {
"type": "string",
"description": "Human readable message, giving more details about the error. These messages might change and may _never_ be shown to users.",
"example": "Validation failed: Body can't be blank"
},
"params": {
"type": "array",
"items": {
"$ref": "#/components/schemas/kamino.ErrorParam"
},
"description": "Any params attached to this error. For instance an array of fields which failed validation.",
"example": [
{
"code": "missing_field",
"field": "body",
"resource": "Message"
}
]
}
},
"description": "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.",
"example": {
"error": "validation_failed",
"message": "Validation failed: Body can't be blank",
"params": [
{
"code": "missing_field",
"field": "body",
"resource": "Message"
}
]
}
},
"kamino.ErrorParam": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Machine-parseable error code.",
"example": "missing_field"
},
"field": {
"type": "string",
"description": "The field in which the error occurred.",
"example": "body"
},
"resource": {
"type": "string",
"description": "The resource on which the error occurred.",
"example": "Message"
}
},
"description": "Kamino ErrorParam model (no description)",
"example": {
"code": "missing_field",
"field": "body",
"resource": "Message"
}
},
"caretech.list.OrderList": {
"type": "object",
"properties": {
"orders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/caretech.Order"
}
}
},
"description": "OrderList model (no description)",
"example": {
"orders": [
{
"id": 1,
"uuid": "46ff9856-a645-4764-be01-9c64668bf93b",
"createdAt": "2025-01-01T12:00:00.000+01:00",
"updatedAt": "2025-01-01T12:00:00.000+01:00",
"productId": 1,
"removed": false,
"clientName": "Dhr. P. Atient",
"clientObjectId": 1,
"deliveryAddress": {
"city": "Groenlo",
"country": "NL",
"homeNumber": 3,
"note": "graag afleveren bij de buren op nr. 5",
"street": "Industrieweg",
"type": "CLIENT_HOME",
"zipcode": "7141DD"
},
"requester": {
"emailAddress": "teamoost@groenlozorg.nl",
"employeeObjectId": 1,
"name": "M. Edewerker",
"phoneNumber": "0612345678",
"teamName": "Groenlo Oost",
"teamObjectId": 1
},
"status": "ACCEPTED"
}
]
}
},
"caretech.Order": {
"required": [
"clientName",
"clientObjectId",
"deliveryAddress",
"productId",
"removed",
"requester",
"status"
],
"type": "object",
"properties": {
"acceptedAt": {
"type": "string",
"format": "date-time"
},
"clientName": {
"type": "string"
},
"clientObjectId": {
"type": "integer",
"format": "int64"
},
"completedAt": {
"type": "string",
"format": "date-time"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"declinedAt": {
"type": "string",
"format": "date-time"
},
"deliveryAddress": {
"$ref": "#/components/schemas/caretech.DeliveryAddress"
},
"deviceIdentificationNumber": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"orderNumber": {
"type": "string"
},
"productId": {
"type": "integer",
"format": "int64"
},
"removed": {
"type": "boolean"
},
"requester": {
"$ref": "#/components/schemas/caretech.Requester"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/caretech.OrderStatus"
}
],
"description": "The status of an order, can be OPEN, DECLINED, ACCEPTED or COMPLETED"
},
"supplierNote": {
"type": "string"
},
"trackingUrl": {
"type": "string"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"uuid": {
"type": "string",
"format": "uuid"
}
},
"description": "Care technology order",
"example": {
"id": 1,
"uuid": "46ff9856-a645-4764-be01-9c64668bf93b",
"createdAt": "2025-01-01T12:00:00.000+01:00",
"updatedAt": "2025-01-01T12:00:00.000+01:00",
"productId": 1,
"removed": false,
"clientName": "Dhr. P. Atient",
"clientObjectId": 1,
"deliveryAddress": {
"city": "Groenlo",
"country": "NL",
"homeNumber": 3,
"homeNumberExtension": "c",
"roomNumber": "304a",
"note": "graag afleveren bij de buren op nr. 5",
"street": "Industrieweg",
"type": "CLIENT_HOME",
"zipcode": "7141DD"
},
"requester": {
"emailAddress": "teamoost@groenlozorg.nl",
"employeeObjectId": 1,
"name": "M. Edewerker",
"phoneNumber": "0612345678",
"teamName": "Groenlo Oost",
"teamObjectId": 1
},
"declinedAt": "2025-01-01T12:00:00.000+01:00",
"acceptedAt": "2025-02-01T12:00:00.000+01:00",
"completedAt": "2025-03-01T12:00:00.000+01:00",
"status": "COMPLETED",
"deviceIdentificationNumber": "roos-maan-vis-luna",
"orderNumber": "OD-893264276549",
"supplierNote": "Graag nog het telefoonnumber van de cliënt invullen",
"trackingUrl": "https://www.postnl.nl/track-and-trace/206727865874268278"
}
},
"caretech.DeliveryAddress": {
"required": [
"city",
"country",
"homeNumber",
"street",
"type",
"zipcode"
],
"type": "object",
"properties": {
"city": {
"type": "string"
},
"country": {
"pattern": "^[A-Z]{2}$",
"type": "string"
},
"homeNumber": {
"type": "integer",
"format": "int32"
},
"homeNumberExtension": {
"type": "string"
},
"note": {
"type": "string"
},
"roomNumber": {
"type": "string"
},
"street": {
"type": "string"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/caretech.AddressType"
}
],
"description": "The delivery address type, can be CLIENT_HOME, CLIENT_CARE_ALLOCATION, MANUAL"
},
"zipcode": {
"type": "string"
}
},
"description": "The delivery address of the order",
"example": {
"city": "Groenlo",
"country": "NL",
"homeNumber": 3,
"homeNumberExtension": "c",
"roomNumber": "304a",
"note": "graag afleveren bij de buren op nr. 5",
"street": "Industrieweg",
"type": "CLIENT_HOME",
"zipcode": "7141DD"
}
},
"caretech.AddressType": {
"enum": [
"CLIENT_HOME",
"CLIENT_CARE_ALLOCATION",
"MANUAL"
],
"type": "string",
"description": "The delivery address type, can be CLIENT_HOME, CLIENT_CARE_ALLOCATION, MANUAL",
"example": "CLIENT_HOME"
},
"caretech.Requester": {
"required": [
"emailAddress",
"employeeObjectId",
"name",
"phoneNumber",
"teamName",
"teamObjectId"
],
"type": "object",
"properties": {
"emailAddress": {
"type": "string"
},
"employeeObjectId": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"teamName": {
"type": "string"
},
"teamObjectId": {
"type": "integer",
"format": "int64"
}
},
"description": "The person who creates the care technology order",
"example": {
"emailAddress": "teamoost@groenlozorg.nl",
"employeeObjectId": 1,
"name": "M. Edewerker",
"phoneNumber": "0612345678",
"teamName": "Groenlo Oost",
"teamObjectId": 1
}
},
"caretech.list.ReturnRequestList": {
"required": [
"returnRequests"
],
"type": "object",
"properties": {
"returnRequests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/caretech.ReturnRequest"
}
}
},
"description": "ReturnRequestList model (no description)",
"example": {
"returnRequests": [
{
"acceptedAt": "2024-03-15T10:00:00.000+01:00",
"clientIdentificationNo": "123456789",
"completedAt": "2024-03-20T14:30:00.000+01:00",
"createdAt": "2024-03-10T09:00:00.000+01:00",
"declinedAt": "2024-03-12T11:15:00.000+01:00",
"id": 42,
"pickupAddress": {
"city": "Groenlo",
"country": "NL",
"homeNumber": 12,
"homeNumberExtension": "A",
"note": "Ring the bell twice",
"roomNumber": "3",
"street": "Parallelweg",
"type": "CLIENT_HOME",
"zipcode": "7141DC"
},
"preferredPickupDays": "mon,tue,wed",
"productAllocation": {
"clientId": 1,
"createdAt": "2017-10-02T21:10:43.000+02:00",
"employeeUuid": "042f53df-37e5-4ad7-af77-16a212763bba",
"id": 4,
"productInstance": {
"createdAt": "2017-10-02T21:10:43.000+02:00",
"externalId": "serial-12345678",
"id": 56,
"product": {
"createdAt": "2017-10-02T21:10:43.000+02:00",
"id": 1,
"manufacturer": "Nedap",
"name": "Nedap Luna",
"updatedAt": "2017-10-02T21:10:43.000+02:00",
"uuid": "042f53df-37e5-4ad7-af77-16a212763bba"
},
"updatedAt": "2017-10-02T21:10:43.000+02:00",
"uuid": "042f53df-37e5-4ad7-af77-16a212763bba"
},
"requestDate": "2024-03-10",
"startDate": "2024-03-11",
"stopDate": "2024-03-12",
"status": "INACTIVE",
"updatedAt": "2017-10-02T21:10:43.000+02:00",
"uuid": "042f53df-37e5-4ad7-af77-16a212763bba"
},
"requester": {
"emailAddress": "teamoost@groenlozorg.nl",
"employeeObjectId": 1,
"name": "M. Edewerker",
"phoneNumber": "0612345678",
"teamName": "Groenlo Oost",
"teamObjectId": 1
},
"returnMethod": "PICKUP",
"returnNumber": "1234",
"status": "OPEN",
"supplierNote": "Device is incomplete",
"trackingUrl": "https://post.nl?trackingNumber=6318638",
"updatedAt": "2024-03-18T16:45:00.000+01:00",
"uuid": "042f53df-37e5-4ad7-af77-16a212763bba"
}
]
}
},
"caretech.ReturnRequest": {
"required": [
"clientIdentificationNo",
"productAllocation",
"requester",
"returnMethod",
"status"
],
"type": "object",
"properties": {
"acceptedAt": {
"type": "string",
"format": "date-time"
},
"clientIdentificationNo": {
"type": "string"
},
"completedAt": {
"type": "string",
"format": "date-time"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"declinedAt": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"pickupAddress": {
"$ref": "#/components/schemas/caretech.PickupAddress"
},
"preferredPickupDays": {
"type": "string",
"description": "Distinct comma-separated abbreviated weekdays (mon,tue,wed,thu,fri,sat,sun)",
"example": "mon,tue,wed"
},
"productAllocation": {
"$ref": "#/components/schemas/caretech.ProductAllocation"
},
"requester": {
"$ref": "#/components/schemas/caretech.Requester"
},
"returnMethod": {
"$ref": "#/components/schemas/caretech.ReturnMethod"
},
"returnNumber": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/caretech.ReturnRequestStatus"
},
"supplierNote": {
"type": "string"
},
"trackingUrl": {
"type": "string"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"uuid": {
"type": "string",
"format": "uuid"
}
},
"description": "ReturnRequest model (no description)",
"example": {
"acceptedAt": "2024-03-15T10:00:00.000+01:00",
"clientIdentificationNo": "123456789",
"completedAt": "2024-03-20T14:30:00.000+01:00",
"createdAt": "2024-03-10T09:00:00.000+01:00",
"declinedAt": "2024-03-12T11:15:00.000+01:00",
"id": 42,
"pickupAddress": {
"city": "Groenlo",
"country": "NL",
"homeNumber": 12,
"homeNumberExtension": "A",
"note": "Ring the bell twice",
"roomNumber": "3",
"street": "Parallelweg",
"type": "CLIENT_HOME",
"zipcode": "7141DC"
},
"preferredPickupDays": "mon,tue,wed",
"productAllocation": {
"clientId": 1,
"createdAt": "2017-10-02T21:10:43.000+02:00",
"employeeUuid": "042f53df-37e5-4ad7-af77-16a212763bba",
"id": 4,
"productInstance": {
"createdAt": "2017-10-02T21:10:43.000+02:00",
"externalId": "serial-12345678",
"id": 56,
"product": {
"createdAt": "2017-10-02T21:10:43.000+02:00",
"id": 1,
"manufacturer": "Nedap",
"name": "Nedap Luna",
"updatedAt": "2017-10-02T21:10:43.000+02:00",
"uuid": "042f53df-37e5-4ad7-af77-16a212763bba"
},
"updatedAt": "2017-10-02T21:10:43.000+02:00",
"uuid": "042f53df-37e5-4ad7-af77-16a212763bba"
},
"requestDate": "2024-03-10",
"startDate": "2024-03-11",
"stopDate": "2024-03-12",
"status": "INACTIVE",
"updatedAt": "2017-10-02T21:10:43.000+02:00",
"uuid": "042f53df-37e5-4ad7-af77-16a212763bba"
},
"requester": {
"emailAddress": "teamoost@groenlozorg.nl",
"employeeObjectId": 1,
"name": "M. Edewerker",
"phoneNumber": "0612345678",
"teamName": "Groenlo Oost",
"teamObjectId": 1
},
"returnMethod": "PICKUP",
"returnNumber": "1234",
"status": "OPEN",
"supplierNote": "Device is incomplete",
"trackingUrl": "https://post.nl?trackingNumber=6318638",
"updatedAt": "2024-03-18T16:45:00.000+01:00",
"uuid": "042f53df-37e5-4ad7-af77-16a212763bba"
}
},
"caretech.PickupAddress": {
"required": [
"city",
"country",
"homeNumber",
"street",
"type",
"zipcode"
],
"type": "object",
"properties": {
"city": {
"minLength": 1,
"type": "string"
},
"country": {
"pattern": "^[A-Z]{2}$",
"type": "string"
},
"homeNumber": {
"type": "integer",
"format": "int32"
},
"homeNumberExtension": {
"type": "string"
},
"note": {
"type": "string",
"deprecated": true,
"x-deprecated-since": "22-07-2026"
},
"roomNumber": {
"type": "string"
},
"street": {
"minLength": 1,
"type": "string"
},
"type": {
"$ref": "#/components/schemas/caretech.AddressType"
},
"zipcode": {
"minLength": 1,
"type": "string"
}
},
"description": "PickupAddress model (no description)",
"example": {
"city": "Groenlo",
"country": "NL",
"homeNumber": 12,
"homeNumberExtension": "A",
"note": "Ring the bell twice",
"roomNumber": "3",
"street": "Parallelweg",
"type": "CLIENT_HOME",
"zipcode": "7141DC"
}
},
"caretech.ReturnMethod": {
"enum": [
"PICKUP",
"DROP_OFF"
],
"type": "string",
"description": "The method type of returning the caretechnology device",
"example": "PICKUP"
},
"client_story.ChangeSet": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"description": "Timestamp of this changeset",
"format": "date-time"
},
"source": {
"type": "string",
"description": "The source that made the changes in this changeset\nCan be Caren or Dossier"
},
"userId": {
"type": "integer",
"description": "The user id that made the changes. Can refer to the user id or the caren person id depending on the source",
"format": "int32",
"default": 0
},
"changes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/client_story.Change"
},
"description": "A list of all changes in this changeset"
}
},
"description": "ChangeSet model (no description)",
"example": {
"timestamp": "2019-10-01T00:00:00.000+02:00",
"source": "Dossier",
"userId": 1337,
"changes": [
{
"type": "question",
"action": "create",
"questionTitle": "Test question?",
"questionContext": "Test question to test",
"oldValue": "",
"newValue": "Test answer"
}
]
}
},
"client_story.Change": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of the question that was changed: array, event, eventMultimedia, multimedia, multipleChoice or question"
},
"action": {
"type": "string",
"description": "Change action that was applied to the question answer: update, delete or create"
},
"questionTitle": {
"type": "string",
"description": "Title of the question this change was applied to"
},
"questionContext": {
"type": "string",
"description": "Context text of the question that was changed"
},
"oldValue": {
"type": "string",
"description": "Old / previous value of the answer to this question"
},
"newValue": {
"type": "string",
"description": "Value of this question after this change was applied"
}
},
"description": "Change model (no description)",
"example": {
"type": "question",
"action": "create",
"questionTitle": "Test question?",
"questionContext": "Test question to test",
"oldValue": "",
"newValue": "Test answer"
}
},
"ons_client.list.SharedResourceList": {
"type": "object",
"properties": {
"sharedResources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ons_client.SharedResource"
}
}
},
"description": "SharedResourceList model (no description)",
"example": {
"sharedResources": [
{
"id": 1,
"resourceName": "Dossier.CarePlan",
"resourceId": "13",
"clientId": 1,
"recipientGroup": "client",
"shareReason": "Beste Henk, bij deze een nieuw zorgplan nav ons vorige gesprek. Ik heb nu ook als doel je slikprobleem meegenomen.",
"sharedAt": "2016-10-10T00:00:00.000+02:00",
"sharedByEmployeeId": 2,
"unshareReason": "Deze versie bevatte een spelfout. Ik heb dit in de nieuwe versie aangepast.",
"unsharedAt": "2016-10-12T00:00:00.000+02:00",
"unsharedByEmployeeId": 2,
"writable": true
},
{
"id": 2,
"resourceName": "Survey.SurveyResult",
"resourceId": "13",
"clientId": 1,
"recipientGroup": "client",
"shareReason": "Dit is de ingevulde MIC-melding van afgelopen woensdg.",
"sharedAt": "2016-10-14T13:16:00.000+02:00",
"sharedByEmployeeId": 2,
"writable": false
}
]
}
},
"ons_client.SharedResource": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"resourceId": {
"type": "string"
},
"clientId": {
"type": "integer",
"format": "int64"
},
"recipientGroup": {
"type": "string"
},
"shareReason": {
"type": "string"
},
"sharedAt": {
"type": "string",
"format": "date-time"
},
"sharedByEmployeeId": {
"type": "integer",
"format": "int64"
},
"unshareReason": {
"type": "string"
},
"unsharedAt": {
"type": "string",
"format": "date-time"
},
"unsharedByEmployeeId": {
"type": "integer",
"format": "int64"
},
"writable": {
"type": "boolean"
},
"resourceName": {
"type": "string"
}
},
"description": "Cupido resources shared with the client environment.",
"example": {
"id": 1,
"resourceName": "Dossier.CarePlan",
"resourceId": "13",
"clientId": 1,
"recipientGroup": "client",
"shareReason": "Beste Henk, bij deze een nieuw zorgplan nav ons vorige gesprek. Ik heb nu ook als doel je slikprobleem meegenomen.",
"sharedAt": "2016-10-10T00:00:00.000+02:00",
"sharedByEmployeeId": 2,
"unshareReason": "Deze versie bevatte een spelfout. Ik heb dit in de nieuwe versie aangepast.",
"unsharedAt": "2016-10-12T00:00:00.000+02:00",
"unsharedByEmployeeId": 2,
"writable": true
}
},
"dbc.ggz.fz.list.SubtrajectList": {
"type": "object",
"properties": {
"subtrajecten": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.fz.Subtraject"
}
],
"xml": {
"name": "subtraject"
}
},
"xml": {
"name": "subtraject"
}
}
},
"description": "SubtrajectList model (no description)",
"example": {
"subtrajecten": [
{
"id": 1,
"externalId": 1,
"externalProductToewijzingId": 2,
"identificatienummer": "997881",
"openingsdatum": "2016-08-18",
"sluitdatum": "2016-08-18",
"regiebehandelaar": "12345678",
"regiebehandelaarId": 1,
"medebehandelaar": "87654321",
"medebehandelaarId": 2,
"debiteurType": "CUSTOM",
"customDebtorId": 1,
"excludeInvoicing": false,
"latestGrouperResultaat": {
"updatedAt": "2016-08-16T00:00:00.000+02:00",
"createdAt": "2016-08-16T00:00:00.000+02:00",
"createdBy": "Administrator",
"id": 1,
"prestatiecode": "101010001230",
"declaratiecode": "25B019",
"productgroep": "00230",
"productGroep": {
"id": 5,
"code": "00230",
"codeBehandeling": "123123",
"omschrijvingBehandeling": "Behandeling",
"setting": "setting",
"categorie": "GEEN",
"lekenvertaling": "Behandeling voor problemen",
"diagnoseBlinderen": false,
"brancheIndicatie": "GGZ"
},
"timestamp": "2016-03-15T00:00:00.000+01:00"
},
"numberOfDirectMinutes": 30,
"numberOfIndirectMinutes": 40,
"numberOfTravelMinutes": 50,
"lastRegistrationDate": "2010-10-10T00:00:00.000+02:00",
"excludeInvoicingReason": "we do not want it anymore",
"updatedAt": "2016-08-18T00:00:00.000+02:00",
"createdAt": "2016-08-18T00:00:00.000+02:00",
"createdBy": "Administrator",
"aardDelict": {
"id": 1,
"code": "1",
"begindatum": "2000-01-01",
"einddatum": "9999-12-31",
"omschrijving": "Test aardDelict!"
},
"vluchtGevaar": {
"id": 1,
"code": "1",
"begindatum": "2000-01-01",
"einddatum": "9999-12-31",
"omschrijving": "Test vluchtGevaar!"
},
"recidiveGevaar": {
"id": 1,
"code": "1",
"begindatum": "2000-01-01",
"einddatum": "9999-12-31",
"omschrijving": "Test recidiveGevaar!"
},
"fysiekGevaar": {
"id": 1,
"code": "1",
"begindatum": "2000-01-01",
"einddatum": "9999-12-31",
"omschrijving": "Test fysiekGevaar!"
},
"plaatsingsbesluitnummer": "123",
"strafrechtketennummer": "789789",
"forensischeZorgtitel": {
"id": 1,
"code": "1",
"omschrijving": "Test zorgtitel!",
"begindatum": "2000-01-01",
"einddatum": "9999-12-31"
}
}
]
},
"xml": {
"name": "subtrajecten"
}
},
"dbc.ggz.list.ZorgtrajectList": {
"type": "object",
"properties": {
"zorgtrajecten": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.Zorgtraject"
}
],
"xml": {
"name": "zorgtraject"
}
}
}
},
"description": "ZorgtrajectList model (no description)",
"example": {
"zorgtrajecten": [
{
"id": 1,
"externalId": 1,
"beschikkingExternalId": 2,
"clientId": 1,
"verwijzingId": 1,
"jeugd": false,
"privacyBezwaar": true,
"identificatienummer": "1",
"begindatum": "2016-08-18",
"einddatum": "2016-08-18",
"verwijzerAgb": "12345678"
}
]
},
"xml": {
"name": "zorgtrajecten"
}
},
"dbc.ggz.list.SubtrajectList": {
"type": "object",
"properties": {
"subtrajecten": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.Subtraject"
}
],
"xml": {
"name": "subtraject"
}
}
}
},
"description": "SubtrajectList model (no description)",
"example": {
"subtrajecten": [
{
"updatedAt": "2016-08-18T00:00:00.000+02:00",
"createdAt": "2016-08-18T00:00:00.000+02:00",
"createdBy": "Administrator",
"id": 1,
"identificatienummer": "997881",
"openingsdatum": "2016-08-18",
"sluitdatum": "2016-08-18",
"regiebehandelaar": "12345678",
"medebehandelaar": "87654321",
"debiteurType": "CUSTOM",
"customDebtorId": 1,
"excludeInvoicing": false
}
]
},
"xml": {
"name": "subtrajecten"
}
},
"dbc.ggz.list.ValidationErrorList": {
"type": "object",
"properties": {
"validationErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dbc.ggz.ValidationError"
},
"xml": {
"name": "validationError"
}
}
},
"description": "ValidationErrorList model (no description)",
"example": {
"validationErrors": [
{
"updatedAt": "2018-01-08T00:00:00.000+01:00",
"createdAt": "2018-01-08T00:00:00.000+01:00",
"createdBy": "Administrator",
"id": 1,
"subtrajectId": 1,
"type": "DBC_SPELREGEL",
"severity": "ERROR",
"message": "DBC niet gesloten binnen 365 dagen"
}
]
},
"xml": {
"name": "validationErrors"
}
},
"dbc.ggz.ValidationError": {
"required": [
"subtrajectId",
"type"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"description": "Object identifier",
"format": "int64",
"x-cupido-id": true
},
"subtrajectId": {
"type": "integer",
"description": "The object identifier of the DBC/DBBC (Subtraject) this validation error belongs to.",
"format": "int64"
},
"type": {
"type": "string",
"description": "Possible values:\nDBC_SPELREGEL (Validation error for NZA spelregels)\nSYNC_CAREORDERPRODUCT (Synchronization of general DBC/DBBC financial information)\nSYNC_FORENSIC_CAREORDER (Synchronization of FZ DBBC)\nSYNC_BEHANDELAAR (The employee information could not be synced)"
},
"severity": {
"type": "string",
"description": "Possible values:\nERROR\nWARNING"
},
"message": {
"type": "string",
"description": "The message (in Dutch)"
}
},
"description": "ValidationError model (no description)",
"example": {
"updatedAt": "2018-01-08T00:00:00.000+01:00",
"createdAt": "2018-01-08T00:00:00.000+01:00",
"createdBy": "Administrator",
"id": 1,
"subtrajectId": 1,
"type": "DBC_SPELREGEL",
"severity": "ERROR",
"message": "DBC niet gesloten binnen 365 dagen"
},
"xml": {
"name": "validationError"
}
},
"dbc.ggz.PresenceLogSynchronisationError": {
"required": [
"clientId"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"description": "Object identifier",
"format": "int64",
"x-cupido-id": true
},
"clientId": {
"type": "integer",
"description": "Technical identification of the corresponding Client",
"format": "int64"
},
"presencelogId": {
"type": "integer",
"description": "Technical identification of the corresponding PresenceLog",
"format": "int64"
},
"zorgtraject": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.Zorgtraject"
}
],
"description": "The corresponding dbc.ggz.Zorgtraject,\nOnly filled in when possible, can be null"
},
"subtraject": {
"allOf": [
{
"$ref": "#/components/schemas/dbc.ggz.Subtraject"
}
],
"description": "The corresponding dbc.ggz.Subtraject,\nOnly filled in when possible, can be null"
},
"message": {
"type": "string",
"description": "The (dutch) error message indicating what information is missing that is\ncausing the presencelog synchronisation to fail for this PresenceLog"
}
},
"description": "PresenceLogSynchronisationError:\nReflects a log entry in ons-dbc generated when the scheduled PresenceLogSynchronizer job resulted in an error",
"example": {
"updatedAt": "2018-05-04T00:00:00.000+02:00",
"createdAt": "2018-05-04T00:00:00.000+02:00",
"createdBy": "Administrator",
"id": 1,
"clientId": 1,
"presencelogId": 1,
"zorgtraject": {
"updatedAt": "2018-02-01T00:00:00.000+01:00",
"createdAt": "2018-02-01T00:00:00.000+01:00",
"createdBy": "Administrator",
"id": 1,
"externalId": 1,
"beschikkingExternalId": 2,
"clientId": 1,
"verwijzingId": 1,
"jeugd": false,
"privacyBezwaar": false,
"identificatienummer": "1",
"begindatum": "2018-02-01",
"einddatum": "2018-05-30",
"soortVerwijzer": {
"id": 1,
"code": "01",
"begindatum": "2016-08-18",
"einddatum": "2016-08-18",
"omschrijving": "huisarts"
},
"verwijzerAgb": "12345678",
"uitvoerendeInstellingAgb": "04122827"
},
"subtraject": {
"updatedAt": "2018-02-01T00:00:00.000+01:00",
"createdAt": "2018-02-01T00:00:00.000+01:00",
"createdBy": "Administrator",
"id": 1,
"externalId": 1,
"externalProductToewijzingId": 2,
"identificatienummer": "997881",
"openingsdatum": "2018-02-01",
"sluitdatum": "2018-05-30",
"regiebehandelaar": "12345678",
"medebehandelaar": "87654321",
"soortVerwijzer": {
"id": 1,
"code": "01",
"begindatum": "2016-08-18",
"einddatum": "2016-08-18",
"omschrijving": "huisarts"
},
"verwijzerAgb": "12345678",
"debiteurType": "CUSTOM",
"excludeInvoicing": false
},
"message": "Geen activiteit gevonden voor registratie met id 1."
},
"xml": {
"name": "presenceLogSynchronisationError"
}
},
"dbc.ggz.list.PresenceLogSynchronisationErrorList": {
"type": "object",
"properties": {
"presenceLogSynchronisationErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dbc.ggz.PresenceLogSynchronisationError"
},
"xml": {
"name": "presenceLogSynchronisationError"
}
}
},
"description": "PresenceLogSynchronisationErrorList model (no description)",
"example": {
"presenceLogSynchronisationErrors": [
{
"updatedAt": "2018-05-04T00:00:00.000+02:00",
"createdAt": "2018-05-04T00:00:00.000+02:00",
"createdBy": "Administrator",
"id": 1,
"clientId": 1,
"presencelogId": 1,
"zorgtraject": {
"updatedAt": "2018-02-01T00:00:00.000+01:00",
"createdAt": "2018-02-01T00:00:00.000+01:00",
"createdBy": "Administrator",
"id": 1,
"externalId": 1,
"beschikkingExternalId": 2,
"clientId": 1,
"verwijzingId": 1,
"jeugd": false,
"privacyBezwaar": false,
"identificatienummer": "1",
"begindatum": "2018-02-01",
"einddatum": "2018-05-30",
"soortVerwijzer": {
"id": 1,
"code": "01",
"begindatum": "2016-08-18",
"einddatum": "2016-08-18",
"omschrijving": "huisarts"
},
"verwijzerAgb": "12345678",
"uitvoerendeInstellingAgb": "04122827"
},
"subtraject": {
"updatedAt": "2018-02-01T00:00:00.000+01:00",
"createdAt": "2018-02-01T00:00:00.000+01:00",
"createdBy": "Administrator",
"id": 1,
"externalId": 1,
"externalProductToewijzingId": 2,
"identificatienummer": "997881",
"openingsdatum": "2018-02-01",
"sluitdatum": "2018-05-30",
"regiebehandelaar": "12345678",
"medebehandelaar": "87654321",
"soortVerwijzer": {
"id": 1,
"code": "01",
"begindatum": "2016-08-18",
"einddatum": "2016-08-18",
"omschrijving": "huisarts"
},
"verwijzerAgb": "12345678",
"debiteurType": "CUSTOM",
"excludeInvoicing": false
},
"message": "Geen activiteit gevonden voor registratie met id 1."
}
]
},
"xml": {
"name": "presenceLogSynchronisationErrors"
}
},
"ErrorResponse": {
"title": "ErrorResponse",
"type": "object",
"properties": {
"errorResponseEntries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorResponseEntry"
},
"xml": {
"wrapped": true
}
}
},
"description": "Error response model",
"example": {
"errorResponseEntries": [
{
"field": "one",
"value": "a",
"message": "field can not be empty"
},
{
"field": "two",
"value": "a",
"message": "too short"
}
]
}
},
"ErrorResponseEntry": {
"title": "ErrorResponseEntry",
"type": "object",
"properties": {
"field": {
"type": "string"
},
"value": {
"type": "string"
},
"message": {
"type": "string"
}
},
"description": "Error response entry model",
"example": {
"field": "one",
"value": "empty",
"message": "field can not be empty"
}
},
"dossier.ActiveCarePlanMetadata": {
"type": "object",
"properties": {
"carePlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.CarePlanMetadata"
}
},
"carePlanName": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.CarePlanName"
}
],
"description": "Care plan name set by the customer"
}
},
"description": "ActiveCarePlanMetadata list model (no description)",
"example": {
"carePlans": [
{
"clientId": 1,
"beginDate": "2021-01-01",
"endDate": "2021-02-06"
}
],
"carePlanName": "PLAN"
}
},
"dossier.CarePlanMetadata": {
"type": "object",
"properties": {
"clientId": {
"type": "integer",
"format": "int64"
},
"beginDate": {
"type": "string",
"description": "Begin date of this care plan",
"format": "date"
},
"endDate": {
"type": "string",
"description": "End date of this care plan",
"format": "date"
}
},
"description": "CarePlanMetadata model (no description)",
"example": {
"clientId": 1,
"beginDate": "2021-01-01",
"endDate": "2021-02-06"
}
},
"dossier.CarePlanName": {
"enum": [
"CARE_PLAN",
"PLAN"
],
"type": "string",
"description": "Care plan name set by the customer",
"example": "PLAN"
},
"dossier.admin.alerts.list.TopicList": {
"type": "object",
"properties": {
"topics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.admin.alerts.Topic"
}
}
},
"description": "TopicList model (no description)",
"example": {
"topics": [
{
"id": 1,
"name": "Covid-19",
"active": true,
"protocol": "http://www.example.org",
"showDescription": true,
"alertType": "danger_medical",
"icon": "virus"
},
{
"id": 2,
"name": "Dangerous dog",
"active": true,
"protocol": "http://www.example.org",
"showDescription": false,
"alertType": "danger_non_medical",
"icon": "aggression"
}
]
}
},
"dossier.list.LastMedicalMomentList": {
"type": "object",
"properties": {
"lastMedicalMoments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.LastMedicalMoment"
}
}
},
"description": "LastMedicalMomentList model (no description)",
"example": {
"lastMedicalMoments": [
{
"clientId": 1,
"updatedAt": "2014-06-16T02:00:00.000+02:00"
},
{
"clientId": 2,
"updatedAt": "2014-06-16T02:00:00.000+02:00"
}
]
}
},
"dossier.LastMedicalMoment": {
"type": "object",
"properties": {
"clientId": {
"type": "integer",
"format": "int64"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"description": "LastMedicalMoment model (no description)",
"example": {
"clientId": 1,
"updatedAt": "2014-06-16T02:00:00.000+02:00"
}
},
"dossier.medical.list.PropensityToAdverseReactionList": {
"type": "object",
"properties": {
"propensityToAdverseReactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.PropensityToAdverseReaction"
}
}
},
"description": "PropensityToAdverseReactionList model (no description)",
"example": {
"propensityToAdverseReactions": [
{
"id": 5,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 4,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-10T12:00:00.000+01:00",
"updatedAt": "2014-11-10T12:00:00.000+01:00",
"causeBuilders": [
{
"system": "CUSTOM",
"query": "Stofmijt"
},
{
"system": "SNOMED",
"query": "256259004 | pollen |",
"name": "Pollen"
}
],
"cause": "Haar van dieren",
"causativeAgent": {
"name": "Haar/schilfers van dieren",
"encodings": [
{
"code": "264287008",
"codeSystem": "SNOMED CT",
"displayName": "animal dander"
}
]
},
"manifestations": [
"Diarree",
"Misselijkheid",
"Duizeligheid"
],
"active": true,
"specification": "Specificatie",
"narrative": "Het doet zeer",
"certainty": "Ik ben er niet zo zeker van",
"severity": "Niet levensbedreigend",
"course": "De afgelopen twee weken",
"onsetPeriodOfLife": "Vanaf kleuterperiode",
"onsetApproximateDate": "2014",
"immutable": true
}
]
},
"xml": {
"name": "propensityToAdverseReactions"
}
},
"dossier.list.ReportWithActionsList": {
"type": "object",
"properties": {
"reportsWithActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.ReportWithActions"
}
}
},
"description": "List of ReportWithActions",
"example": {
"reportsWithActions": [
{
"id": 1,
"reportedAt": "2014-11-14T00:00:00.000+01:00",
"flagged": true,
"hidden": true,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"status": 1,
"clientId": 1,
"reportTypeId": 1,
"reportTypeName": "mbi",
"reportTypeIconName": "dossier",
"authorName": "Henk",
"authorType": "employee",
"confidential": true,
"registrationCouplingUuid": "abcd1234-ef56-7890-gh12-ijkl3456mnop",
"measurements": [
{
"name": "decimal",
"label": "Temperatuur",
"value": 38.4,
"unit": "°C",
"format": "%.1f"
}
],
"authorizations": {
"profileAuthorizations": [],
"groupAuthorizations": []
},
"photos": [],
"reactions": [],
"actions": {
"status": "none",
"reportActions": []
}
}
]
}
},
"dossier.ReportWithActions": {
"title": "ReportWithActions",
"required": [
"id",
"reportedAt",
"flagged",
"hidden",
"createdAt",
"updatedAt",
"status",
"clientId",
"reportTypeId",
"reportTypeName",
"reportTypeIconName",
"authorName",
"authorType",
"confidential",
"measurements",
"photos",
"reactions",
"authorizations",
"actions"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the report",
"format": "int64",
"nullable": false
},
"uuid": {
"type": "string",
"description": "UUID of the report",
"format": "uuid",
"nullable": true
},
"reportedAt": {
"type": "string",
"description": "Timestamp of the report. It is usually time when the report was created but it can be set when report is created.\n",
"format": "date-time",
"nullable": false
},
"comment": {
"type": "string",
"description": "Text comment on the report",
"nullable": true
},
"flagged": {
"type": "boolean",
"description": "When set to `true` then report is marked as important/flagged. Flagged reports are displayed on the client overview page.\n",
"nullable": false
},
"hidden": {
"type": "boolean",
"description": "When set to `true` the report is hidden. Only users with `ApplicationManager` right or authors of the report can see\nthis report.\n",
"nullable": false
},
"hidingReason": {
"type": "string",
"description": "The reason why this report is hidden (see `hidden` property). When report is hidden then this field is always filled because\nhiding reason is mandatory for hidden reports.\n",
"nullable": true
},
"createdAt": {
"type": "string",
"description": "Timestamp of the time when report was created (unlike reportedAt, this one cannot be changed).",
"format": "date-time",
"nullable": false
},
"updatedAt": {
"type": "string",
"description": "Timestamp of the time when report was updated",
"format": "date-time",
"nullable": false
},
"status": {
"$ref": "#/components/schemas/dossier.ReportStatus"
},
"clientId": {
"type": "integer",
"description": "ID of the client this report belongs to",
"format": "int64"
},
"reportTypeId": {
"type": "integer",
"description": "Type of the report provided as a number. Following values are standard report types:\n- 101 Text report\n- 102 BMI (weight and height) report\n- 103 Blood pressure report\n- 104 Temperature report\n- 105 Blood sugar (Glucose) report\n- 106 Fluid-in report\n- 107 Fluid-out report\n- 108 Defecation report\n- 109 Medical report\n- 110 Progress report\n- 111 Family report\n- 112 Chain (Ketencommunicatie) report\n- 309 Mood report\n- 310 Omaha report\n- 311 Saturation report\n- 314 Pain report\n- 315 SOAP report\n- 316 Bristol report\n- 317 Clinimetrics (Next Dossier) report\n- 318 Photo report\n"
},
"reportTypeName": {
"type": "string",
"description": "Name (in Dutch) of the report type."
},
"reportTypeIconName": {
"type": "string",
"description": "Name of the icon for the report type of this report. It's not the icon itself, and it is up to the consumer to translate name of the icon\nto the actual icon that can be displayed.\n"
},
"authorName": {
"type": "string",
"description": "Name of the author of the report. Can be a name of the employee who created the report or a name of Caren user.",
"nullable": false
},
"authorType": {
"$ref": "#/components/schemas/dossier.ReportAuthorType"
},
"authorId": {
"type": "integer",
"description": "ID of the report author, can be an ID of an employee or ID of a user in Caren. It can also be empty in\ncase of external authors\n",
"format": "int64",
"nullable": true
},
"authorRole": {
"type": "string",
"description": "Role of the report author. This field is used only for caren reports",
"nullable": true
},
"authorExpertiseProfileId": {
"type": "integer",
"description": "ID of author's expertise (education) profile at the time of report creation.\n\nThis field is empty for caren reports or when employee did not have any expertise profile assigned.\n",
"format": "int64",
"nullable": true
},
"authorExpertiseProfileName": {
"type": "string",
"description": "Name of author's expertise (education) profile at the time of report creation.\n\nThis field is empty for caren reports or when employee did not have any expertise profile assigned.\n",
"nullable": true
},
"registrationCouplingUuid": {
"type": "string",
"description": "UUID of the registration coupling that is related to this report.",
"format": "uuid"
},
"episodeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "List of episode IDs that this report is linked to",
"nullable": true
},
"restrictiveMeasureId": {
"type": "integer",
"description": "ID of the restrictive measure this report is linked to. `null` when there is no link.",
"format": "int64",
"nullable": true
},
"carePlanEntryId": {
"type": "integer",
"description": "ID of the care plan entry this report is linked to. `null` when there is no link.",
"format": "int64",
"nullable": true
},
"reportLinkId": {
"type": "integer",
"description": "ID of the report in external system. Type of the external system is defined in `reportLinkType` property.",
"format": "int64",
"nullable": true
},
"reportLinkType": {
"$ref": "#/components/schemas/dossier.ReportLinkType"
},
"actions": {
"$ref": "#/components/schemas/dossier.CombinedReportActionsViewModel"
},
"confidential": {
"type": "boolean",
"description": "When set to `true` then this report is not public and can only be seen by employees with proper level\nof authorization (see the `authorizations` property in this model)\n",
"nullable": false
},
"authorizations": {
"$ref": "#/components/schemas/dossier.ReportAuthorizationsViewModel"
},
"measurements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.MeasurementViewModel"
},
"description": "List of measurements (previously listed as report entries) to display when report is rendered"
},
"photos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.ReportPhotoViewModel"
},
"description": "List of photos attached to the report"
},
"goals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.ReportGoalViewModel"
},
"description": "List of plan goals linked to the report"
},
"soap": {
"$ref": "#/components/schemas/dossier.SoapViewModel"
},
"reactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.ReportReactionViewModel"
},
"description": "List of reactions to this report"
}
},
"description": "Report model extended with information from other sources (like employee name, client name, etc.)\n",
"example": {
"id": 1,
"reportedAt": "2014-11-14T00:00:00.000+01:00",
"flagged": true,
"hidden": true,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"status": 1,
"clientId": 1,
"reportTypeId": 1,
"reportTypeName": "mbi",
"reportTypeIconName": "dossier",
"authorName": "Henk",
"authorType": "employee",
"confidential": true,
"registrationCouplingUuid": "abcd1234-ef56-7890-gh12-ijkl3456mnop",
"measurements": [
{
"name": "decimal",
"label": "Temperatuur",
"value": 38.4,
"unit": "°C",
"format": "%.1f"
}
],
"authorizations": {
"profileAuthorizations": [],
"groupAuthorizations": []
},
"actions": {
"status": "none",
"reportActions": []
},
"photos": [],
"reactions": []
}
},
"dossier.ReportStatus": {
"type": "integer",
"oneOf": [
{
"title": "OPENED",
"enum": [
0
]
},
{
"title": "CLOSED",
"enum": [
1
]
}
],
"description": "Status of the report, typically used in family communication reports with reactions, where the parent status is updated by the status of the reaction.\n- 0: opened\n- 1: closed\n",
"nullable": false,
"example": 0
},
"dossier.ReportAuthorType": {
"enum": [
"employee",
"caren",
"external"
],
"type": "string",
"description": "- `employee` - author is an employee\n- `caren` - author is a Caren user\n- `external` - author is neither employee nor Caren user\n",
"nullable": false,
"example": "employee"
},
"dossier.CombinedReportActionsViewModel": {
"title": "CombinedReportActionsViewModel",
"required": [
"status",
"reportActions"
],
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/dossier.ReportActionsStatus"
},
"reportActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.CombinedReportActionViewModel"
},
"description": "List of report actions"
}
},
"description": "List of report action view models",
"example": {
"status": "none",
"reportActions": [
{
"receivers": [
{
"id": 77,
"name": "Arts",
"type": "ExpertiseProfile"
}
],
"completable": false,
"completed": true,
"completedAt": "2014-04-01T17:00:00.000+02:00",
"completedByEmployeeId": 1
}
]
}
},
"dossier.ReportActionsStatus": {
"type": "string",
"oneOf": [
{
"title": "NONE",
"enum": [
"none"
]
},
{
"title": "FOR_ME",
"enum": [
"for-me"
]
},
{
"title": "ALL_COMPLETE",
"enum": [
"all-complete"
]
},
{
"title": "FOR_OTHERS",
"enum": [
"for-others"
]
}
],
"description": "Status of the report actions. It indicates if there are incomplete actions for my expertise profile or groups.\n- none : there are no actions for this report\n- for-me : there are incomplete actions for my expertise profile / expertise groups\n- all-complete : all actions for this report are complete\n- for-others : actions for my expertise are complete but there are some incomplete actions for expertise profiles / groups that are not complete\n",
"example": "none"
},
"dossier.CombinedReportActionViewModel": {
"title": "CombinedReportActionViewModel",
"required": [
"receivers",
"completable",
"completed"
],
"type": "object",
"properties": {
"receivers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.CombinedReportActionReceiverViewModel"
},
"description": "List of receivers of the report action, which the report action is assigned to."
},
"completable": {
"type": "boolean",
"description": "Set to true if the current user is a able to complete the action (matches the receiver, not completed yet and has the rights to complete the action)",
"nullable": false
},
"completed": {
"type": "boolean",
"description": "Set to true if the action is completed",
"nullable": false
},
"completedAt": {
"type": "string",
"description": "Time when the action was completed. Empty if it has not been completed yet.",
"format": "date-time",
"nullable": true
},
"completedByEmployeeId": {
"type": "integer",
"description": "ID of the employee who completed this action. Empty if it has not been completed yet.",
"format": "int64",
"nullable": true
}
},
"description": "Report action is referencing either expertise group or expertise profile. The type of the expertise is given by the context\nof the owning object.\n",
"example": {
"receivers": [
{
"id": 77,
"name": "Arts",
"type": "ExpertiseProfile"
}
],
"completable": false,
"completed": true,
"completedAt": "2014-04-01T17:00:00.000+02:00",
"completedByEmployeeId": 1
}
},
"dossier.CombinedReportActionReceiverViewModel": {
"title": "CombinedReportActionReceiverViewModel",
"required": [
"id",
"name",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The identifier of the expertise profile or group",
"nullable": false
},
"name": {
"type": "string",
"description": "The name of the expertise profile or group",
"nullable": false
},
"type": {
"$ref": "#/components/schemas/dossier.CombinedReportActionReceiverType"
}
},
"description": "Report action receiver view model",
"example": {
"id": 1,
"name": "Arts",
"type": "ExpertiseProfile"
}
},
"dossier.CombinedReportActionReceiverType": {
"enum": [
"ExpertiseProfile",
"ExpertiseGroup"
],
"type": "string",
"description": "The type of the receiver; expertise profile or group",
"nullable": false,
"example": "ExpertiseProfile"
},
"dossier.ReportAuthorizationsViewModel": {
"title": "ReportAuthorizationsViewModel",
"required": [
"profileAuthorizations",
"groupAuthorizations"
],
"type": "object",
"properties": {
"profileAuthorizations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.ReportAuthorizationViewModel"
},
"description": "List of expertise profile authorizations."
},
"groupAuthorizations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.ReportAuthorizationViewModel"
},
"description": "List of expertise group authorizations."
}
},
"description": "Expertise profiles and groups that are allowed to view the report. Expertises are applied only if the report is\nmarked as `confidential`, otherwise the list of expertises is ignored.\n",
"example": {
"profileAuthorizations": [
{
"expertiseId": 77,
"expertiseName": "Arts"
}
],
"groupAuthorizations": [
{
"expertiseId": 77,
"expertiseName": "Arts"
}
]
}
},
"dossier.ReportAuthorizationViewModel": {
"title": "ReportAuthorizationViewModel",
"required": [
"expertiseId",
"expertiseName"
],
"type": "object",
"properties": {
"expertiseId": {
"type": "integer",
"description": "ID of the expertise group or expertise profile.",
"format": "int64",
"nullable": false
},
"expertiseName": {
"type": "string",
"description": "Name of the expertise profile or group.",
"nullable": false
}
},
"description": "Authorization is referencing either expertise group or expertise profile. The type of the expertise is given by the context\nof the owning object.\n",
"example": {
"expertiseId": 77,
"expertiseName": "Arts"
}
},
"dossier.SoapViewModel": {
"title": "SoapViewModel",
"required": [
"subjective",
"objective",
"assessment",
"plan"
],
"type": "object",
"properties": {
"subjective": {
"$ref": "#/components/schemas/dossier.SoapPartViewModel"
},
"objective": {
"$ref": "#/components/schemas/dossier.SoapPartViewModel"
},
"assessment": {
"$ref": "#/components/schemas/dossier.SoapPartViewModel"
},
"plan": {
"$ref": "#/components/schemas/dossier.SoapPartViewModel"
}
},
"description": "Values for SOAP (SOEP) report. Comments on individual parts are present only in case when the current\nemployee is allowed to see them.\n",
"nullable": true,
"example": {
"subjective": {
"label": "subjective",
"confidential": true,
"visible": true
},
"objective": {
"label": "objective",
"confidential": true,
"visible": true
},
"assessment": {
"label": "assessment",
"confidential": true,
"visible": true
},
"plan": {
"label": "plan",
"confidential": true,
"visible": true
}
}
},
"dossier.SoapPartViewModel": {
"title": "SoapPartViewModel",
"required": [
"label",
"confidential",
"visible"
],
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "Dutch or English language dependent name of the SOAP part"
},
"comment": {
"type": "string",
"description": "Text of the SOAP part. It is present only if the current employee is allowed to see this SOAP part.",
"nullable": true
},
"visible": {
"type": "boolean",
"description": "Set to `true` if the employee is allowed to see this SOAP part.\n\nIf set to `false` then the `comment` attribute is empty but list of `authorizations` is still visible.\n\nIt means that an employee cannot see the comment but they still can see list of expertise profiles and groups who are\nallowed to see the comment.\n"
},
"confidential": {
"type": "boolean",
"description": "When set to `true` then this report is not public and can only be seen by employees with proper level\nof authorization (see the `authorizations` property in this model)\n",
"nullable": false
},
"authorizations": {
"$ref": "#/components/schemas/dossier.ReportAuthorizationsViewModel"
}
},
"description": "Individual part of the SOAP report (subjective/objective/assessment/plan)",
"example": {
"label": "subjectief",
"confidential": true,
"visible": true
}
},
"dossier.MeasurementViewModel": {
"title": "MeasurementViewModel",
"required": [
"name",
"label",
"value"
],
"type": "object",
"properties": {
"name": {
"$ref": "#/components/schemas/dossier.MeasurementViewModelName"
},
"label": {
"type": "string",
"description": "Name of the field to display (in Dutch or English, it depends on language settings)"
},
"value": {
"type": "number",
"description": "Value of the measurement (e.g. temperature, weight, etc.)",
"format": "double"
},
"format": {
"type": "string",
"description": "Format to use for rendering the value. For example '%.2f' stands for two positions after the decimal\tpoint, more details at https://alvinalexander.com/programming/printf-format-cheat-sheet/",
"nullable": true
},
"unit": {
"type": "string",
"description": "Unit of the value",
"nullable": true
}
},
"description": "Reported value with unit and display format.\nSome reports have multiple measurements (report entries) - for example BMI report can have up to three values (weight, height, BMI)\n",
"example": {
"name": "decimal",
"label": "Temperatuur",
"value": 38.4,
"unit": "°C",
"format": "%.1f"
}
},
"dossier.MeasurementViewModelName": {
"type": "string",
"oneOf": [
{
"title": "BMI",
"enum": [
"bmi"
]
},
{
"title": "WEIGHT",
"enum": [
"weight"
]
},
{
"title": "HEIGHT",
"enum": [
"height"
]
},
{
"title": "SYSTOLIC",
"enum": [
"systolic"
]
},
{
"title": "DIASTOLIC",
"enum": [
"diastolic"
]
},
{
"title": "HEART_RATE",
"enum": [
"heart-rate"
]
},
{
"title": "DECIMAL",
"enum": [
"decimal"
]
}
],
"description": "Technical name of the field, always in English. This can be used if an API consumer needs to know what kind of value they\nare looking at.\n",
"example": "bmi"
},
"dossier.ReportPhotoViewModel": {
"title": "ReportPhotosViewModel",
"required": [
"mimeType",
"chironPhotoId",
"defaultBlurred"
],
"type": "object",
"properties": {
"mimeType": {
"type": "string",
"description": "MIME type of the photo file"
},
"chironPhotoId": {
"type": "integer",
"description": "ID of the photo file stored in Chiron. Can be used to produce the file address.",
"format": "int64"
},
"comment": {
"type": "string",
"description": "Comment describing the photo",
"nullable": true
},
"defaultBlurred": {
"type": "boolean",
"description": "Whether the photo should be blurred by default in a report timeline"
}
},
"description": "Report photo view models",
"example": {
"mimeType": "image/jpeg",
"chironPhotoId": 1023,
"comment": "palm",
"defaultBlurred": false
}
},
"dossier.ReportGoalViewModel": {
"title": "ReportGoalViewModel",
"required": [
"planElementCompositionId",
"goalUid",
"classificationName",
"problemDescription",
"goalDescription"
],
"type": "object",
"properties": {
"planElementCompositionId": {
"type": "integer",
"description": "ID of the Chiron plan element composition where this goal was originally recorded",
"format": "int64"
},
"goalUid": {
"type": "string",
"description": "Persistent UID of the goal",
"format": "uuid"
},
"classificationName": {
"type": "string",
"description": "Classification of the problem of this goal at the moment the report was created"
},
"problemDescription": {
"type": "string",
"description": "Description of the problem of this goal at the moment the report was created"
},
"goalDescription": {
"type": "string",
"description": "Description of the goal"
}
},
"description": "Goal linked to this report",
"example": {
"planElementCompositionId": 20,
"goalUid": "e45cc577-bd8d-42d0-b5ea-aa2eb0de5721",
"classificationName": "S",
"problemDescription": "Hungry",
"goalDescription": "Eat"
}
},
"dossier.ReportReactionViewModel": {
"title": "ReportReactionViewModel",
"required": [
"id",
"reportedAt",
"status",
"authorName",
"authorType"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the reaction",
"format": "int64",
"nullable": false
},
"reportedAt": {
"type": "string",
"description": "Timestamp of the reaction. It is usually time when the reaction was created but it can be set when reaction is created.\n",
"format": "date-time",
"nullable": false
},
"comment": {
"type": "string",
"description": "Text comment on the report",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/dossier.ReportStatus"
},
"authorName": {
"type": "string",
"description": "Name of the author of the reaction. Can be a name of the employee who created the reaction or a name of Caren user.",
"nullable": false
},
"authorType": {
"$ref": "#/components/schemas/dossier.ReportAuthorType"
},
"authorId": {
"type": "integer",
"description": "ID of the report author, can be an ID of an employee or ID of a user in Caren. It can also be empty in\ncase of external authors\n",
"format": "int64",
"nullable": true
},
"authorRole": {
"type": "string",
"description": "Role of the report author. This field is used only for caren reports",
"nullable": true
},
"authorExpertiseProfileId": {
"type": "integer",
"description": "ID of author's expertise (education) profile at the time of report creation.\n\nThis field is empty for caren reports or when employee did not have any expertise profile assigned.\n",
"format": "int64",
"nullable": true
},
"authorExpertiseProfileName": {
"type": "string",
"description": "Name of author's expertise (education) profile at the time of report creation.\n\nThis field is empty for caren reports or when employee did not have any expertise profile assigned.\n",
"nullable": true
}
},
"description": "Describes a single reaction to the report",
"example": {
"id": 1,
"reportedAt": "2014-04-01T17:00:00.000+02:00",
"status": 1,
"authorName": "John",
"authorType": "employee"
}
},
"dossier.ReportVitalSignList": {
"title": "VitalSignsReports",
"type": "object",
"properties": {
"systolic": {
"$ref": "#/components/schemas/dossier.ReportVitalSign"
},
"diastolic": {
"$ref": "#/components/schemas/dossier.ReportVitalSign"
},
"pulse": {
"$ref": "#/components/schemas/dossier.ReportVitalSign"
},
"temperature": {
"$ref": "#/components/schemas/dossier.ReportVitalSign"
},
"saturation": {
"$ref": "#/components/schemas/dossier.ReportVitalSign"
}
},
"description": "List of vital signs",
"example": {
"systolic": {
"id": "systolic_blood_pressure",
"measuredAt": "2014-07-24T02:00:00.000+02:00",
"unit": "mm[Hg]",
"type": "Systolisch",
"value": "55"
},
"diastolic": {
"id": "diastolic_blood_pressure",
"measuredAt": "2014-07-24T02:00:00.000+02:00",
"unit": "mm[Hg]",
"type": "Diastolisch",
"value": "55"
},
"pulse": {
"id": "pulse",
"measuredAt": "2014-07-24T02:00:00.000+02:00",
"unit": "/min",
"type": "Frequentie",
"value": "55"
},
"temperature": {
"id": "body_temperature",
"measuredAt": "2014-07-24T02:00:00.000+02:00",
"unit": "Cek",
"type": "Temperatuur",
"value": "55"
},
"saturation": {
"id": "body_saturation",
"measuredAt": "2014-07-24T02:00:00.000+02:00",
"unit": "%",
"type": "Saturatie",
"value": "55"
}
}
},
"dossier.ReportVitalSign": {
"title": "ReportVitalSign",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "generic name of vital sign",
"nullable": true
},
"measuredAt": {
"type": "string",
"description": "Time when vital sign was measured.",
"format": "date-time",
"nullable": true
},
"unit": {
"type": "string",
"description": "unit of measurement",
"nullable": true
},
"type": {
"type": "string",
"description": "Vital sign name",
"nullable": true
},
"value": {
"type": "string",
"description": "value of vital sign",
"nullable": true
}
},
"description": "Vital sign from a report",
"example": {
"id": "systolic_blood_pressure",
"measuredAt": "2014-07-24T02:00:00.000+02:00",
"unit": "mm[Hg]",
"type": "Systolisch",
"value": "55"
}
},
"dossier.ReportsWithActionsSummary": {
"type": "object",
"properties": {
"actionsForUser": {
"type": "integer",
"format": "int64"
},
"actionsByUser": {
"type": "integer",
"format": "int64"
}
},
"description": "ReportsWithActionsSummary model (no description)",
"example": {
"actionsForUser": 42,
"actionsByUser": 87
}
},
"dossier.list.ActionEntrySummaryList": {
"type": "object",
"properties": {
"actionEntrySummaries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.ActionEntrySummary"
},
"nullable": true
}
},
"description": "ActionEntrySummaryList model (no description)",
"example": {
"actionEntrySummaries": [
{
"id": 10561,
"comment": "Gebruik van hulpmiddelen aanleren; rollator les bij ergo"
},
{
"id": 10562,
"comment": "Conditie verbeteren door dagelijks 3 maal 15 minuten oefenen achter rollator"
}
]
}
},
"dossier.ActionEntrySummary": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"nullable": true,
"x-cupido-id": true
},
"carePlanPersistentActionId": {
"type": "integer",
"description": "The care plan persistent action id of this action entry",
"format": "int64",
"nullable": true
},
"comment": {
"type": "string",
"nullable": true
},
"actionName": {
"type": "string",
"nullable": true
},
"goalName": {
"type": "string",
"nullable": true
},
"demandName": {
"type": "string",
"nullable": true
},
"domainName": {
"type": "string",
"nullable": true
}
},
"description": "Summary of a Zorgplan \"actie\" entry",
"example": {
"id": 1,
"carePlanPersistentActionId": 4,
"comment": "commentaar",
"actionName": "action",
"goalName": "goal",
"demandName": "demand",
"domainName": "domain"
}
},
"dossier.list.AlertList": {
"type": "object",
"properties": {
"alerts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.Alert"
}
}
},
"description": "List of Alerts",
"example": {
"alerts": [
{
"id": 1,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 4,
"createdById": 1,
"updatedById": 1,
"createdAt": "2020-11-10T12:00:00.000+01:00",
"updatedAt": "2020-11-10T12:00:00.000+01:00",
"name": "MRSA",
"type": "Agressie",
"icon": "virus",
"iconUrl": "http://www.example.com",
"iconPngUrl": "http://www.example.com",
"protocol": "http://www.example.com",
"description": "Some additional text",
"beginDate": "2021-01-01",
"endDate": "2021-02-06",
"active": true,
"topicId": 1,
"authorizedExpertiseProfileIds": [
1,
2
],
"authorizedExpertiseGroupIds": [
3,
4
],
"encodings": [
{
"code": "61372001",
"codeSystem": "SNOMED CT",
"displayName": "aggression"
}
],
"feederAuditContentStore": "ons_ketenverkeer",
"feederAuditContentId": "abz123",
"feederAuditSenderName": "Some care organisation",
"feederAuditTransferType": "eoverdracht_nursing"
},
{
"id": 2,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 4,
"createdById": 1,
"updatedById": 1,
"createdAt": "2020-11-10T12:00:00.000+01:00",
"updatedAt": "2020-11-10T12:00:00.000+01:00",
"name": "MRSA",
"type": "Agressie",
"icon": "virus",
"iconUrl": "http://www.example.com",
"iconPngUrl": "http://www.example.com",
"protocol": "http://www.example.com",
"description": "Some additional text",
"beginDate": "2021-01-01",
"endDate": "2021-02-06",
"active": true,
"topicId": 1,
"authorizedExpertiseProfileIds": [
1,
2
],
"authorizedExpertiseGroupIds": [
3,
4
],
"encodings": [
{
"code": "61372001",
"codeSystem": "SNOMED CT",
"displayName": "aggression"
}
],
"feederAuditContentStore": "ons_ketenverkeer",
"feederAuditContentId": "abz123",
"feederAuditSenderName": "Some care organisation",
"feederAuditTransferType": "eoverdracht_nursing"
}
]
}
},
"dossier.CarePlanAgreement": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"nullable": true,
"x-cupido-id": true
},
"carePlanId": {
"type": "integer",
"description": "The care plan this agreement belongs to",
"format": "int64",
"nullable": true
},
"employeeId": {
"type": "integer",
"description": "The employee that created the agreement",
"format": "int64",
"nullable": true
},
"clientId": {
"type": "integer",
"description": "The client the care plan belongs to",
"format": "int64",
"nullable": true
}
},
"description": "CarePlanAgreement model (no description)",
"example": {
"updatedAt": "2016-09-05T12:59:26.000+02:00",
"createdAt": "2016-09-05T12:59:26.000+02:00",
"createdBy": "administrator",
"id": 3,
"carePlanId": 12,
"employeeId": 13,
"clientId": 14
}
},
"dossier.CarePlanSignatureRequirement": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"nullable": true,
"x-cupido-id": true
},
"carePlanId": {
"type": "integer",
"description": "The care plan this signature requirement belongs to",
"format": "int64",
"nullable": true
},
"comment": {
"type": "string",
"description": "The comment for this signature requirement. When discussionType is 'no_discussion' or 'no_agreement', this field should explain why no discussion took place or why no agreement was reached.",
"nullable": true
},
"discussionType": {
"$ref": "#/components/schemas/dossier.CarePlanSignatureRequirementDiscussionType"
},
"required": {
"type": "boolean",
"description": "Whether or not a signature is required for the care plan",
"nullable": true
}
},
"description": "CarePlanSignatureRequirement model (no description)",
"example": {
"updatedAt": "2016-09-05T12:59:26.000+02:00",
"createdAt": "2016-09-05T12:59:26.000+02:00",
"createdBy": "10",
"id": 171,
"carePlanId": 150,
"comment": "Signature requirement comment",
"discussionType": "discussed",
"required": true
}
},
"dossier.CarePlanSignatureRequirementDiscussionType": {
"enum": [
"discussed",
"discussed_later",
"no_discussion",
"no_agreement"
],
"type": "string",
"description": "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 indicates the discussion status. Values:\n- discussed: has been discussed with the client/representative and they agree\n- discussed_later: will be discussed with the client/representative later\n- no_discussion: will not be discussed with the client/representative\n- no_agreement: has not been agreed upon by client/representative\n",
"nullable": true,
"example": "discussed"
},
"dossier.list.RestrictiveMeasureRegistrationList": {
"type": "object",
"properties": {
"restrictiveMeasureRegistrations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.RestrictiveMeasureRegistration"
},
"nullable": true
}
},
"description": "RestrictiveMeasureRegistrationList model (no description)",
"example": {
"restrictiveMeasureRegistrations": [
{
"id": 1,
"restrictiveMeasureEntryId": 2,
"restrictiveMeasureId": 3,
"law": 1,
"narrative": "narrative",
"resistant": false,
"clientExternalId": 4,
"legalTitle": "crisis_measure",
"startTime": "2021-01-01T00:00:00.000+01:00",
"endTime": "2021-01-02T00:00:00.000+01:00",
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00"
},
{
"id": 1,
"restrictiveMeasureEntryId": 2,
"restrictiveMeasureId": 3,
"law": 1,
"narrative": "narrative",
"resistant": false,
"clientExternalId": 4,
"legalTitle": "crisis_measure",
"startTime": "2021-01-01T00:00:00.000+01:00",
"endTime": "2021-01-02T00:00:00.000+01:00",
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00"
}
]
}
},
"dossier.list.RestrictiveMeasureCarePlanEntryList": {
"type": "object",
"properties": {
"restrictiveMeasureCarePlanEntries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.RestrictiveMeasureCarePlanEntry"
},
"nullable": true
}
},
"description": "RestrictiveMeasureCarePlanEntryList model (no description)",
"example": {
"restrictiveMeasureCarePlanEntries": [
{
"id": 1,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 1,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"situation": "in careplan",
"typeCompetent": true,
"typeAgreement": true,
"typeResistant": true,
"decisionNarrative": "Decision narrative",
"inspectionReportDate": "2015-09-17",
"status": "active",
"problemNarrative": "Problem narrative",
"goalNarrative": "Problem narrative",
"beginDate": "2015-09-17",
"endDate": "2015-09-17",
"nextEvaluationDate": "2015-09-17",
"risksNarrative": "Risks narrative",
"guaranteeNarrative": "Guarantee narrative",
"reductionNarrative": "Reduction narrative",
"proportionality": "Proportionality",
"subsidiarity": "Subsidiarity",
"effectiveness": "Effectiveness",
"secondOpinion": "Second opinion",
"reasonNarrative": "Reason narrative",
"researchDate": "2015-10-17",
"safety": "Safety",
"gdConferDate": "2015-10-16",
"combinedConditions": "Combined conditions",
"evaluationNote": "Evaluation note"
},
{
"id": 1,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 1,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"situation": "in careplan",
"typeCompetent": true,
"typeAgreement": true,
"typeResistant": true,
"decisionNarrative": "Decision narrative",
"inspectionReportDate": "2015-09-17",
"status": "active",
"problemNarrative": "Problem narrative",
"goalNarrative": "Problem narrative",
"beginDate": "2015-09-17",
"endDate": "2015-09-17",
"nextEvaluationDate": "2015-09-17",
"risksNarrative": "Risks narrative",
"guaranteeNarrative": "Guarantee narrative",
"reductionNarrative": "Reduction narrative",
"proportionality": "Proportionality",
"subsidiarity": "Subsidiarity",
"effectiveness": "Effectiveness",
"secondOpinion": "Second opinion",
"reasonNarrative": "Reason narrative",
"researchDate": "2015-10-17",
"safety": "Safety",
"gdConferDate": "2015-10-16",
"combinedConditions": "Combined conditions",
"evaluationNote": "Evaluation note"
}
]
}
},
"dossier.medical.advance_directives.list.ContextList": {
"type": "object",
"properties": {
"contexts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.advance_directives.Context"
}
}
},
"description": "ContextList model (no description)",
"example": {
"contexts": [
{
"id": 3,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 1,
"createdById": 2,
"updatedById": 4,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"narrative": "Thats what I want",
"snomedExpressionValue": "Dummy",
"date": "2014-11-14",
"employeeId": 1337,
"status": "Discussed with patient",
"immutable": true
}
]
}
},
"dossier.medical.dsm.list.ClassificationSeriesList": {
"type": "object",
"properties": {
"classificationSeriesList": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.dsm.ClassificationSeries"
}
],
"xml": {
"name": "classificationSeries"
}
}
}
},
"description": "ClassificationSeriesList model (no description)",
"example": {
"classificationSeriesList": [
{
"id": 1,
"uuid": "a72ec22c-faca-43c6-86ec-28ff0e1ddba4",
"clientId": 8,
"createdById": 1,
"updatedById": 1,
"createdAt": "2016-10-24T18:55:45.000+02:00",
"updatedAt": "2016-10-24T18:55:45.000+02:00",
"dsmType": "DSM-IV",
"financeId": 655,
"financeType": "Cupido::Finance::CareOrder",
"psychiatricCareType": "basic"
},
{
"id": 2,
"uuid": "a72ec22c-faca-43c6-86ec-28ff0e1ddba4",
"clientId": 8,
"createdById": 1,
"updatedById": 1,
"createdAt": "2016-10-24T18:55:45.000+02:00",
"updatedAt": "2016-10-24T18:55:45.000+02:00",
"dsmType": "DSM-V",
"financeId": 455,
"financeType": "Cupido::Dbc::Ggz::Zorgtraject",
"psychiatricCareType": "specialistic"
}
]
},
"xml": {
"name": "classificationSeriesList"
}
},
"dossier.medical.involuntary_care.list.LegalStatusList": {
"type": "object",
"properties": {
"legalStatuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.involuntary_care.LegalStatus"
}
}
},
"description": "LegalStatusList model (no description)",
"example": {
"legalStatuses": [
{
"id": 1,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 2,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"status": "Artikel 60 Bopz-indicatie",
"code": "sapc",
"beginDate": "2015-09-17",
"endDate": "2015-09-27",
"expirationDate": "2015-09-28",
"comments": "5 weeks until renewal",
"endingReason": "Client is better again",
"documentId": 1,
"documentName": "artikel60.pdf",
"archived": false,
"request": false,
"legalStatusDocuments": [
{
"documentId": 1,
"documentName": "artikel60.pdf"
}
],
"legalStatusSuspensions": [
{
"id": 1,
"beginDate": "2021-09-01",
"endDate": "2021-09-02",
"comments": "What the judge told",
"type": "withdraw_involuntary_care",
"createdById": 1,
"updatedById": 1,
"createdAt": "2020-11-14T00:00:00.000+01:00",
"updatedAt": "2020-11-14T00:00:00.000+01:00",
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51d"
}
],
"legalGrounds": [
{
"beginDate": "2015-09-25",
"endDate": "2015-09-26",
"comments": "Important side node",
"categoryCode": "wvggz_inclosure_other"
}
]
}
]
}
},
"dossier.episodes.list.ActionList": {
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.episodes.Action"
}
}
},
"description": "ActionList model (no description)",
"example": {
"actions": [
{
"updatedAt": "2017-11-27T00:00:00.000+01:00",
"createdAt": "2017-11-27T00:00:00.000+01:00",
"createdBy": "Dummy",
"id": 3,
"title": "Some action",
"subGoalId": 2,
"showInCarePlan": true,
"archived": false
},
{
"updatedAt": "2017-11-27T00:00:00.000+01:00",
"createdAt": "2017-11-27T00:00:00.000+01:00",
"createdBy": "Dummy",
"id": 55,
"title": "Some archived action",
"subGoalId": 90,
"showInCarePlan": false,
"archived": true
}
]
}
},
"dossier.episodes.list.EpisodeList": {
"type": "object",
"properties": {
"episodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.episodes.Episode"
}
}
},
"description": "EpisodeList model (no description)",
"example": {
"episodes": [
{
"updatedAt": "2017-11-27T00:00:00.000+01:00",
"createdAt": "2017-11-27T00:00:00.000+01:00",
"createdBy": "Some Employee",
"id": 1,
"clientId": 1,
"startDate": "2017-11-27",
"endDate": "2017-11-27",
"evaluationDate": "2017-11-27",
"goal": "Some Goal",
"title": "awesome episode",
"important": false,
"marked": false
},
{
"updatedAt": "2017-11-26T00:00:00.000+01:00",
"createdAt": "2017-11-26T00:00:00.000+01:00",
"createdBy": "Some Employee",
"id": 2,
"clientId": 2,
"startDate": "2017-11-26",
"endDate": "2017-11-26",
"evaluationDate": "2017-11-26",
"goal": "Another Goal",
"title": "even more awesome episode",
"important": false,
"marked": false
}
]
}
},
"dossier.episodes.list.SubGoalList": {
"type": "object",
"properties": {
"subGoals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.episodes.SubGoal"
}
}
},
"description": "SubGoalList model (no description)",
"example": {
"subGoals": [
{
"updatedAt": "2017-11-27T00:00:00.000+01:00",
"createdAt": "2017-11-27T00:00:00.000+01:00",
"createdBy": "Dummy",
"id": 2,
"title": "Some sub goal",
"episodeId": 1,
"archived": false
},
{
"updatedAt": "2017-11-27T00:00:00.000+01:00",
"createdAt": "2017-11-27T00:00:00.000+01:00",
"createdBy": "Dummy",
"id": 5,
"title": "Some archived sub goal",
"episodeId": 22,
"archived": true
}
]
}
},
"dossier.list.InvoluntaryCareExportEntryList": {
"type": "object",
"properties": {
"involuntaryCareExportEntries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.InvoluntaryCareExportEntry"
}
}
},
"description": "InvoluntaryCareExportEntryList model (no description)",
"example": {
"involuntaryCareExportEntries": [
{
"sourceId": 1,
"sourceType": "registration",
"clientExternalId": 2,
"locationId": 3,
"locationNumber": "03030303",
"careType": 1,
"interventionType": "010101",
"legalSituation": "RM",
"beginSelfBinding": "2021-01-01",
"endSelfBinding": "2021-12-31",
"beginDate": "2021-02-01T01:01:00.000+01:00",
"endDate": "2021-03-01T02:02:00.000+01:00",
"durationAmount": 4,
"frequencyAmount": 5,
"frequencyUnit": 1,
"ambulatory": false
},
{
"sourceId": 1,
"sourceType": "registration",
"clientExternalId": 2,
"locationId": 3,
"locationNumber": "03030303",
"careType": 1,
"interventionType": "010101",
"legalSituation": "RM",
"beginSelfBinding": "2021-01-01",
"endSelfBinding": "2021-12-31",
"beginDate": "2021-02-01T01:01:00.000+01:00",
"endDate": "2021-03-01T02:02:00.000+01:00",
"durationAmount": 4,
"frequencyAmount": 5,
"frequencyUnit": 1,
"ambulatory": false
}
]
}
},
"dossier.InvoluntaryCareExportEntry": {
"type": "object",
"properties": {
"sourceId": {
"type": "integer",
"description": "The id of the source object for this export entry. It is not unique, because a single source can generate multiple export entries",
"format": "int64"
},
"sourceType": {
"type": "string",
"description": "The type of source this export entry was generated from, possible values:\n- registration\n- care_plan_entry"
},
"clientExternalId": {
"type": "integer",
"description": "The id of the client this export entry is linked to",
"format": "int64"
},
"locationId": {
"type": "integer",
"description": "The location this measure was applied",
"format": "int64"
},
"locationNumber": {
"type": "string",
"description": "The KvK vestigingsnummer for the location this export entry was linked to"
},
"careType": {
"type": "integer",
"description": "Optional in case of Wzd and JzPlus, the type of care:\n- 1 structural and plannable\n- 2 structural not plannable\n- 3 unforseen",
"format": "int32"
},
"interventionType": {
"type": "string",
"description": "The type of involuntary care that was applied, possible values depend on the law and can be found in the ZIB that defines it:\nFor Wzd Measures https://zibs.nl/wiki/VrijheidsbeperkendeInterventie-v1.0(2020NL)#SoortInterventieWzdCodelijst\nFor Wvggz Measures https://zibs.nl/wiki/VrijheidsbeperkendeInterventie-v1.0(2020NL)#SoortInterventieWvggzCodelijst"
},
"legalSituation": {
"type": "string",
"description": "The legal situation of the client, possible values from the ZIB: https://zibs.nl/wiki/JuridischeSituatie-v2.0(2020NL)"
},
"beginSelfBinding": {
"type": "string",
"description": "Optional, only for Wvggz, the begin date of a self binding declaration",
"format": "date"
},
"endSelfBinding": {
"type": "string",
"description": "Optional, only for Wvggz, the end date of a self binding declaration",
"format": "date"
},
"beginDate": {
"type": "string",
"description": "The begin date of the registration",
"format": "date-time"
},
"endDate": {
"type": "string",
"description": "Optional, the end date of the registration",
"format": "date-time"
},
"durationAmount": {
"type": "integer",
"description": "Deprecated, use durationMinutesAmount which contains the same data but more granular.\nOptional, the average and/or rounded duration of the application of the care",
"format": "int32",
"deprecated": true,
"x-deprecated-since": "01-07-2026"
},
"durationMinutesAmount": {
"type": "integer",
"description": "Optional, duration of the application of care in minutes.",
"format": "int32"
},
"frequencyAmount": {
"type": "integer",
"description": "Optional, the amount of times this measures was applied, goes with frequencyUnit",
"format": "int32"
},
"frequencyUnit": {
"type": "integer",
"description": "Optional, goes with frequencyAmount, possible values;\n- 1 daily\n- 2 weekly\n- 3 monthly\n- 4 yearly",
"format": "int32"
},
"ambulatory": {
"type": "boolean",
"description": "Whether or not the client was in the ambulatory setting when this measure was applied."
}
},
"description": "InvoluntaryCareExportEntry model (no description)",
"example": {
"sourceId": 1,
"sourceType": "registration",
"clientExternalId": 2,
"locationId": 3,
"locationNumber": "03030303",
"careType": 1,
"interventionType": "010101",
"legalSituation": "RM",
"beginSelfBinding": "2021-01-01",
"endSelfBinding": "2021-12-31",
"beginDate": "2021-02-01T01:01:00.000+01:00",
"endDate": "2021-03-01T02:02:00.000+01:00",
"durationAmount": 4,
"durationMinutesAmount": 240,
"frequencyAmount": 5,
"frequencyUnit": 1,
"ambulatory": false
}
},
"dossier.medical.dsm.list.ClassificationList": {
"type": "object",
"properties": {
"classifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.dsm.Classification"
}
}
},
"description": "ClassificationList model (no description)",
"example": {
"classifications": [
{
"id": 5,
"uuid": "9ee1eb44-a89f-4fb6-bb29-ff39bfeef98e",
"clientId": 8,
"createdById": 1,
"updatedById": 1,
"createdAt": "2016-10-26T19:39:33.000+02:00",
"updatedAt": "2016-10-26T19:39:33.000+02:00",
"findings": [
{
"id": 9,
"uuid": "dbff59ee-4ec0-40bf-bdab-8ee8f29a83f4",
"clientId": 8,
"createdById": 1,
"updatedById": 1,
"createdAt": "2016-10-26T19:39:33.000+02:00",
"updatedAt": "2016-10-26T19:39:33.000+02:00",
"axis": 1,
"signsOf": false,
"mainDiagnosis": true,
"compoundCode": "2016-01-01|as1_10.02|0",
"dsmType": "DSM-IV",
"description": "Dissociatieve fugue"
},
{
"id": 10,
"uuid": "99db4e0f-0d7a-4c68-9f01-a38a7c30d11b",
"clientId": 8,
"createdById": 1,
"updatedById": 1,
"createdAt": "2016-10-26T19:39:33.000+02:00",
"updatedAt": "2016-10-26T19:39:33.000+02:00",
"axis": 2,
"signsOf": true,
"mainDiagnosis": false,
"compoundCode": "2016-01-01|as2_17.01|0",
"dsmType": "DSM-IV",
"description": "Zwakbegaafdheid"
}
],
"evaluations": [
{
"id": 1,
"uuid": "46b414fb-576c-4a5b-890e-0e7e058b4a72",
"clientId": 8,
"createdById": 1,
"updatedById": 1,
"createdAt": "2016-10-26T19:39:42.000+02:00",
"updatedAt": "2016-10-26T19:39:42.000+02:00",
"evaluationText": "Dit is een evaluatie",
"newDraft": false
}
],
"beginDate": "2016-10-26",
"endDate": "2016-10-26",
"classificationDate": "2016-10-26",
"status": "treatment_active",
"diagnosisDescription": "This is the descriptive diagnosis",
"parentId": 2,
"childId": 3,
"immutable": true,
"axis3weight": 1,
"gafStart": 51,
"gafCurrent": 61,
"gafMax": 71,
"gafEnd": 81,
"classificationSeriesId": 1
}
]
}
},
"dossier.medical.list.MedicalSummaryList": {
"type": "object",
"properties": {
"medicalSummaries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.MedicalSummary"
}
}
},
"description": "MedicalSummaryList model (no description)",
"example": {
"medicalSummaries": [
{
"clientId": 200,
"legalStatus": {
"id": 1,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 2,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"status": "Artikel 60 Bopz-indicatie",
"code": "sapc",
"beginDate": "2015-09-17",
"endDate": "2015-09-27",
"comments": "5 weeks until renewal",
"documentId": 1,
"documentName": "artikel60.pdf",
"archived": false,
"request": false,
"legalStatusDocuments": [
{
"documentId": 1,
"documentName": "artikel60.pdf"
}
]
},
"legalStatuses": [
{
"id": 1,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 2,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"status": "Artikel 60 Bopz-indicatie",
"code": "sapc",
"beginDate": "2015-09-17",
"endDate": "2015-09-27",
"expirationDate": "2015-09-28",
"comments": "5 weeks until renewal",
"endingReason": "Client is better again",
"documentId": 1,
"documentName": "artikel60.pdf",
"archived": false,
"request": false,
"legalStatusDocuments": [
{
"documentId": 1,
"documentName": "artikel60.pdf"
}
],
"legalStatusSuspensions": [
{
"id": 1,
"beginDate": "2021-09-01",
"endDate": "2021-09-02",
"comments": "What the judge told",
"type": "withdraw_involuntary_care",
"createdById": 1,
"updatedById": 1,
"createdAt": "2020-11-14T00:00:00.000+01:00",
"updatedAt": "2020-11-14T00:00:00.000+01:00",
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51d"
}
],
"legalGrounds": [
{
"beginDate": "2015-09-25",
"endDate": "2015-09-26",
"comments": "Important side node",
"categoryCode": "wvggz_inclosure_other"
}
]
}
],
"medicalNotes": [
{
"id": 10,
"clientId": 1337,
"authorId": 10,
"updatedByAuthorId": 10,
"content": "Medical note",
"visibleOnWorksheet": false,
"deleted": false,
"updatedAt": "2024-08-04T11:11:11.000+02:00",
"createdAt": "2022-12-02T09:50:57.779+01:00"
}
]
},
{
"clientId": 300,
"legalStatus": {
"id": 1,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 2,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"status": "Artikel 60 Bopz-indicatie",
"code": "sapc",
"beginDate": "2015-09-17",
"endDate": "2015-09-27",
"comments": "5 weeks until renewal",
"documentId": 1,
"documentName": "bopz.pdf",
"archived": false,
"legalStatusDocuments": [
{
"documentId": 1,
"documentName": "artikel60.pdf"
}
]
},
"legalStatuses": [
{
"id": 1,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 2,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"status": "Artikel 60 Bopz-indicatie",
"code": "sapc",
"beginDate": "2015-09-17",
"endDate": "2015-09-27",
"expirationDate": "2015-09-28",
"comments": "5 weeks until renewal",
"endingReason": "Client is better again",
"documentId": 1,
"documentName": "artikel60.pdf",
"archived": false,
"request": false,
"legalStatusDocuments": [
{
"documentId": 1,
"documentName": "artikel60.pdf"
}
],
"legalStatusSuspensions": [
{
"id": 1,
"beginDate": "2021-09-01",
"endDate": "2021-09-02",
"comments": "What the judge told",
"type": "withdraw_involuntary_care",
"createdById": 1,
"updatedById": 1,
"createdAt": "2020-11-14T00:00:00.000+01:00",
"updatedAt": "2020-11-14T00:00:00.000+01:00",
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51d"
}
],
"legalGrounds": [
{
"beginDate": "2015-09-25",
"endDate": "2015-09-26",
"comments": "Important side node",
"categoryCode": "wvggz_inclosure_other"
}
]
}
]
}
]
}
},
"dossier.medical.MedicalSummary": {
"type": "object",
"properties": {
"clientId": {
"type": "integer",
"description": "The ID of the client the medical summary belongs to",
"format": "int64"
},
"legalStatus": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.involuntary_care.LegalStatus"
}
],
"description": "Deprecated since 2024-05 use legalStatuses instead, it contains this single Legal Status as well - The current legal status of the client",
"deprecated": true
},
"legalStatuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.involuntary_care.LegalStatus"
},
"description": "The list of current legal statuses of the client. Current Legal Statuses have an overlapping date range with 'today', are not archived, and do not have the 'request' flag set."
},
"medicalPolicy": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.advance_directives.Context"
}
],
"description": "The current medical policy of the client"
},
"resuscitationDecision": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.advance_directives.ResuscitationDecision"
}
],
"description": "The current resuscitation decision for the client\n\nPossible values:\n0 = NO\n1 = YES\n2 = UNKNOWN\n
"
},
"problems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.Problem"
},
"description": "A list of medical problems for this client"
},
"adverseReactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.PropensityToAdverseReaction"
},
"description": "A list of adverse reactions for this client"
},
"simplifiedAdverseReactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.SimplifiedPropensityToAdverseReaction"
},
"description": "A list of simplified propensities to adverse reactions (suspicions) for this client"
},
"allergies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.PropensityToAdverseReaction"
},
"description": "A list of allergies for this client"
},
"incompetences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.medical.involuntary_care.Incompetence"
},
"description": "A list of incompetences for this client"
},
"episodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.episodes.Episode"
},
"description": "A list of episodes for this client"
},
"alerts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.Alert"
},
"description": "A list of alerts for this client"
},
"medicalNotes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/dossier.MedicalNote"
},
"description": "A list of medical notes for this client"
},
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/dossier.medical.MedicalSummaryMetadata"
}
],
"description": "Metadata for the medical summary"
}
},
"description": "MedicalSummary model (no description)",
"example": {
"clientId": 200,
"legalStatus": {
"id": 1,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 2,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"status": "Artikel 60 Bopz-indicatie",
"code": "sapc",
"beginDate": "2015-09-17",
"endDate": "2015-09-27",
"comments": "5 weeks until renewal",
"documentId": 1,
"documentName": "artikel60.pdf",
"archived": false,
"request": false,
"legalStatusDocuments": [
{
"documentId": 1,
"documentName": "artikel60.pdf"
}
]
},
"legalStatuses": [
{
"id": 1,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 2,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"status": "Artikel 60 Bopz-indicatie",
"code": "sapc",
"beginDate": "2015-09-17",
"endDate": "2015-09-27",
"expirationDate": "2015-09-28",
"comments": "5 weeks until renewal",
"endingReason": "Client is better again",
"documentId": 1,
"documentName": "artikel60.pdf",
"archived": false,
"request": false,
"legalStatusDocuments": [
{
"documentId": 1,
"documentName": "artikel60.pdf"
}
],
"legalStatusSuspensions": [
{
"id": 1,
"beginDate": "2021-09-01",
"endDate": "2021-09-02",
"comments": "What the judge told",
"type": "withdraw_involuntary_care",
"createdById": 1,
"updatedById": 1,
"createdAt": "2020-11-14T00:00:00.000+01:00",
"updatedAt": "2020-11-14T00:00:00.000+01:00",
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51d"
}
],
"legalGrounds": [
{
"beginDate": "2015-09-25",
"endDate": "2015-09-26",
"comments": "Important side node",
"categoryCode": "wvggz_inclosure_other"
}
]
}
],
"medicalPolicy": {
"id": 3,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 1,
"createdById": 2,
"updatedById": 4,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"narrative": "Thats what I want",
"snomedExpressionValue": "Dummy",
"date": "2014-11-14",
"employeeId": 1337,
"status": "Discussed with patient",
"documentId": 1,
"documentName": "Document",
"decisions": [
{
"name": "Resuscitation",
"outcome": "Yes"
}
]
},
"resuscitationDecision": 1,
"problems": [
{
"id": 1,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 2,
"createdById": 3,
"updatedById": 1,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"narrative": "It hurts",
"starred": true,
"onsetApproximateDate": "2014",
"resolvedApproximateDate": "2014-12",
"snomedExpressionValue": "22298006 | Myocardial infarction (disorder) |",
"active": true,
"relevant": true,
"certainty": "Ik ben er niet zo zeker van",
"severity": "Niet levensbedreigend",
"course": "De afgelopen twee weken",
"onsetPeriodOfLife": "Vanaf kleuterperiode",
"expertiseProfileIds": [
1,
2
],
"episodeId": 1
}
],
"adverseReactions": [
{
"id": 5,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 4,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-10T12:00:00.000+01:00",
"updatedAt": "2014-11-10T12:00:00.000+01:00",
"causeBuilders": [
{
"system": "CUSTOM",
"query": "Stofmijt"
},
{
"system": "SNOMED",
"query": "256259004 | pollen |",
"name": "Pollen"
}
],
"cause": "Haar van dieren",
"manifestations": [
"Diarree",
"Misselijkheid",
"Duizeligheid"
],
"active": true,
"specification": "Specificatie",
"narrative": "Het doet zeer",
"certainty": "Ik ben er niet zo zeker van",
"severity": "Niet levensbedreigend",
"course": "De afgelopen twee weken",
"onsetPeriodOfLife": "Vanaf kleuterperiode",
"onsetApproximateDate": "2014"
}
],
"simplifiedAdverseReactions": [
{
"id": 5,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 4,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-10T12:00:00.000+01:00",
"updatedAt": "2014-11-10T12:00:00.000+01:00",
"causeBuilders": [
{
"system": "CUSTOM",
"query": "Stofmijt"
},
{
"system": "SNOMED",
"query": "256259004 | pollen |",
"name": "Pollen"
}
],
"causes": [
"Diarree",
"Misselijkheid",
"Duizeligheid"
]
}
],
"allergies": [
{
"id": 5,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 4,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-10T12:00:00.000+01:00",
"updatedAt": "2014-11-10T12:00:00.000+01:00",
"causeBuilders": [
{
"system": "CUSTOM",
"query": "Stofmijt"
},
{
"system": "SNOMED",
"query": "256259004 | pollen |",
"name": "Pollen"
}
],
"cause": "Haar van dieren",
"manifestations": [
"Diarree",
"Misselijkheid",
"Duizeligheid"
],
"active": true,
"specification": "Specificatie",
"narrative": "Het doet zeer",
"certainty": "Ik ben er niet zo zeker van",
"severity": "Niet levensbedreigend",
"course": "De afgelopen twee weken",
"onsetPeriodOfLife": "Vanaf kleuterperiode",
"onsetApproximateDate": "2014"
}
],
"incompetences": [
{
"id": 1,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 2,
"createdById": 1,
"updatedById": 1,
"createdAt": "2014-11-14T00:00:00.000+01:00",
"updatedAt": "2014-11-14T00:00:00.000+01:00",
"narrative": "I can't do this",
"startDate": "2015-09-17",
"endDate": "2015-09-27",
"snomedExpressionValue": "285033005 | ability to manage medication |",
"decision": "Uitvoeren van gastroscopie"
}
],
"episodes": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"clientId": 1,
"startDate": "2014-12-29",
"endDate": "2014-12-29",
"evaluationDate": "2014-12-29",
"goal": "example",
"title": "example",
"important": true,
"marked": true,
"subGoals": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"title": "example",
"episodeId": 1,
"archived": true,
"actions": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"title": "example",
"subGoalId": 1,
"showInCarePlan": true,
"archived": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"title": "example",
"subGoalId": 1,
"showInCarePlan": true,
"archived": true
}
]
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"title": "example",
"episodeId": 1,
"archived": true,
"actions": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"title": "example",
"subGoalId": 1,
"showInCarePlan": true,
"archived": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"title": "example",
"subGoalId": 1,
"showInCarePlan": true,
"archived": true
}
]
}
],
"problemIds": [
1,
1
],
"surveyResults": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyObjectId": 1,
"clientObjectId": 1,
"employeeObjectId": 1,
"status": "New",
"version": 1,
"title": "example",
"linkedToActiveCarePlan": true,
"isAnyCarePlanUsingThisResult": true,
"duplicateSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"editSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"statusBumpSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"viewSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
],
"groupAnswers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"groupId": 1,
"surveyResultId": 1,
"score": 1,
"importantForCareplan": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"groupId": 1,
"surveyResultId": 1,
"score": 1,
"importantForCareplan": true
}
],
"completedAt": "2014-12-29T00:00:00.000+01:00"
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyObjectId": 1,
"clientObjectId": 1,
"employeeObjectId": 1,
"status": "New",
"version": 1,
"title": "example",
"linkedToActiveCarePlan": true,
"isAnyCarePlanUsingThisResult": true,
"duplicateSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"editSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"statusBumpSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"viewSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
],
"groupAnswers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"groupId": 1,
"surveyResultId": 1,
"score": 1,
"importantForCareplan": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"groupId": 1,
"surveyResultId": 1,
"score": 1,
"importantForCareplan": true
}
],
"completedAt": "2014-12-29T00:00:00.000+01:00"
}
],
"documents": [
{
"id": 1233,
"fileName": "file.pdf"
},
{
"id": 1233,
"fileName": "file.pdf"
}
],
"expertiseProfileIds": [
1,
1
],
"authorizedExpertiseProfileIds": [
1,
1
],
"authorizedExpertiseGroupIds": [
1,
1
],
"linkedExpertiseProfileIds": [
1,
1
],
"linkedExpertiseGroupIds": [
1,
1
]
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"clientId": 1,
"startDate": "2014-12-29",
"endDate": "2014-12-29",
"evaluationDate": "2014-12-29",
"goal": "example",
"title": "example",
"important": true,
"marked": true,
"subGoals": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"title": "example",
"episodeId": 1,
"archived": true,
"actions": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"title": "example",
"subGoalId": 1,
"showInCarePlan": true,
"archived": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"title": "example",
"subGoalId": 1,
"showInCarePlan": true,
"archived": true
}
]
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"title": "example",
"episodeId": 1,
"archived": true,
"actions": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"title": "example",
"subGoalId": 1,
"showInCarePlan": true,
"archived": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"title": "example",
"subGoalId": 1,
"showInCarePlan": true,
"archived": true
}
]
}
],
"problemIds": [
1,
1
],
"surveyResults": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyObjectId": 1,
"clientObjectId": 1,
"employeeObjectId": 1,
"status": "New",
"version": 1,
"title": "example",
"linkedToActiveCarePlan": true,
"isAnyCarePlanUsingThisResult": true,
"duplicateSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"editSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"statusBumpSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"viewSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
],
"groupAnswers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"groupId": 1,
"surveyResultId": 1,
"score": 1,
"importantForCareplan": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"groupId": 1,
"surveyResultId": 1,
"score": 1,
"importantForCareplan": true
}
],
"completedAt": "2014-12-29T00:00:00.000+01:00"
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyObjectId": 1,
"clientObjectId": 1,
"employeeObjectId": 1,
"status": "New",
"version": 1,
"title": "example",
"linkedToActiveCarePlan": true,
"isAnyCarePlanUsingThisResult": true,
"duplicateSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"editSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"statusBumpSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"viewSurveyResultAbility": {
"enabled": true,
"possible": true,
"message": "example"
},
"answers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"surveyResultObjectId": 1,
"questionObjectId": 1,
"answerDefinitionObjectId": 1,
"text": "example",
"important": true,
"booleanAnswer": true
}
],
"groupAnswers": [
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"groupId": 1,
"surveyResultId": 1,
"score": 1,
"importantForCareplan": true
},
{
"updatedAt": "2014-12-29T00:00:00.000+01:00",
"createdAt": "2014-12-29T00:00:00.000+01:00",
"createdBy": "example",
"id": 1,
"groupId": 1,
"surveyResultId": 1,
"score": 1,
"importantForCareplan": true
}
],
"completedAt": "2014-12-29T00:00:00.000+01:00"
}
],
"documents": [
{
"id": 1233,
"fileName": "file.pdf"
},
{
"id": 1233,
"fileName": "file.pdf"
}
],
"expertiseProfileIds": [
1,
1
],
"authorizedExpertiseProfileIds": [
1,
1
],
"authorizedExpertiseGroupIds": [
1,
1
],
"linkedExpertiseProfileIds": [
1,
1
],
"linkedExpertiseGroupIds": [
1,
1
]
}
],
"alerts": [
{
"id": 1,
"uuid": "02a26900-64d4-11e4-b4af-0002a5d5c51b",
"clientId": 4,
"createdById": 1,
"updatedById": 1,
"createdAt": "2020-11-10T12:00:00.000+01:00",
"updatedAt": "2020-11-10T12:00:00.000+01:00",
"name": "MRSA",
"type": "Agressie",
"icon": "virus",
"iconUrl": "http://www.example.com",
"iconPngUrl": "http://www.example.com",
"protocol": "http://www.example.com",
"description": "Some additional text",
"beginDate": "2021-01-01",
"endDate": "2021-02-06",
"active": true,
"topicId": 1,
"authorizedExpertiseProfileIds": [
1,
2
],
"authorizedExpertiseGroupIds": [
3,
4
]
}
],
"medicalNotes": [
{
"id": 10,
"clientId": 1337,
"authorId": 10,
"updatedByAuthorId": 10,
"content": "Medical note",
"visibleOnWorksheet": false,
"deleted": false,
"updatedAt": "2024-08-04T11:11:11.000+02:00",
"createdAt": "2022-12-02T09:50:57.779+01:00"
}
],
"metadata": {
"medicalPoliciesPath": "/clients/1/medical/medical_policies"
}
}
},
"dossier.medical.advance_directives.ResuscitationDecision": {
"type": "integer",
"oneOf": [
{
"title": "NO",
"enum": [
0
]
},
{
"title": "YES",
"enum": [
1
]
},
{
"title": "UNKNOWN",
"enum": [
2
]
}
],
"description": "The current resuscitation decision for the client\n\nPossible values:\n0 = NO\n1 = YES\n2 = UNKNOWN\n
",
"example": 0
},
"dossier.medical.MedicalSummaryMetadata": {
"type": "object",
"properties": {
"medicalPoliciesPath": {
"type": "string",
"description": "The path for more details for medical policies. Empty if user is not authorized to access this path"
}
},
"description": "Metadata for the medical summary",
"example": {
"medicalPoliciesPath": "/clients/1/medical/medical_policies"
}
},
"finance.list.DebtorGroupList": {
"type": "object",
"properties": {
"debtorGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/finance.DebtorGroup"
},
"xml": {
"name": "debtorGroup"
}
}
},
"description": "DebtorGroupList model (no description)",
"example": {
"debtorGroups": [
{
"id": 1,
"name": "VGZ",
"description": "Koepel VGZ",
"debtorIds": [
4,
5,
7,
8,
100
]
},
{
"id": 2,
"name": "Achmea",
"description": "Koepel Achmea",
"debtorIds": [
104,
105,
107,
108,
200
]
}
]
},
"xml": {
"name": "debtorGroups"
}
},
"finance.DebtorGroup": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"name": {
"type": "string",
"description": "User provided name"
},
"description": {
"type": "string",
"description": "User provided description"
},
"debtorIds": {
"type": "array",
"items": {
"type": "integer",
"description": "List of configured debtor",
"format": "int64",
"xml": {
"name": "debtorId"
}
},
"description": "List of configured debtor",
"xml": {
"wrapped": true
}
}
},
"description": "DebtorGroup model (no description)",
"example": {
"id": 1,
"name": "VGZ",
"description": "Koepel VGZ",
"debtorIds": [
4,
5,
7,
8,
100
]
},
"xml": {
"name": "debtorGroup"
}
},
"groupcare.list.OccurrenceList": {
"type": "object",
"properties": {
"occurrences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/groupcare.Occurrence"
}
}
},
"description": "OccurrenceList model (no description)",
"example": {
"occurrences": [
{
"id": "1@2016-02-01",
"date": "2016-02-01",
"startTime": "2016-02-01T00:01:00.000+01:00",
"endTime": "2016-02-01T00:02:00.000+01:00",
"groupId": 1,
"groupName": "Name of group",
"locationName": "Name of location",
"locationId": 10,
"registration": "present",
"employeeIds": [
1,
2
],
"recurrenceType": "single",
"recurrenceInterval": 1
}
]
}
},
"groupcare.Occurrence": {
"type": "object",
"properties": {
"id": {
"type": "string",
"x-cupido-id": true
},
"date": {
"type": "string",
"format": "date"
},
"startTime": {
"type": "string",
"format": "date-time"
},
"endTime": {
"type": "string",
"format": "date-time"
},
"groupId": {
"type": "integer",
"format": "int64"
},
"groupName": {
"type": "string"
},
"locationName": {
"type": "string"
},
"locationId": {
"type": "integer",
"format": "int64"
},
"registration": {
"type": "string"
},
"employeeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"recurrenceType": {
"type": "string"
},
"recurrenceInterval": {
"type": "integer",
"format": "int32"
}
},
"description": "Occurrence model (no description)",
"example": {
"id": "1@2016-02-01",
"date": "2016-02-01",
"startTime": "2016-02-01T00:01:00.000+01:00",
"endTime": "2016-02-01T00:02:00.000+01:00",
"groupId": 1,
"groupName": "Name of group",
"locationName": "Name of location",
"locationId": 10,
"registration": "present",
"employeeIds": [
1,
2
],
"recurrenceType": "single",
"recurrenceInterval": 1
}
},
"groupcare.list.GroupList": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/groupcare.Group"
},
"xml": {
"name": "group"
}
}
},
"description": "GroupList model (no description)",
"example": {
"groups": [
{
"id": 1,
"name": "Testgroup",
"startTime": "08:00:00.000",
"endTime": "16:00:00.000",
"minimumCapacity": 0,
"maximumCapacity": 25,
"expiresAfter": "2040-01-01T00:00:00.000+01:00",
"archived": false,
"useLocationAuthorisation": false,
"useAgendaAppointments": false,
"locationId": 10,
"teamId": 8,
"employeeIds": [
10
],
"activityIds": [
1
],
"uuid": "2d8b914f-33e3-4f15-b737-89bb1a58f122",
"monday": false,
"tuesday": false,
"wednesday": false,
"thursday": false,
"friday": false,
"saturday": true,
"sunday": true,
"cycleInterval": 1,
"recurrenceType": "single"
}
]
},
"xml": {
"name": "groups"
}
},
"onsimport.list.RunList": {
"type": "object",
"properties": {
"runs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/onsimport.Run"
},
"xml": {
"name": "run"
}
}
},
"description": "RunList model (no description)",
"example": {
"runs": [
{
"updatedAt": "2020-03-25T00:00:00.000+01:00",
"createdAt": "2020-03-25T00:00:00.000+01:00",
"createdBy": "htaylor",
"id": "runwithme",
"name": "Run With Me",
"autoProcess": true,
"quickMatch": true
}
]
},
"xml": {
"name": "runs"
}
},
"onsimport.RunReport": {
"type": "object",
"properties": {
"reportId": {
"type": "string",
"description": "Unique id for requesting the generated report."
},
"report": {
"type": "string",
"description": "An Excel report for the run.",
"format": "binary"
}
},
"description": "Contains an Excel report for a run.",
"example": {
"reportId": "reportid",
"report": "QWxsIGhvcGUgaXMgbG9zdA=="
}
},
"onsimport.RunStatus": {
"type": "object",
"properties": {
"runId": {
"type": "string",
"description": "Object identifier of the run, usually in the form of a UUID."
},
"processing": {
"type": "boolean",
"description": "Indicates records are still being processed."
},
"statuses": {
"type": "object",
"description": "Map of record status to number of records having that status.\nAlso contains an entry ALL with the total number of records."
},
"fileValidations": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of validation messages resulting from uploading XML.\nThese typically concern invalid XML or XSD violations."
}
},
"description": "Contains status information about a run in Ons Import.",
"example": {
"runId": "runwithme",
"processing": false,
"statuses": {
"all": "1",
"success": "1"
},
"fileValidations": [
"failtorun"
]
}
},
"onsimport.list.UploadInfoList": {
"type": "object",
"properties": {
"uploads": {
"type": "array",
"items": {
"$ref": "#/components/schemas/onsimport.UploadInfo"
}
}
},
"description": "Contains uploaded files for a run in Ons Import.",
"example": {
"uploads": [
{
"runId": "runwithme",
"runName": "Run With Me",
"uploadId": "uploadid",
"fileName": "records.xml",
"createdAt": "2026-04-07T10:57:00.000+02:00"
}
]
}
},
"onsimport.UploadInfo": {
"type": "object",
"properties": {
"runId": {
"type": "string",
"description": "Object identifier of the run, usually in the form of a UUID."
},
"runName": {
"type": "string",
"description": "Display name of the run. Empty when the run has been deleted.",
"nullable": true
},
"uploadId": {
"type": "string",
"description": "Unique id for requesting status information about the upload."
},
"fileName": {
"type": "string",
"description": "Original file name of the uploaded file."
},
"createdAt": {
"type": "string",
"description": "Timestamp at which the file was uploaded.",
"format": "date-time"
}
},
"description": "Metadata about an uploaded file in Ons Import.",
"example": {
"runId": "runwithme",
"runName": "Run With Me",
"uploadId": "uploadid",
"fileName": "records.xml",
"createdAt": "2026-04-07T10:57:00.000+02:00"
}
},
"onsimport.list.ValidationList": {
"type": "object",
"properties": {
"validations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/onsimport.Validation"
}
}
},
"description": "ValidationList model (no description)",
"example": {
"validations": [
{
"updatedAt": "2020-05-07T00:00:00.000+02:00",
"createdAt": "2020-05-07T00:00:00.000+02:00",
"createdBy": "tanneberger",
"id": 1,
"field": "name",
"value": "Running A Wrong Way",
"message": "WrongNameException",
"recordId": 991,
"recordStatus": "INVALID",
"domain": "Run",
"importId": "001"
},
{
"updatedAt": "2020-05-07T00:00:00.000+02:00",
"createdAt": "2020-05-07T00:00:00.000+02:00",
"createdBy": "tanneberger",
"id": 2,
"field": "name",
"value": "Running A Wrong Way",
"message": "BadSongException",
"recordId": 991,
"recordStatus": "INVALID",
"domain": "Run",
"importId": "001"
}
]
}
},
"onsimport.Validation": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"description": "Technical ID of the validation.",
"format": "int64",
"x-cupido-id": true
},
"field": {
"type": "string",
"description": "Name of the field this validation concerns."
},
"value": {
"type": "string",
"description": "Value of the field (String representation) this validation concerns."
},
"message": {
"type": "string",
"description": "The validation message."
},
"recordId": {
"type": "integer",
"description": "Technical ID of the imported record this validation belongs to.",
"format": "int64"
},
"recordStatus": {
"type": "string",
"description": "Import status of the record this validation belongs to.\nPossible values: INITIAL, INVALID, MATCHED, SUCCESS, SYNC_FAILED."
},
"domain": {
"type": "string",
"description": "Domain of the record this validation belongs to."
},
"importId": {
"type": "string",
"description": "ImportId of the record this validation belongs to."
}
},
"description": "A validation message describing an error that occurred while\nimporting a record in Ons Import.",
"example": {
"updatedAt": "2020-05-07T00:00:00.000+02:00",
"createdAt": "2020-05-07T00:00:00.000+02:00",
"createdBy": "tanneberger",
"id": 1,
"field": "name",
"value": "Running A Wrong Way",
"message": "WrongNameException",
"recordId": 991,
"recordStatus": "INVALID",
"domain": "Run",
"importId": "001"
}
},
"onsimport.UploadResponse": {
"type": "object",
"properties": {
"uploadId": {
"type": "string",
"description": "Unique id for requesting status info about the upload."
}
},
"description": "Contains a unique id by which information about an\nupload can be retrieved.",
"example": {
"uploadId": "uploadid"
},
"xml": {
"name": "uploadResponse"
}
},
"harmony.JsonResponseDto": {
"required": [
"status"
],
"type": "object",
"properties": {
"details": {
"type": "string"
},
"status": {
"type": "integer",
"format": "int32"
}
},
"description": "harmony.JsonResponseDto model (no description)",
"example": {
"details": "Validation error",
"status": 1
}
},
"portal.EmployeePortalProfile": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"facebookEnabled": {
"type": "boolean"
},
"rosterEnabled": {
"type": "boolean"
},
"selfRosteringEnabled": {
"type": "boolean"
},
"selfAvailabilityEnabled": {
"type": "boolean"
},
"vacationHoursEnabled": {
"type": "boolean"
},
"employeePortalUrl": {
"type": "string"
},
"externalWebsiteName": {
"type": "string"
},
"sendEmailForKaminoMessage": {
"type": "boolean"
}
},
"description": "EmployeePortalProfile model (no description)",
"example": {
"employeeId": 2002,
"facebookEnabled": true,
"rosterEnabled": true,
"selfRosteringEnabled": true,
"selfAvailabilityEnabled": true,
"vacationHoursEnabled": true,
"employeePortalUrl": "https://employee.portal.test",
"externalWebsiteName": "Intranet",
"sendEmailForKaminoMessage": true
}
},
"medication.DoubleCheck": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "Unique ID for the double check.",
"x-cupido-id": true
},
"clientId": {
"type": "integer",
"description": "Client who will receive the medication.",
"format": "int64"
},
"medicationChartDate": {
"type": "string",
"description": "Calendar day on which the medication should be taken formatted as YYYY-MM-DD.\nThis date is assumed to be in the time zone of the client.",
"format": "date"
},
"administrationMoment": {
"type": "string",
"description": "The moment at which the medication was planned (e.g. '08:00'). Note that\nthis specifically does not model a time object because the time is\nconsidered to be relative to the client's current timezone. In general\nit should be presented without interpretation."
},
"quantityToAdminister": {
"type": "string",
"description": "In some cases, a user administering medication may want to include the\nquantity they are proposing to administer.\n\nNumerical value (with implicit precision)\nThe precision is implied from the value, so '0.10' is different from '0.1'\n'.' is used as the expected decimal separator\n\nOptional."
},
"administrationAgreement": {
"allOf": [
{
"$ref": "#/components/schemas/drugstore.AdministrationAgreement"
}
],
"description": "Nictic Medicatieproces\nBased on https://simplifier.net/nictizstu3-zib2017/zib-administrationagreement"
},
"createdAt": {
"type": "string",
"description": "Describes when the request for this DoubleCheck was started",
"format": "date-time"
},
"decision": {
"type": "string",
"description": "Most recent decision made by a checker about this double check. Valid\nvalues are:\n\n- pending: Same as blank, double check is still being performed.\n- cancelled: Sender cancelled the double check\n- rejected: Checker rejected the double check because there is not\nenough information (see decisionReason for details).\n- stopped: Checker stopped administration because the double check\nis prepared incorrectly.\n- timeout: Service failed to find checker in a timely manner.\n- verified: Checker verified that the medication was correctly\nprepared.\n\nNote that this value may change over time when new changes come in."
},
"decisionAt": {
"type": "string",
"description": "Time at which the decision was last changed; this may change over time.",
"format": "date-time"
}
},
"description": "A DoubleCheck holds all data surrounding a double check which was created\nfor a specific client and medication administration moment.",
"example": {
"uuid": "3373cf0b-4a06-4f3d-96fa-ea680e1f9baa",
"clientId": 1,
"medicationChartDate": "2018-09-27",
"administrationMoment": "08:00",
"quantityToAdminister": "2",
"administrationAgreement": {
"medication": {
"text": "Carbasalaatcalcium Sandoz 600 30 sac",
"requiresDoubleCheck": true
},
"dosage": {
"text": "3 x PER DAG 1 CAPSULE\nFelle zon en UVlamp op de huid vermijden\nKuur afmaken\nZittend of staand innemen met veel water\n1 uur voor of 2 uur na het eten innemen\nNiet met zuivel innemen, zie bijsluiter",
"doseAndRate": "3 x PER DAG 1 CAPSULE",
"additionalInstructions": [
{
"codings": [
{
"system": "urn:oid:2.16.840.1.113883.2.4.4.5",
"code": "7",
"display": "Felle zon en UVlamp op de huid vermijden"
}
],
"text": "Felle zon en UVlamp op de huid vermijden"
},
{
"codings": [
{
"system": "urn:oid:2.16.840.1.113883.2.4.4.5",
"code": "12",
"display": "Kuur afmaken"
}
],
"text": "Kuur afmaken"
},
{
"codings": [
{
"system": "urn:oid:2.16.840.1.113883.2.4.4.5",
"code": "17",
"display": "Zittend of staand innemen met veel water"
}
],
"text": "Zittend of staand innemen met veel water"
}
],
"patientInstructions": [
"1 uur voor of 2 uur na het eten innemen",
"Niet met zuivel innemen, zie bijsluiter"
],
"route": {
"codings": [
{
"system": "urn:oid:2.16.840.1.113883.2.4.4.9",
"code": "2",
"display": "IM"
}
],
"text": "INTRAMUSCULAIR"
},
"asNeeded": false,
"moments": [
"08:00",
"12:00",
"18:15"
],
"scheduledAdministrations": [
{
"time": "08:00:00",
"quantity": {
"value": "1.00",
"unit": "capsules"
}
},
{
"time": "12:00:00",
"quantity": {
"value": "1.00",
"unit": "capsules"
}
},
{
"time": "18:15:00",
"quantity": {
"value": "1.00",
"unit": "capsules"
}
}
]
},
"periodOfUse": {
"start": "2018-03-26",
"end": "2018-04-02"
},
"distributedAsUnitDose": false,
"updatedAt": "2018-03-25T01:59:59.000+01:00",
"entityTag": "634d9ac28f1b949e73f50e67321619d97f506ba612d449f8a9a331de647314b5"
},
"createdAt": "2018-09-27T00:00:00.000+02:00",
"decision": "verified",
"decisionAt": "2018-09-27T00:00:00.000+02:00"
}
},
"drugstore.AdministrationAgreement": {
"type": "object",
"properties": {
"medication": {
"allOf": [
{
"$ref": "#/components/schemas/drugstore.Medication"
}
],
"description": "A medicinal product as defined by the Dutch Medication v9 project.\nhttps://simplifier.net/NictizSTU3-Zib2017/ZIB-Product"
},
"dosage": {
"allOf": [
{
"$ref": "#/components/schemas/drugstore.Dosage"
}
],
"description": "Instructions for the use of the medication, e.g. dose and route of administration.\nhttps://simplifier.net/NictizSTU3-Zib2017/ZIB-InstructionsForUse"
},
"periodOfUse": {
"allOf": [
{
"$ref": "#/components/schemas/Period"
}
],
"description": "Period in which the medication is/was taken."
},
"distributedAsUnitDose": {
"type": "boolean",
"description": "Indicates if medication is distributed as a unit dose."
},
"updatedAt": {
"type": "string",
"description": "The date and time of the last change made to this administration agreement.",
"format": "date-time"
},
"entityTag": {
"type": "string",
"description": "Changes when the contents of the agreement changes, similar to a weak\nentity tag in HTTP."
}
},
"description": "Nictic Medicatieproces\nBased on https://simplifier.net/nictizstu3-zib2017/zibadministrationagreement",
"example": {
"medication": {
"text": "Carbasalaatcalcium Sandoz 600 30 sac",
"requiresDoubleCheck": true
},
"dosage": {
"text": "3 x PER DAG 1 CAPSULE\nFelle zon en UVlamp op de huid vermijden\nKuur afmaken\nZittend of staand innemen met veel water\n1 uur voor of 2 uur na het eten innemen\nNiet met zuivel innemen, zie bijsluiter",
"doseAndRate": "3 x PER DAG 1 CAPSULE",
"additionalInstructions": [
{
"codings": [
{
"system": "urn:oid:2.16.840.1.113883.2.4.4.5",
"code": "7",
"display": "Felle zon en UVlamp op de huid vermijden"
}
],
"text": "Felle zon en UVlamp op de huid vermijden"
},
{
"codings": [
{
"system": "urn:oid:2.16.840.1.113883.2.4.4.5",
"code": "12",
"display": "Kuur afmaken"
}
],
"text": "Kuur afmaken"
},
{
"codings": [
{
"system": "urn:oid:2.16.840.1.113883.2.4.4.5",
"code": "17",
"display": "Zittend of staand innemen met veel water"
}
],
"text": "Zittend of staand innemen met veel water"
}
],
"patientInstructions": [
"1 uur voor of 2 uur na het eten innemen",
"Niet met zuivel innemen, zie bijsluiter"
],
"route": {
"codings": [
{
"system": "urn:oid:2.16.840.1.113883.2.4.4.9",
"code": "2",
"display": "IM"
}
],
"text": "INTRAMUSCULAIR"
},
"asNeeded": false,
"moments": [
"08:00",
"12:00",
"18:15"
],
"scheduledAdministrations": [
{
"time": "08:00:00",
"quantity": {
"value": "1.00",
"unit": "capsules"
}
},
{
"time": "12:00:00",
"quantity": {
"value": "1.00",
"unit": "capsules"
}
},
{
"time": "18:15:00",
"quantity": {
"value": "1.00",
"unit": "capsules"
}
}
]
},
"periodOfUse": {
"start": "2018-03-26",
"end": "2018-04-02"
},
"distributedAsUnitDose": false,
"updatedAt": "2018-03-25T01:59:59.000+01:00",
"entityTag": "634d9ac28f1b949e73f50e67321619d97f506ba612d449f8a9a331de647314b5"
}
},
"drugstore.Medication": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/CodeableConcept"
}
],
"properties": {
"requiresDoubleCheck": {
"type": "boolean",
"description": "Set to true if medication is present on the KNMP list to double check.\nhttps://www.knmp.nl/downloads/dubbel-te-controleren-lijst.pdf\nNot part of FHIR profile."
}
},
"description": "Nictiz Medicatieproces\nBased on https://simplifier.net/NictizSTU3-Zib2017/ZIB-Product",
"example": {
"codings": [
{
"system": "urn:oid:2.16.840.1.113883.2.4.4.8",
"code": "14292998",
"display": "Carbasalaatcalcium Sandoz 600 30 sac"
}
],
"text": "Carbasalaatcalcium Sandoz 600 30 sac",
"requiresDoubleCheck": true
}
},
"CodeableConcept": {
"type": "object",
"properties": {
"codings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Coding"
},
"description": "List of Codings defined by a terminology system"
},
"text": {
"type": "string",
"description": "Plain text representation of the concept"
}
},
"description": "Based on http://hl7.org/fhir/STU3/datatypes.html#codeableconcept",
"example": {
"codings": [
{
"system": "http://hl7.org/fhir/sid/icd-10",
"code": "R51"
},
{
"system": "http://snomed.info/sct",
"code": "25064002",
"display": "Headache"
}
],
"text": "general headache"
}
},
"Coding": {
"type": "object",
"properties": {
"system": {
"type": "string",
"description": "Identity of the terminology system (URI)"
},
"code": {
"type": "string",
"description": "Symbol in syntax defined by the system"
},
"display": {
"type": "string",
"description": "Representation defined by the system"
}
},
"description": "Based on http://hl7.org/fhir/STU3/datatypes.html#Coding",
"example": {
"system": "http://snomed.info/sct",
"code": "25064002",
"display": "Headache"
}
},
"drugstore.Dosage": {
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "Textual description of the complete dosage instructions.\nThis includes the doseAndRate, and all additionalInstructions and patientInstructions."
},
"doseAndRate": {
"type": "string",
"description": "Textual description of the amount and frequency of administration."
},
"additionalInstructions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CodeableConcept"
},
"description": "Coded instructions and warnings about how to take the medication."
},
"patientInstructions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Free-text supplemental instructions and warnings about how to take the medication."
},
"route": {
"allOf": [
{
"$ref": "#/components/schemas/CodeableConcept"
}
],
"description": "The route through which the medication is administered (oral, nasal, intravenous, etc.)"
},
"asNeeded": {
"type": "boolean",
"description": "As needed means that the dose is only to be administered under certain conditions.\nThe condition for administering medication can be:\n- a physiological measurement value (plasma glucose concentration, body temperature, blood pressure);\n- a symptom or other circumstance (in the event of a headache, or itch)."
},
"moments": {
"type": "array",
"items": {
"type": "string"
},
"description": "Please use 'scheduled_administrations' instead.",
"deprecated": true
},
"scheduledAdministrations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/drugstore.ScheduledAdministration"
},
"description": "A list of ScheduledAdministrations"
}
},
"description": "Nictic Medicatieproces\nBased on https://simplifier.net/NictizSTU3-Zib2017/ZIB-InstructionsForUse",
"example": {
"text": "3 x PER DAG 1 CAPSULE\nFelle zon en UVlamp op de huid vermijden\nKuur afmaken\nZittend of staand innemen met veel water\n1 uur voor of 2 uur na het eten innemen\nNiet met zuivel innemen, zie bijsluiter",
"doseAndRate": "3 x PER DAG 1 CAPSULE",
"additionalInstructions": [
{
"codings": [
{
"system": "urn:oid:2.16.840.1.113883.2.4.4.5",
"code": "7",
"display": "Felle zon en UVlamp op de huid vermijden"
}
],
"text": "Felle zon en UVlamp op de huid vermijden"
},
{
"codings": [
{
"system": "urn:oid:2.16.840.1.113883.2.4.4.5",
"code": "12",
"display": "Kuur afmaken"
}
],
"text": "Kuur afmaken"
},
{
"codings": [
{
"system": "urn:oid:2.16.840.1.113883.2.4.4.5",
"code": "17",
"display": "Zittend of staand innemen met veel water"
}
],
"text": "Zittend of staand innemen met veel water"
}
],
"patientInstructions": [
"1 uur voor of 2 uur na het eten innemen",
"Niet met zuivel innemen, zie bijsluiter"
],
"route": {
"codings": [
{
"system": "urn:oid:2.16.840.1.113883.2.4.4.9",
"code": "2",
"display": "IM"
}
],
"text": "INTRAMUSCULAIR"
},
"asNeeded": false,
"moments": [
"08:00",
"12:00",
"18:15"
],
"scheduledAdministrations": [
{
"time": "08:00:00",
"quantity": {
"value": "1.00",
"unit": "capsules"
}
},
{
"time": "12:00:00",
"quantity": {
"value": "1.00",
"unit": "capsules"
}
},
{
"time": "18:15:00",
"quantity": {
"value": "1.00",
"unit": "capsules"
}
}
]
}
},
"drugstore.ScheduledAdministration": {
"type": "object",
"properties": {
"time": {
"type": "string",
"description": "Describes the planned time for this ScheduledAdministration\nA time during the day, with no date specified.\nSeconds MAY be provided due to schema type constraints\nbut may be zero-filled and may be ignored. The same holds\nfor milliseceonds.\nIn regex this reads:\n([01][0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9](\\.[0-9]+)?)?"
},
"quantity": {
"allOf": [
{
"$ref": "#/components/schemas/Quantity"
}
],
"description": "The quantity for this AdministrationMoment"
}
},
"description": "ScheduledAdministration model (no description)",
"example": {
"time": "08:00:00",
"quantity": {
"value": "1.00",
"unit": "capsules",
"system": "http://snomed.info/sct",
"code": "385049006"
}
}
},
"Quantity": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Numerical value (with implicit precision)\nThe precision is implied from the value, so '0.10' is different from '0.1'\n'.' is used as the expected decimal separator"
},
"unit": {
"type": "string",
"description": "Unit representation (e.g. 'capsules' or 'mg/L')"
},
"system": {
"type": "string",
"description": "System that defines coded unit form (e.g. 'http://unitsofmeasure.org')"
},
"code": {
"type": "string",
"description": "Coded form of the unit (e.g. 'ug' or 's')"
}
},
"description": "A measured or measurable amount\nBased on http://hl7.org/fhir/STU3/datatypes-examples.html#Quantity",
"example": {
"value": "1.00",
"unit": "capsules",
"system": "http://snomed.info/sct",
"code": "385049006"
}
},
"medication.list.MedicationAdministrationList": {
"type": "object",
"properties": {
"medicationAdministrations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/medication.MedicationAdministration"
}
}
},
"description": "MedicationAdministrationList model (no description)",
"example": {
"medicationAdministrations": [
{
"id": 92332,
"superseded": false,
"clientId": 23976,
"employeeId": 3972,
"exempt": false,
"scheduledDuringClientAbsence": false,
"status": "administered",
"medication": {
"text": "FENTANYL MAT AUR 100MCG/UUR",
"codings": [
{
"system": "urn:oid:2.16.840.1.113883.2.4.4.8",
"code": "16746422"
}
]
},
"dosage": {
"dose": {
"value": "1.0",
"unit": "pleister"
},
"route": {
"text": "TRANSDERMAAL",
"codings": [
{
"system": "urn:oid:2.16.840.1.113883.2.4.4.9",
"code": "58",
"display": "TRANSDERMAAL"
}
]
}
},
"agreedDateTime": "2026-05-12T08:00:00.000+02:00",
"effectiveDateTime": "2026-05-12T08:00:00.000+02:00",
"registrationDateTime": "2026-05-12T08:05:00.000+02:00",
"reasonForDeviation": {
"text": "Overig",
"codings": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
"code": "OTH",
"display": "Overig"
}
]
},
"injectionPatchSite": {
"site": {
"text": "structuur van onderste gedeelte van lumbale regio van wand van abdomen",
"codings": [
{
"system": "http://snomed.info/sct",
"code": "160481000146106",
"display": "structuur van onderste gedeelte van lumbale regio van wand van abdomen"
}
]
},
"laterality": {
"text": "links",
"codings": [
{
"system": "http://snomed.info/sct",
"code": "7771000",
"display": "links"
}
]
}
}
}
]
}
},
"medication.MedicationAdministration": {
"title": "MedicationAdministration",
"required": [
"id",
"superseded",
"clientId",
"exempt",
"scheduledDuringClientAbsence",
"medication"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The internal ID of the medication administration. Do not assume this ID is stable across new versions of medication charts of a client. When a new medication chart is received for a client, existing medication administrations may be copied over to a newer version of the medication chart which results in the same medication administration information under a different ID. If that happens, the `superseded` property will be true. This indicates that the medication administration record does not hold the most recent information anymore.\nThe best approach then is to use the `getMedicationAdministrations` operation in order to retrieve the actual medication administration records.",
"format": "int64",
"example": 28721,
"x-cupido-id": true
},
"superseded": {
"type": "boolean",
"description": "Indicates if this medication administration record has been superseded by a newer version due to a new medication chart being received for the client. Use the `getMedicationAdministrations` operation to retrieve the actual medication administrations.",
"example": false
},
"clientId": {
"type": "integer",
"description": "The technical id (IoServer objectId) of the client.",
"format": "int64",
"example": 23976
},
"employeeId": {
"type": "integer",
"description": "The ID of the employee that last updated the status of the administration. Not included when no employee has recorded a status yet, and a registration is still to be made.",
"format": "int64",
"example": 3972
},
"exempt": {
"type": "boolean",
"description": "Indicates if the medication administration is or was exempt due to the moment being self-managed.",
"example": false
},
"scheduledDuringClientAbsence": {
"type": "boolean",
"description": "Indicates if the medication administration is or was scheduled during a client absence.",
"example": false
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/medication.MedicationAdministrationStatus"
}
],
"description": "Last recorded status of a medication administration by a care worker (i.e. the `employeeId`). Not included if no status has been registered yet."
},
"medication": {
"allOf": [
{
"$ref": "#/components/schemas/CodeableConcept"
}
],
"description": "Information about the medication that was or is to be administered.\nCodings may use G-Standaard Artikel Code (informally referred to as “Z-Index Nummer” or “Zi Code”), G-Standaard HPK (handelsproductcodes), G-Standaard GPK (generieke productcode), or other systems, and may describe the product, article, or active ingredient. The text is the display name for the product or article."
},
"dosage": {
"allOf": [
{
"$ref": "#/components/schemas/medication.Dosage"
}
],
"description": "Information about the dosage of the medication."
},
"agreedDateTime": {
"type": "string",
"description": "The time at which the medication is or was scheduled to be administered. Not included for as-needed medication.",
"format": "date-time",
"example": "2026-05-12T08:00:00.000+02:00"
},
"effectiveDateTime": {
"type": "string",
"description": "The time at which the medication was actually administered.",
"format": "date-time",
"example": "2026-05-12T08:05:00.000+02:00"
},
"registrationDateTime": {
"type": "string",
"description": "The time at which the registration about the medication being administered was made.",
"format": "date-time",
"example": "2026-05-12T08:05:00.000+02:00"
},
"reasonForDeviation": {
"allOf": [
{
"$ref": "#/components/schemas/CodeableConcept"
}
],
"description": "Why the medication was not taken or administered or was taken or administered differently.\nWhile Ons Medicatie does register when medication was not taken or administered or differently, it does not keep track of a structured reason for deviation. That means we cannot include a value from the “MedicatietoedieningRedenVanAfwijkenCodelijst” (a subset of SNOMED CT) as described for the MP9 Medicatietoediening ZIB, but instead always include “Other” (code `OTH` of the HL7 NullFlavor system) when deviating. The text is the display name of that reason.\nThe `note` of the medication administration may hold the actual reason why the medication was not or differently administered, but this is not guaranteed as it is free text left by a care worker.\nMedication was considered to be deviated from if the administration was not performed, or when the administered quantity was different from the planned quantity."
},
"injectionPatchSite": {
"$ref": "#/components/schemas/medication.InjectionPatchSite"
},
"note": {
"type": "string",
"description": "A note left by the care worker when registering the status of the administration. This can be a reason why medication was not taken or administered.",
"example": "Cliënt sliep en kon niet gewekt worden"
}
},
"description": "Describes a medication administration record. Includes internal attributes, but is also shaped somewhat to the MP9 Medicatietoediening ZIB.",
"example": {
"id": 92332,
"superseded": false,
"clientId": 23976,
"employeeId": 3972,
"exempt": false,
"scheduledDuringClientAbsence": false,
"status": "administered",
"medication": {
"text": "FENTANYL MAT AUR 100MCG/UUR",
"codings": [
{
"system": "urn:oid:2.16.840.1.113883.2.4.4.8",
"code": "16746422"
}
]
},
"dosage": {
"dose": {
"value": "1.0",
"unit": "pleister"
},
"route": {
"text": "TRANSDERMAAL",
"codings": [
{
"system": "urn:oid:2.16.840.1.113883.2.4.4.9",
"code": "58",
"display": "TRANSDERMAAL"
}
]
}
},
"agreedDateTime": "2026-05-12T08:00:00.000+02:00",
"effectiveDateTime": "2026-05-12T08:00:00.000+02:00",
"registrationDateTime": "2026-05-12T08:05:00.000+02:00",
"reasonForDeviation": {
"text": "Overig",
"codings": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
"code": "OTH",
"display": "Overig"
}
]
},
"injectionPatchSite": {
"site": {
"text": "structuur van onderste gedeelte van lumbale regio van wand van abdomen",
"codings": [
{
"system": "http://snomed.info/sct",
"code": "160481000146106",
"display": "structuur van onderste gedeelte van lumbale regio van wand van abdomen"
}
]
},
"laterality": {
"text": "links",
"codings": [
{
"system": "http://snomed.info/sct",
"code": "7771000",
"display": "links"
}
]
}
},
"note": "Cliënt sliep en kon niet gewekt worden"
}
},
"medication.InjectionPatchSite": {
"title": "InjectionPatchSite",
"required": [
"site"
],
"type": "object",
"properties": {
"site": {
"allOf": [
{
"$ref": "#/components/schemas/CodeableConcept"
}
],
"description": "The anatomical site of the patient’s body where an injection has been administered or where adhesive medical dressing has been applied.\nCodings use the “PrikPlakLocatieCodeLijst”, a subset of SNOMED CT. The text is the display name of the site."
},
"laterality": {
"allOf": [
{
"$ref": "#/components/schemas/CodeableConcept"
}
],
"description": "Complements the anatomical site with the laterality. Present when the anatomical site is laterality-neutral.\nCodings are SNOMED CT qualifiers from the “LateraliteitCodelijst”. The text is a human-readable representation of the laterality."
}
},
"description": "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 laterality-neutral, in which case the laterality property will also be present.\nWhile the structure allows for multiple coding systems, the coding system that is used for the anatomical site is the “PrikPlakLocatieCodeLijst”, which is a subset of the SNOMED CT system. The laterality is a SNOMED CT qualifier from the “LateraliteitCodelijst”.",
"example": {
"site": {
"text": "structuur van onderste gedeelte van lumbale regio van wand van abdomen",
"codings": [
{
"system": "http://snomed.info/sct",
"code": "160481000146106",
"display": "structuur van onderste gedeelte van lumbale regio van wand van abdomen"
}
]
},
"laterality": {
"text": "links",
"codings": [
{
"system": "http://snomed.info/sct",
"code": "7771000",
"display": "links"
}
]
}
}
},
"medication.Dosage": {
"type": "object",
"properties": {
"dose": {
"allOf": [
{
"$ref": "#/components/schemas/Quantity"
}
],
"description": "Amount of the administered product.\nBe very careful with interpreting the value because it's often directly extracted from an apothecary's information system. There are no guarantees about the precision or format."
},
"route": {
"allOf": [
{
"$ref": "#/components/schemas/CodeableConcept"
}
],
"description": "The route of administration.\nCodings use G-Standaard Toedieningswegen (tabel 7). The text is a human-readable description of the route."
}
},
"description": "Information about the dosage of the medication that was or is to be administered.",
"example": {
"dose": {
"value": "1.0",
"unit": "pleister"
},
"route": {
"text": "TRANSDERMAAL",
"codings": [
{
"system": "urn:oid:2.16.840.1.113883.2.4.4.9",
"code": "58",
"display": "TRANSDERMAAL"
}
]
}
}
},
"medication.list.MedicationPlanList": {
"type": "object",
"properties": {
"medicationPlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/medication.MedicationPlan"
}
}
},
"description": "MedicationPlanList model (no description)",
"example": {
"medicationPlans": [
{
"documentUrl": "https://api.ons.io/t/medication_plans/clients/12457/weeks/2023-W12"
}
]
}
},
"medication.MedicationPlan": {
"required": [
"documentUrl"
],
"type": "object",
"properties": {
"documentUrl": {
"type": "string",
"description": "Complete and working URL where the medication plan can be retrieved from."
}
},
"description": "A medication plan holds the document URL required to download a weekly overview of medication information for a given client.",
"example": {
"documentUrl": "https://api.ons.io/t/medication_plans/clients/12457/weeks/2023-W12"
}
},
"milo.Device": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Id of the Device",
"format": "int64",
"nullable": true,
"x-cupido-id": true
},
"employeeObjectId": {
"type": "integer",
"description": "Id of the employee this device belongs to",
"format": "int64",
"nullable": true
},
"deviceCode": {
"type": "string",
"description": "Device code (uuid)",
"nullable": true
},
"description": {
"type": "string",
"description": "Description with the name of the device",
"nullable": true
},
"accessedAt": {
"type": "string",
"description": "Datetime",
"format": "date-time",
"nullable": true
},
"userAgent": {
"type": "string",
"description": "Deprecated since: 14-03-2019 - use the userAgent field of Cupido::Milo::App",
"nullable": true,
"deprecated": true,
"x-deprecated-since": "14-03-2019"
},
"supportsOneTimePassword": {
"type": "boolean",
"description": "Boolean if this devices supports one time password",
"nullable": true
},
"apps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/milo.App"
},
"description": "A list of apps linked to the device",
"nullable": true,
"xml": {
"wrapped": true
}
},
"deletedAt": {
"type": "string",
"description": "The time when the device was deleted. Null otherwise.",
"format": "date-time",
"nullable": true
}
},
"description": "Device model (no description)",
"example": {
"id": 129,
"employeeObjectId": 123456,
"deviceCode": "123e4567-e89b-12d3-a456-426655440000",
"description": "Galaxy Nexus",
"accessedAt": "2014-06-02T17:12:00.000+02:00",
"userAgent": "Milo/2.2.1 Android/18 (4.3; 776638; samsung; Galaxy Nexus)",
"supportsOneTimePassword": true,
"apps": [
{
"id": 1,
"employeeObjectId": 123456,
"name": "Ons Toegangscode",
"userAgent": "Milo/2.2.1 Android/18 (4.3; 776638; samsung; Galaxy Nexus)",
"deviceId": 129,
"accessedAt": "2018-03-29T00:00:00.000+02:00",
"deletedAt": "2018-08-20T01:00:00.000+02:00"
}
],
"deletedAt": "2018-08-20T01:00:00.000+02:00"
},
"xml": {
"name": "device"
}
},
"milo.App": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Id of the App",
"format": "int64",
"nullable": true,
"x-cupido-id": true
},
"employeeObjectId": {
"type": "integer",
"description": "Id of the employee this app belongs to",
"format": "int64",
"nullable": true,
"deprecated": true,
"x-deprecated-since": "20-11-2023"
},
"name": {
"type": "string",
"description": "Description of the app (mostly the name)",
"nullable": true
},
"userAgent": {
"type": "string",
"description": "String with version of user_agent on this device",
"nullable": true
},
"deviceId": {
"type": "integer",
"description": "Id of the device this app belongs to",
"format": "int64",
"nullable": true
},
"accessedAt": {
"type": "string",
"description": "Datetime",
"format": "date-time",
"nullable": true
},
"deletedAt": {
"type": "string",
"description": "The time when the app was deleted. Null otherwise.",
"format": "date-time",
"nullable": true
}
},
"description": "App model (no description)",
"example": {
"id": 1,
"employeeObjectId": 123456,
"name": "Ons Toegangscode",
"userAgent": "Milo/2.2.1 Android/18 (4.3; 776638; samsung; Galaxy Nexus)",
"deviceId": 129,
"accessedAt": "2018-03-29T00:00:00.000+02:00",
"deletedAt": "2018-08-20T01:00:00.000+02:00"
},
"xml": {
"name": "app"
}
},
"milo.list.DeviceList": {
"type": "object",
"properties": {
"devices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/milo.Device"
},
"xml": {
"name": "device"
}
}
},
"description": "DeviceList model (no description)",
"example": {
"devices": [
{
"id": 129,
"employeeObjectId": 123456,
"description": "Galaxy Nexus",
"accessedAt": "2014-06-02T17:12:00.000+02:00",
"userAgent": "Milo/2.2.1 Android/18 (4.3; 776638; samsung; Galaxy Nexus)",
"supportsOneTimePassword": true,
"apps": [
{
"id": 1,
"employeeObjectId": 123456,
"name": "Ons Toegangscode",
"userAgent": "Milo/2.2.1 Android/18 (4.3; 776638; samsung; Galaxy Nexus)",
"deviceId": 129,
"accessedAt": "2018-03-29T00:00:00.000+02:00",
"deletedAt": "2018-08-20T01:00:00.000+02:00"
}
],
"deletedAt": "2018-08-20T01:00:00.000+02:00"
}
]
},
"xml": {
"name": "devices"
}
},
"milo.PasswordVerification": {
"type": "object",
"properties": {
"valid": {
"type": "boolean",
"description": "Boolean if passwordVerification is valid",
"nullable": true
}
},
"description": "PasswordVerification model (no description)",
"example": {
"valid": true
}
},
"hermes.CareProviderSettings": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"nullable": true
},
"defaultTemplateSet": {
"type": "string",
"nullable": true
},
"defaultContactMethod": {
"type": "string",
"nullable": true
}
},
"description": "CareProviderSettings model (no description)",
"example": {
"enabled": true,
"defaultTemplateSet": "junior",
"defaultContactMethod": "Email"
}
},
"hermes.ContactMethod": {
"type": "object",
"properties": {
"recipient": {
"allOf": [
{
"$ref": "#/components/schemas/hermes.Recipient"
}
],
"description": "The method belongs to a recipient"
},
"careProviderSettings": {
"$ref": "#/components/schemas/hermes.CareProviderSettings"
},
"enabled": {
"type": "boolean"
},
"subscribed": {
"type": "boolean"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
},
"status": {
"type": "string"
},
"templateSet": {
"type": "string"
}
},
"description": "ContactMethod model (no description)",
"example": {
"recipient": {
"clientId": 1,
"clientUuid": "abca58ed-0138-4aec-87c6-5d391e98161b",
"employeeId": 1
},
"careProviderSettings": {
"enabled": true,
"defaultTemplateSet": "junior",
"defaultContactMethod": "Email"
},
"enabled": true,
"subscribed": false,
"type": "SMS",
"value": "0600123456",
"status": "validated",
"templateSet": "adult"
}
},
"hermes.list.NotificationList": {
"type": "object",
"properties": {
"hermesNotifications": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/hermes.Notification"
}
],
"xml": {
"name": "hermesNotification"
}
}
}
},
"description": "NotificationList model (no description)",
"example": {
"hermesNotifications": [
{
"id": 1,
"title": "spam",
"message": "You have new spam",
"path": "/spam",
"deploymentType": "PortalDeployment",
"collapseKey": "blik",
"collapseMethod": "replace",
"collapseTitle": "%{count} spam",
"collapseMessage": "You have %{count} new spam",
"createdAt": "2015-01-01T12:00:00.000+01:00",
"updatedAt": "2015-01-01T12:00:00.000+01:00",
"iconId": "default",
"silent": false,
"recipient": {
"clientId": 1,
"clientUuid": "abca58ed-0138-4aec-87c6-5d391e98161b",
"employeeId": 1
},
"read": true
}
]
},
"xml": {
"name": "hermesNotifications"
}
},
"nexus.list.ClientContactRelationTypeList": {
"type": "object",
"properties": {
"clientContactRelationTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nexus.ClientContactRelationType"
}
}
},
"description": "ClientContactRelationTypeList model (no description)",
"example": {
"clientContactRelationTypes": [
{
"id": 6,
"name": "Curator",
"primary": true,
"exclusive": true,
"negative": false,
"active": true,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"id": 7,
"name": "Standard"
},
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00"
}
]
}
},
"nexus.list.ClientEmployeeRelationTypeList": {
"type": "object",
"properties": {
"clientEmployeeRelationTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nexus.ClientEmployeeRelationType"
}
}
},
"description": "ClientEmployeeRelationTypeList model (no description)",
"example": {
"clientEmployeeRelationTypes": [
{
"id": 6,
"name": "Coach",
"primary": true,
"exclusive": true,
"negative": false,
"active": true,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"id": 7,
"name": "Standard"
},
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00"
}
]
}
},
"nexus.list.ClientEmployeeRelationList": {
"type": "object",
"properties": {
"clientEmployeeRelations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nexus.ClientEmployeeRelation"
},
"xml": {
"name": "clientEmployeeRelation"
}
}
},
"description": "ClientEmployeeRelationList model (no description)",
"example": {
"clientEmployeeRelations": [
{
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"id": 17,
"relationName": "Cøach",
"validFrom": "2013-11-28T11:49:58.000+01:00",
"validTo": "2013-11-30T11:49:58.000+01:00",
"relationType": {
"id": 6,
"name": "Cøach",
"primary": true,
"exclusive": true,
"negative": false,
"active": true,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"id": 7,
"name": "Standard"
},
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00"
},
"relationTypeId": 6,
"clientId": 3,
"employeeId": 12
},
{
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"id": 18,
"relationName": "Cøach",
"validFrom": "2013-11-28T11:49:58.000+01:00",
"validTo": "2013-11-30T11:49:58.000+01:00",
"relationType": {
"id": 6,
"name": "Cøach",
"primary": true,
"exclusive": true,
"negative": false,
"active": true,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"id": 7,
"name": "Standard"
},
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00"
},
"relationTypeId": 6,
"clientId": 3,
"employeeId": 13
},
{
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"id": 19,
"relationName": "Cøach",
"validFrom": "2013-11-28T11:49:58.000+01:00",
"validTo": "2013-11-30T11:49:58.000+01:00",
"relationType": {
"id": 6,
"name": "Cøach",
"primary": true,
"exclusive": true,
"negative": false,
"active": true,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"id": 7,
"name": "Standard"
},
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00"
},
"relationTypeId": 6,
"clientId": 3,
"employeeId": 14
},
{
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"id": 20,
"relationName": "Cøach",
"validFrom": "2013-11-28T11:49:58.000+01:00",
"validTo": "2013-11-30T11:49:58.000+01:00",
"relationType": {
"id": 6,
"name": "Cøach",
"primary": true,
"exclusive": true,
"negative": false,
"active": true,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"id": 7,
"name": "Standard"
},
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00"
},
"relationTypeId": 6,
"clientId": 3,
"employeeId": 15
},
{
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"id": 21,
"relationName": "Cøach",
"validFrom": "2013-11-28T11:49:58.000+01:00",
"validTo": "2013-11-30T11:49:58.000+01:00",
"relationType": {
"id": 6,
"name": "Cøach",
"primary": true,
"exclusive": true,
"negative": false,
"active": true,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"id": 7,
"name": "Standard"
},
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00"
},
"relationTypeId": 6,
"clientId": 3,
"employeeId": 16
}
]
},
"xml": {
"name": "clientEmployeeRelations"
}
},
"nexus.list.OrganisationCategoryList": {
"type": "object",
"properties": {
"organisationCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nexus.OrganisationCategory"
}
}
},
"description": "OrganisationCategoryList model (no description)",
"example": {
"organisationCategories": [
{
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"id": 7,
"name": "Dentists",
"azr": false,
"reference": 1
}
]
}
},
"nexus.OrganisationCategory": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"name": {
"type": "string"
},
"azr": {
"type": "boolean"
},
"active": {
"type": "boolean"
},
"vektisCode": {
"type": "integer",
"format": "int64"
},
"reference": {
"type": "integer",
"description": "Only available during transitional period.",
"format": "int64",
"deprecated": true
}
},
"description": "OrganisationCategory model (no description)",
"example": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user",
"id": 7,
"name": "Dentists",
"azr": false,
"active": false,
"vektisCode": 2,
"reference": 1
}
},
"nexus.list.PersonalRelationTypeList": {
"type": "object",
"properties": {
"personalRelationTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nexus.PersonalRelationType"
}
}
},
"description": "PersonalRelationTypeList model (no description)",
"example": {
"personalRelationTypes": [
{
"id": 6,
"name": "Father",
"primary": true,
"exclusive": true,
"negative": false,
"active": true,
"vektisCode": 1,
"reference": 1,
"relationCategory": {
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00",
"createdBy": "user",
"id": 7,
"name": "Standard"
},
"updatedAt": "2013-09-24T11:49:58.000+02:00",
"createdAt": "2013-09-24T11:49:58.000+02:00"
}
]
}
},
"openehr.list.ArchetypeWrapperList": {
"type": "object",
"properties": {
"archetypeWrappers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.ArchetypeWrapper"
},
"nullable": true
}
},
"description": "ArchetypeWrapperList model (no description)",
"example": {
"archetypeWrappers": [
{
"updatedAt": "2018-06-28T00:00:00.000+02:00",
"createdAt": "2018-06-28T00:00:00.000+02:00",
"createdBy": "Dummy",
"id": 1,
"archetypeId": "openEHR-EHR-OBSERVATION.barthel.v2.0.0",
"archetypeClass": "Dummy",
"rootNodeRmTypeName": "Dummy",
"rootNodeText": "Dummy",
"rootNodeDescription": "Dummy",
"purpose": "Dummy",
"use": "Dummy",
"misuse": "Dummy",
"copyright": "Dummy",
"keywords": [],
"creatable": true,
"enabled": true,
"archetypeCategories": [
{
"id": 1,
"name": "GGZ"
}
],
"authorizedEmployeeGroupsForCreate": [
{
"id": 1,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
}
],
"authorizedEmployeeGroupsForRead": [],
"authorizedEmployeeGroupsForUpdate": [
{
"id": 1,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
},
{
"id": 2,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
}
],
"authorizedForCreate": true,
"archetype": "Dummy",
"form": "OPERATIONAL_TEMPLATE"
},
{
"updatedAt": "2018-06-28T00:00:00.000+02:00",
"createdAt": "2018-06-28T00:00:00.000+02:00",
"createdBy": "Dummy",
"id": 2,
"archetypeId": "openEHR-EHR-OBSERVATION.laboratory_test_result.v1.1.2",
"archetypeClass": "Dummy",
"rootNodeRmTypeName": "Dummy",
"rootNodeText": "Dummy",
"rootNodeDescription": "Dummy",
"purpose": "Dummy",
"use": "Dummy",
"misuse": "Dummy",
"copyright": "Dummy",
"keywords": [],
"creatable": true,
"enabled": true,
"archetypeCategories": [
{
"id": 2,
"name": "VVT"
}
],
"authorizedEmployeeGroupsForCreate": [],
"authorizedEmployeeGroupsForRead": [],
"authorizedEmployeeGroupsForUpdate": [],
"archetype": "Dummy",
"form": "OPERATIONAL_TEMPLATE"
}
]
}
},
"openehr.ArchetypeWrapper": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ArchetypeWrapperBase"
}
],
"description": "ArchetypeWrapper model (no description)",
"example": {
"updatedAt": "2018-06-28T00:00:00.000+02:00",
"createdAt": "2018-06-28T00:00:00.000+02:00",
"createdBy": "Dummy",
"id": 1,
"archetypeId": "Dummy",
"archetypeClass": "Dummy",
"rootNodeRmTypeName": "Dummy",
"rootNodeText": "Dummy",
"rootNodeDescription": "Dummy",
"purpose": "Dummy",
"use": "Dummy",
"misuse": "Dummy",
"copyright": "Dummy",
"keywords": [],
"creatable": true,
"enabled": true,
"enabledInUi": true,
"archetypeCategories": [
{
"id": 1,
"name": "GGZ"
}
],
"authorizedEmployeeGroupsForCreate": [
{
"id": 1,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
}
],
"authorizedEmployeeGroupsForRead": [],
"authorizedEmployeeGroupsForUpdate": [
{
"id": 1,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
},
{
"id": 2,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
}
],
"authorizedForCreate": true,
"archetype": "Dummy",
"form": "OPERATIONAL_TEMPLATE"
}
},
"ArchetypeWrapperBase": {
"title": "ArchetypeWrapper",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/AuditedBase"
}
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"nullable": true,
"x-cupido-id": true
},
"archetypeId": {
"type": "string",
"description": "String containing the archetypeId\nExample: \"openEHR-EHR-CLUSTER.symptom_sign.v1.0.0\"",
"nullable": true
},
"archetypeClass": {
"type": "string",
"description": "String containing the archetypeClass\nExample: \"AuthoredArchetype\"",
"nullable": true
},
"rootNodeRmTypeName": {
"type": "string",
"description": "String containing the rootNodeRmTypeName (a.k.a. rootNodeRmTypeName)\nExample: \"CLUSTER\"",
"nullable": true,
"example": "CLUSTER"
},
"rootNodeText": {
"type": "string",
"description": "String containing the rootNodeText\nExample: \"Symptoom/signaal\"",
"nullable": true,
"example": "Symptoom/signaal"
},
"rootNodeDescription": {
"type": "string",
"description": "String containing the rootNodeDescription\nExample: \"Een klacht van een patient of objectief waargenomen kernmerk van een ziekte.\"",
"nullable": true,
"example": "Een klacht van een patiënt of objectief waargenomen kenmerk van een ziekte."
},
"purpose": {
"type": "string",
"description": "String containing the purpose\nExample: \"To record details about a single episode of a reported symptom or sign including context, but not details, of previous episodes if appropriate.\"",
"nullable": true,
"example": "To record details about a single episode of a reported symptom or sign including context, but not details, of previous episodes if appropriate."
},
"use": {
"type": "string",
"description": "String containing the use\nExample: \"Use to record details about a single episode of a symptom or reported sign in an individual, as reported by the individual, parent, care-giver or other party. It may be recorded by a clinician as part of a clinical history record as reported to them, observed by the clinician or self-recorded as part of a clinical questionnaire or personal health record. A complete clinical history or patient story may include varying level of details about multiple episodes of an identified symptom or reported sign, as well as multiple symptoms/signs.\\n\\nIn the purest sense, symptoms are subjective observations of a physical or mental disturbance and signs are objective observations of the same, as experienced by an individual and reported to the history taker by the same individual or another party. From this logic it follows that we will need two archetypes to record clinical history - one for reported symptoms and another for reported signs. In reality this is impractical as it will require clinical data entry into either one of these models which adds signficant overheads to modellers and those entering data. In addition, there is often overlap in clinical concepts - for example, is previous vomiting or bleeding to be categorised as a symptom or reported sign? In response, this archetype has been specifically designed to proved a single information model that allows for recording of the entire continuum between clearly identifable symptoms and reported signs when recording a clinical history.\\n\\nThis archetype has been intended to be used as a generic pattern for all symptoms and reported signs. The 'Specific details' SLOT can be used to extend the archetype to include additional, specific data elements for more complex symptoms or signs.\\n\\nThis archetype has been specifically designed to be used in the 'Structured detail' SLOT within the OBSERVATION.story archetype, but can also be used within other OBSERVATION or CLUSTER archetypes and in the 'Associated symptom/sign' or 'Previous episode' SLOT within other instances of this CLUSTER.symptom_sign archetype.\\n\\nClinicians frequently record the phrase 'nil significant' against specific symptoms or reported signs as an efficient method to indicate that they asked the individual and it was not reported as causing any discomfort or disturbance - effectively used more like a 'normal statement' rather than an explicit exclusion. The 'Nil significant' data element has been deliberately included in this archetype to allow clinicians to record this same information in a simple and effective way in a clinical system. It can be used to drive a user interface, for example if 'Nil significant' is recorded as true then the remaining data elements can be hidden on a data entry screen. This pragmatic approach supports the majority of simple clinical recording requirements around reported symptoms and signs.\\n\\nHowever if there is a clinical imperative to explicitly record that a Symptom or Sign was reported as not present, for example if it will be used to drive clinical decision support, then it would be preferable to use the CLUSTER.exclusion_symptom_sign archetype. The use of CLUSTER.exclusion_symptom_sign will increase the complexity of template modelling, implementation and querying. It is recommended that the CLUSTER.exclusion_symptom_sign archetype only be considered for use if clear benefit can be identified in specific situations, but should not be used for routine symptom/sign recording.\"",
"nullable": true
},
"misuse": {
"type": "string",
"description": "String containing the misuse\nExample: \"Not to be used to record that a symptom or sign was explicitly reported as not present - use CLUSTER.exclusion_symptom_sign carefully for specific purposes where the overheads of recording in this way warrant the additional complexity, and only if the 'Nil significant' in this archetype is not specific enough for recording purposes.\\n\\nNot to be used for recording objective findings as part of a physical examination - use OBSERVATION.exam and related examination CLUSTER archetypes for this purpose.\\n\\nNot to be used for diagnoses and problems that form part of a persisting Problem List - use EVALUATION.problem_diagnosis.\"",
"nullable": true
},
"copyright": {
"type": "string",
"description": "String containing the copyright\nExample: \"© openEHR Foundation\"",
"nullable": true,
"example": "© openEHR Foundation"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of keywords, which are Strings\nExample: [ \"complaint\", \"symptom\" ]",
"nullable": true
},
"creatable": {
"type": "boolean",
"description": "Boolean containing value if corresponding archetype is creatable",
"nullable": true
},
"enabled": {
"type": "boolean",
"description": "Deprecated due to functional change. Replaced with enabledInUi",
"nullable": true,
"deprecated": true,
"x-deprecated-since": "19-03-2024"
},
"enabledInUi": {
"type": "boolean",
"description": "Boolean containing value if corresponding archetype is enabled in the ui",
"nullable": true
},
"archetypeCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.ArchetypeCategory"
},
"description": "List of {@link ArchetypeCategory}s of this archetype.",
"nullable": true
},
"authorizedEmployeeGroupsForCreate": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/openehr.EmployeeGroup"
}
],
"xml": {
"name": "employeeGroup"
}
},
"description": "List of {@link EmployeeGroup}s who are allowed to create compositions of\nthis archetype.\n\nAn empty list means all employees are allowed to create compositions of\nthis archetype.",
"nullable": true
},
"authorizedEmployeeGroupsForRead": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/openehr.EmployeeGroup"
}
],
"xml": {
"name": "employeeGroup"
}
},
"description": "List of {@link EmployeeGroup}s who are by default allowed to read\ncompositions of this archetype.\n\nAn empty list means all employees by default are allowed to read\ncompositions of this archetype.",
"nullable": true
},
"authorizedEmployeeGroupsForUpdate": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/openehr.EmployeeGroup"
}
],
"xml": {
"name": "employeeGroup"
}
},
"description": "List of {@link EmployeeGroup}s who are by default allowed to update\ncompositions of this archetype.\n\nAn empty list means all employees by default are allowed to update\ncompositions of this archetype.",
"nullable": true
},
"authorizedForCreate": {
"type": "boolean",
"description": "Boolean to indicate that the current user is authorized to create\ncompositions of this archetype.\n\nTrue if authorizedEmployeeGroupsForCreate is empty or the current user\nis a member of one of the authorizedEmployeeGroupsForCreate.\n\nFalse if the user not a member of one of the\nauthorizedEmployeeGroupsForCreate.\n\nNull if no user information is available.",
"nullable": true
},
"archetype": {
"type": "string",
"description": "String containing the JSON-blob with the OpenEHR archetype\nThis is the actual data stored in Chiron, the openEHR database",
"nullable": true
},
"form": {
"type": "string",
"description": "String containing the archetype form, e.g 'OPERATIONAL_TEMPLATE', 'FLAT', 'DIFFERENTIAL' or 'METADATA'",
"nullable": true
}
},
"description": "OpenEHR ArchetypeWrapper model.\nObject to return an ArchetypeWrapper. The wrapper contains the actual archetype as a String and relevant metadata.\n\nBased on the OperationalTemplate, see https://www.openehr.org/releases/AM/latest/docs/AOM2/AOM2.html#_overview_2\n\nCreated on 22/06/2018.",
"example": {
"updatedAt": "2018-06-28T00:00:00.000+02:00",
"createdAt": "2018-06-28T00:00:00.000+02:00",
"createdBy": "Dummy",
"id": 1,
"archetypeId": "Dummy",
"archetypeClass": "Dummy",
"rootNodeRmTypeName": "Dummy",
"rootNodeText": "Dummy",
"rootNodeDescription": "Dummy",
"purpose": "Dummy",
"use": "Dummy",
"misuse": "Dummy",
"copyright": "Dummy",
"keywords": [],
"creatable": true,
"enabled": true,
"enabledInUi": true,
"archetypeCategories": [
{
"id": 1,
"name": "GGZ"
}
],
"authorizedEmployeeGroupsForCreate": [
{
"id": 1,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
}
],
"authorizedEmployeeGroupsForRead": [],
"authorizedEmployeeGroupsForUpdate": [
{
"id": 1,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
},
{
"id": 2,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
}
],
"authorizedForCreate": true,
"archetype": "Dummy",
"form": "OPERATIONAL_TEMPLATE"
}
},
"openehr.ArchetypeCategory": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"name": {
"type": "string",
"description": "Name of the archetype category.\nExample: \"GGZ\"."
}
},
"description": "OpenEHR Archetype Category model.\nObject to return an ArchetypeCategory.\n\nThis object includes additional information about Archetype Categories.\n\nCreated on 30/01/2022.",
"example": {
"id": 1,
"name": "GGZ"
}
},
"ons_ehr.list.NavigationAvailabilityList": {
"type": "object",
"properties": {
"navigationAvailabilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ons_ehr.NavigationAvailability"
}
}
},
"description": "List of navigation items with their availability",
"example": {
"navigationAvailabilities": [
{
"key": "PLAN",
"state": "AVAILABLE"
},
{
"key": "ASSESSMENT_REPORTS",
"state": "UNAVAILABLE"
},
{
"key": "DISCUSS_CLIENT",
"state": "AVAILABLE"
}
]
}
},
"ons_ehr.NavigationAvailability": {
"required": [
"key",
"state"
],
"type": "object",
"properties": {
"key": {
"$ref": "#/components/schemas/ons_ehr.NavigationAvailabilityKey"
},
"state": {
"$ref": "#/components/schemas/ons_ehr.NavigationAvailabilityState"
}
},
"description": "A navigation item with its availability",
"example": {
"key": "PLAN",
"state": "AVAILABLE"
}
},
"ons_ehr.NavigationAvailabilityKey": {
"enum": [
"PLAN",
"ASSESSMENT_REPORTS",
"DISCUSS_CLIENT"
],
"type": "string",
"description": "item for navigation availability request",
"example": "PLAN"
},
"ons_ehr.NavigationAvailabilityState": {
"enum": [
"AVAILABLE",
"DISABLED",
"UNAVAILABLE"
],
"type": "string",
"description": "State of the navigation availability",
"example": "AVAILABLE"
},
"openehr.list.CompositionWrapperList": {
"type": "object",
"properties": {
"compositionWrappers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.CompositionWrapper"
}
}
},
"description": "List of wrapper openEHR Compositions.",
"example": {
"compositionWrappers": [
{
"id": 1,
"ehrId": 1,
"clientId": 1,
"archetypeId": "openEHR-EHR-COMPOSITION.text_report.v1.0.0",
"storedCompositionId": 1,
"versionedCompositionUuid": "e3d332a0-27bf-42f8-8d7c-0997a9b74ae8",
"temporaryCompositionKey": "a2bc5e00-c67e-4d7e-bb87-b3b74cdefd00",
"type": "COMPOSITION",
"firstEventTime": "2018-06-08T00:00:00.000+02:00",
"composerId": 1,
"composerName": "Dhr. Mike Wazowski",
"composerEmployeeId": 1,
"timeCommitted": "2021-06-16T11:18:30.000+02:00",
"committerName": "Dhr. Mike Wazowski",
"committerEmployeeId": 1,
"authorizedForUpdate": true,
"lifecycleState": "COMPLETE",
"referenceModelObject": "{\"@type\":\"COMPOSITION\",\"archetype_details\":{\"@type\":\"ARCHETYPED\",\"archetype_id\":{\"@type\":\"ARCHETYPE_ID\",\"domain_concept\":\"text_report\",\"qualified_rm_entity\":\"openEHR-EHR-COMPOSITION\",\"rm_entity\":\"COMPOSITION\",\"rm_name\":\"EHR\",\"rm_originator\":\"openEHR\",\"value\":\"openEHR-EHR-COMPOSITION.text_report.v1.0.0\",\"versionId\":\"1.0.0\",\"full_id\":\"openEHR-EHR-COMPOSITION.text_report.v1.0.0\",\"semantic_id\":\"openEHR-EHR-COMPOSITION.text_report.v1\"},\"rm_version\":\"1.0.4\"},\"archetype_node_id\":\"id1.1\",\"category\":{\"@type\":\"DV_CODED_TEXT\",\"defining_code\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"433\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"openehr\"}},\"mappings\":[],\"value\":\"event\"},\"composer\":{\"@type\":\"PARTY_IDENTIFIED\",\"external_ref\":{\"@type\":\"PARTY_REF\",\"id\":{\"@type\":\"HIER_OBJECT_ID\",\"value\":\"com.nedap.NE0001.employee::2\"},\"namespace\":\"demographic\",\"type\":\"PERSON\"},\"identifiers\":[],\"name\":\"administrator\"},\"content\":[{\"@type\":\"OBSERVATION\",\"archetype_details\":{\"@type\":\"ARCHETYPED\",\"archetype_id\":{\"@type\":\"ARCHETYPE_ID\",\"domain_concept\":\"text_report\",\"qualified_rm_entity\":\"openEHR-EHR-OBSERVATION\",\"rm_entity\":\"OBSERVATION\",\"rm_name\":\"EHR\",\"rm_originator\":\"openEHR\",\"value\":\"openEHR-EHR-OBSERVATION.text_report.v1.0.0\",\"versionId\":\"1.0.0\",\"full_id\":\"openEHR-EHR-OBSERVATION.text_report.v1.0.0\",\"semantic_id\":\"openEHR-EHR-OBSERVATION.text_report.v1\"},\"rm_version\":\"1.0.4\"},\"archetype_node_id\":\"id0.2\",\"data\":{\"@type\":\"HISTORY\",\"archetype_node_id\":\"id2\",\"events\":[{\"@type\":\"POINT_EVENT\",\"archetype_node_id\":\"id3\",\"data\":{\"@type\":\"ITEM_TREE\",\"archetype_node_id\":\"id4\",\"items\":[{\"@type\":\"ELEMENT\",\"archetype_node_id\":\"id5\",\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Text report\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]/data[id4]/items[id5]\"}],\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]/data[id4]\"},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Point event\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]\",\"time\":{\"@type\":\"DV_DATE_TIME\",\"other_reference_ranges\":[],\"value\":\"2021-06-16T11:18:30.000+02:00\"}}],\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"\"},\"origin\":{\"@type\":\"DV_DATE_TIME\",\"other_reference_ranges\":[],\"value\":\"2021-06-16T11:18:30.000+02:00\"},\"path\":\"/content[id0.2]/data[id2]\"},\"encoding\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"UTF-8\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"IANA_character-sets\"}},\"language\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"en\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_639-1\"}},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Text report\"},\"other_participations\":[],\"path\":\"/content[id0.2]\",\"subject\":{\"@type\":\"PARTY_SELF\"}}],\"language\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"en\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_639-1\"}},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Text report\"},\"path\":\"/\",\"territory\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"NL\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_3166-1\"}}}",
"pathsAndValues": "{\"/content[id0.2]/data[id2]/events[id3]/time/value\": \"2021-06-16T11:18:30.000+02:00\", \"/content[id0.2]/data[id2]/events[id3]/data[id4]/items[id5,1]\": \"Tekst rapportage test\"}",
"authorizedEmployeeGroupsForRead": [],
"authorizedEmployeeGroupsForUpdate": [
{
"id": 57,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
},
{
"id": 58,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
}
],
"itemTags": [
{
"id": 59,
"key": "important",
"value": "value",
"targetPath": "/content[id0.2]/data[id2]/events[id3]/data[id4]/items[id5]"
}
],
"updatedAt": "2021-06-16T11:18:30.000+02:00",
"createdAt": "2018-06-08T00:00:00.000+02:00",
"createdBy": "Dhr. Mike Wazowski",
"uuid": "e3d332a0-27bf-42f8-8d7c-0997a9b74ae8",
"instructions": []
},
{
"id": 2,
"ehrId": 1,
"clientId": 1,
"archetypeId": "openEHR-EHR-COMPOSITION.text_report.v1.0.0",
"storedCompositionId": 2,
"versionedCompositionUuid": "e3d332a0-27bf-42f8-8d7c-0997a9b74ae9",
"temporaryCompositionKey": "b7f0d5a1-2c31-4f0e-9a44-1d2e3f4a5b6c",
"type": "COMPOSITION",
"firstEventTime": "2018-06-08T00:00:00.000+02:00",
"composerId": 2,
"composerName": "Mevr. Celia Mae",
"composerEmployeeId": 2,
"timeCommitted": "2021-06-17T09:42:11.000+02:00",
"committerName": "Mevr. Celia Mae",
"committerEmployeeId": 2,
"authorizedForUpdate": true,
"lifecycleState": "COMPLETE",
"referenceModelObject": "{\"@type\":\"COMPOSITION\",\"archetype_details\":{\"@type\":\"ARCHETYPED\",\"archetype_id\":{\"@type\":\"ARCHETYPE_ID\",\"domain_concept\":\"text_report\",\"qualified_rm_entity\":\"openEHR-EHR-COMPOSITION\",\"rm_entity\":\"COMPOSITION\",\"rm_name\":\"EHR\",\"rm_originator\":\"openEHR\",\"value\":\"openEHR-EHR-COMPOSITION.text_report.v1.0.0\",\"versionId\":\"1.0.0\",\"full_id\":\"openEHR-EHR-COMPOSITION.text_report.v1.0.0\",\"semantic_id\":\"openEHR-EHR-COMPOSITION.text_report.v1\"},\"rm_version\":\"1.0.4\"},\"archetype_node_id\":\"id1.1\",\"category\":{\"@type\":\"DV_CODED_TEXT\",\"defining_code\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"433\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"openehr\"}},\"mappings\":[],\"value\":\"event\"},\"composer\":{\"@type\":\"PARTY_IDENTIFIED\",\"external_ref\":{\"@type\":\"PARTY_REF\",\"id\":{\"@type\":\"HIER_OBJECT_ID\",\"value\":\"com.nedap.NE0001.employee::2\"},\"namespace\":\"demographic\",\"type\":\"PERSON\"},\"identifiers\":[],\"name\":\"administrator\"},\"content\":[{\"@type\":\"OBSERVATION\",\"archetype_details\":{\"@type\":\"ARCHETYPED\",\"archetype_id\":{\"@type\":\"ARCHETYPE_ID\",\"domain_concept\":\"text_report\",\"qualified_rm_entity\":\"openEHR-EHR-OBSERVATION\",\"rm_entity\":\"OBSERVATION\",\"rm_name\":\"EHR\",\"rm_originator\":\"openEHR\",\"value\":\"openEHR-EHR-OBSERVATION.text_report.v1.0.0\",\"versionId\":\"1.0.0\",\"full_id\":\"openEHR-EHR-OBSERVATION.text_report.v1.0.0\",\"semantic_id\":\"openEHR-EHR-OBSERVATION.text_report.v1\"},\"rm_version\":\"1.0.4\"},\"archetype_node_id\":\"id0.2\",\"data\":{\"@type\":\"HISTORY\",\"archetype_node_id\":\"id2\",\"events\":[{\"@type\":\"POINT_EVENT\",\"archetype_node_id\":\"id3\",\"data\":{\"@type\":\"ITEM_TREE\",\"archetype_node_id\":\"id4\",\"items\":[{\"@type\":\"ELEMENT\",\"archetype_node_id\":\"id5\",\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Text report\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]/data[id4]/items[id5]\"}],\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]/data[id4]\"},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Point event\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]\",\"time\":{\"@type\":\"DV_DATE_TIME\",\"other_reference_ranges\":[],\"value\":\"2021-06-16T11:18:30.000+02:00\"}}],\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"\"},\"origin\":{\"@type\":\"DV_DATE_TIME\",\"other_reference_ranges\":[],\"value\":\"2021-06-16T11:18:30.000+02:00\"},\"path\":\"/content[id0.2]/data[id2]\"},\"encoding\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"UTF-8\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"IANA_character-sets\"}},\"language\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"en\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_639-1\"}},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Text report\"},\"other_participations\":[],\"path\":\"/content[id0.2]\",\"subject\":{\"@type\":\"PARTY_SELF\"}}],\"language\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"en\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_639-1\"}},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Text report\"},\"path\":\"/\",\"territory\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"NL\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_3166-1\"}}}",
"pathsAndValues": "{\"/content[id0.2]/data[id2]/events[id3]/time/value\": \"2021-06-16T11:18:30.000+02:00\", \"/content[id0.2]/data[id2]/events[id3]/data[id4]/items[id5,1]\": \"Wondobservatie test\"}",
"authorizedEmployeeGroupsForRead": [],
"authorizedEmployeeGroupsForUpdate": [],
"itemTags": [],
"updatedAt": "2021-06-17T09:42:11.000+02:00",
"createdAt": "2018-06-08T00:00:00.000+02:00",
"createdBy": "Mevr. Celia Mae",
"uuid": "e3d332a0-27bf-42f8-8d7c-0997a9b74ae9",
"instructions": []
}
]
}
},
"openehr.CompositionValidationErrorResponse": {
"type": "object",
"properties": {
"errorResponseEntries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.CompositionValidationErrorEntry"
}
}
},
"description": "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 errorResponseEntries so that clients written against ErrorResponse keep working.",
"example": {
"errorResponseEntries": [
{
"field": "/content[id0001]/data",
"value": "",
"archetypeId": "openEHR-EHR-EVALUATION.problem_diagnosis.v1",
"archetypePath": "/data",
"message": "Attribuut data van class EVALUATION komt niet overeen met existence 1..1",
"type": "REQUIRED"
},
{
"field": "/content[id0006]/data[id0002]/events[id0003]/data[id0004]/items[id0005]/value",
"value": "5",
"archetypeId": "openEHR-EHR-OBSERVATION.braden_scale.v1",
"archetypePath": "/data[id0002]/events[id0003]/data[id0004]/items[id0005]/value",
"message": "Object komt niet overeen met tupel: [value, symbol] ∈ {\n\t[{4}, {[at66]}],\n\t[{3}, {[at67]}],\n\t[{2}, {[at68]}],\n\t[{1}, {[at69]}],\n\t[{0}, {[at70]}]\n}",
"type": "DEFAULT"
}
]
}
},
"openehr.CompositionValidationErrorEntry": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "The full path where the validation error occurred within the posted composition."
},
"value": {
"type": "string",
"description": "The value at `field` that was rejected by the validator, as text. Empty when the validation error is about an absent value, such as a missing required element."
},
"archetypeId": {
"type": "string",
"description": "The id of the archetype that the validation error occurred in. This can be a sub-archetype of the posted composition, for example one slotted in at runtime or included with use_archetype."
},
"archetypePath": {
"type": "string",
"description": "The path where the validation error occurred within the archetype identified by `archetypeId`. When the validation error is about a node in the archetype of the posted composition itself, this is the same as `field`."
},
"message": {
"type": "string",
"description": "Technical message from the openEHR validator describing why validation failed. These messages are not understandable for end users and may change at any time, so they should not be shown to users. Use `type` to generate an understandable message instead."
},
"type": {
"$ref": "#/components/schemas/openehr.CompositionValidationErrorEntryType"
}
},
"description": "A single validation error found while creating or updating a composition.",
"example": {
"field": "/content[id0001]/data",
"value": "",
"archetypeId": "openEHR-EHR-EVALUATION.problem_diagnosis.v1",
"archetypePath": "/data",
"message": "Attribuut data van class EVALUATION komt niet overeen met existence 1..1",
"type": "REQUIRED"
}
},
"openehr.CompositionValidationErrorEntryType": {
"enum": [
"DEFAULT",
"REQUIRED",
"WRONG_TYPE",
"CARDINALITY_MISMATCH",
"EMPTY_OBSERVATION",
"ARCHETYPE_SLOT_ID_MISMATCH",
"ARCHETYPE_NOT_FOUND",
"INVARIANT_ERROR",
"EXCEPTION"
],
"type": "string",
"description": "The kind of validation error reported by a composition validation error entry.\n\nThe `message` of an entry is raw output of the openEHR validator and is not understandable for end users. Clients should switch on this type to generate an understandable message themselves, and should treat an unknown type as `DEFAULT`.\n* **DEFAULT**: A validation error that does not fall into any of the other categories.\n* **REQUIRED**: A required element is missing.\n* **WRONG_TYPE**: The value at the field does not have the type required by the archetype.\n* **CARDINALITY_MISMATCH**: The cardinality of an attribute violates the cardinality constraint of the archetype.\n* **EMPTY_OBSERVATION**: An observation was submitted without any data.\n* **ARCHETYPE_SLOT_ID_MISMATCH**: The archetype filling an archetype slot does not match the constraint on that slot.\n* **ARCHETYPE_NOT_FOUND**: The referenced archetype could not be found.\n* **INVARIANT_ERROR**: An openEHR reference model invariant was violated.\n* **EXCEPTION**: An unexpected exception occurred while validating the composition.",
"example": "REQUIRED"
},
"openehr.list.CompositionVersionWrapperList": {
"type": "object",
"properties": {
"compositionVersionWrappers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.CompositionVersionWrapper"
},
"nullable": true
}
},
"description": "CompositionVersionWrapperList model (no description)",
"example": {
"compositionVersionWrappers": [
{
"id": 1,
"uid": "e3d332a0-27bf-42f8-8d7c-0997a9b74ae9::nl.ons-ehr-db.NE0001::1",
"ehrId": 1,
"versionedCompositionId": 1,
"objectVersion": "1",
"timeCommitted": "2021-06-16T11:18:30.000+02:00",
"committerName": "Dhr. Mike Wazowski",
"committerEmployeeId": 1,
"lifecycleState": "COMPLETE",
"composerName": "Dhr. Mike Wazowski",
"composerEmployeeId": 1,
"archetypeId": "openEHR-EHR-COMPOSITION.dummy_archetype.v1.0.0",
"referenceModelObject": "{\"@type\":\"COMPOSITION\",\"archetype_details\":{\"@type\":\"ARCHETYPED\",\"archetype_id\":{\"@type\":\"ARCHETYPE_ID\",\"domain_concept\":\"dummy_archetype\",\"qualified_rm_entity\":\"openEHR-EHR-COMPOSITION\",\"rm_entity\":\"COMPOSITION\",\"rm_name\":\"EHR\",\"rm_originator\":\"openEHR\",\"value\":\"openEHR-EHR-COMPOSITION.dummy_archetype.v1.0.0\",\"versionId\":\"1.0.0\",\"full_id\":\"openEHR-EHR-COMPOSITION.dummy_archetype.v1.0.0\",\"semantic_id\":\"openEHR-EHR-COMPOSITION.dummy_archetype.v1\"},\"rm_version\":\"1.0.4\"},\"archetype_node_id\":\"id1.1\",\"category\":{\"@type\":\"DV_CODED_TEXT\",\"defining_code\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"at1\"},\"mappings\":[],\"value\":\"event\"},\"composer\":{\"@type\":\"PARTY_IDENTIFIED\",\"external_ref\":{\"@type\":\"PARTY_REF\",\"id\":{\"@type\":\"HIER_OBJECT_ID\",\"value\":\"com.nedap.NE0001.employee::7\"},\"namespace\":\"demographic\",\"type\":\"PERSON\"},\"identifiers\":[],\"name\":\"TestEmployee\"},\"content\":[{\"@type\":\"OBSERVATION\",\"archetype_details\":{\"@type\":\"ARCHETYPED\",\"archetype_id\":{\"@type\":\"ARCHETYPE_ID\",\"domain_concept\":\"ovl-text_report-story-001\",\"qualified_rm_entity\":\"openEHR-EHR-OBSERVATION\",\"rm_entity\":\"OBSERVATION\",\"rm_name\":\"EHR\",\"rm_originator\":\"openEHR\",\"value\":\"openEHR-EHR-OBSERVATION.ovl-text_report-story-001.v1.0.0\",\"versionId\":\"1.0.0\",\"full_id\":\"openEHR-EHR-OBSERVATION.ovl-text_report-story-001.v1.0.0\",\"semantic_id\":\"openEHR-EHR-OBSERVATION.ovl-text_report-story-001.v1\"},\"rm_version\":\"1.0.4\"},\"archetype_node_id\":\"id0.2\",\"data\":{\"@type\":\"HISTORY\",\"archetype_node_id\":\"id2\",\"events\":[{\"@type\":\"POINT_EVENT\",\"archetype_node_id\":\"id3\",\"data\":{\"@type\":\"ITEM_TREE\",\"archetype_node_id\":\"id4\",\"items\":[{\"@type\":\"ELEMENT\",\"archetype_node_id\":\"id5.1\",\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Story\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]/data[id4]/items[id5.1]\",\"value\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"This is an initial dummy value\"}}],\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]/data[id4]\"},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Any event\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]\",\"time\":{\"@type\":\"DV_DATE_TIME\",\"other_reference_ranges\":[],\"value\":\"2021-06-16T11:18:30+0100\"}}],\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"\"},\"origin\":{\"@type\":\"DV_DATE_TIME\",\"other_reference_ranges\":[],\"value\":\"2021-06-16T11:18:30+0100\"},\"path\":\"/content[id0.2]/data[id2]\"},\"encoding\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"UTF-8\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"IANA_character-sets\"}},\"language\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"en\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_639-1\"}},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Story/History\"},\"other_participations\":[],\"path\":\"/content[id0.2]\",\"subject\":{\"@type\":\"PARTY_SELF\"}}],\"language\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"en\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_639-1\"}},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Text report\"},\"path\":\"/\",\"territory\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"NL\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_3166-1\"}}}",
"pathsAndValues": "{\"/content[id0.2]/data[id2]/events[id3]/time/value\": \"2021-06-16T11:18:30+0100\", \"/content[id0.2]/data[id2]/events[id3]/data[id4]/items[id5.1]/value[id10.1]/value\": \"This is an initial dummy value\"}",
"signature": "Dummy",
"attestationPending": false
},
{
"id": 2,
"uid": "e3d332a0-27bf-42f8-8d7c-0997a9b74ae9::nl.ons-ehr-db.NE0001::2",
"ehrId": 1,
"versionedCompositionId": 1,
"objectVersion": "2",
"precedingVersionId": 1,
"timeCommitted": "2021-06-16T11:19:00.000+02:00",
"committerName": "Dhr. Mike Wazowski",
"committerEmployeeId": 1,
"lifecycleState": "COMPLETE",
"composerName": "Dhr. Mike Wazowski",
"composerEmployeeId": 1,
"archetypeId": "openEHR-EHR-COMPOSITION.dummy_archetype.v1.0.0",
"referenceModelObject": "{\"@type\":\"COMPOSITION\",\"archetype_details\":{\"@type\":\"ARCHETYPED\",\"archetype_id\":{\"@type\":\"ARCHETYPE_ID\",\"domain_concept\":\"dummy_archetype\",\"qualified_rm_entity\":\"openEHR-EHR-COMPOSITION\",\"rm_entity\":\"COMPOSITION\",\"rm_name\":\"EHR\",\"rm_originator\":\"openEHR\",\"value\":\"openEHR-EHR-COMPOSITION.dummy_archetype.v1.0.0\",\"versionId\":\"1.0.0\",\"full_id\":\"openEHR-EHR-COMPOSITION.dummy_archetype.v1.0.0\",\"semantic_id\":\"openEHR-EHR-COMPOSITION.dummy_archetype.v1\"},\"rm_version\":\"1.0.4\"},\"archetype_node_id\":\"id1.1\",\"category\":{\"@type\":\"DV_CODED_TEXT\",\"defining_code\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"at1\"},\"mappings\":[],\"value\":\"event\"},\"composer\":{\"@type\":\"PARTY_IDENTIFIED\",\"external_ref\":{\"@type\":\"PARTY_REF\",\"id\":{\"@type\":\"HIER_OBJECT_ID\",\"value\":\"com.nedap.NE0001.employee::7\"},\"namespace\":\"demographic\",\"type\":\"PERSON\"},\"identifiers\":[],\"name\":\"TestEmployee\"},\"content\":[{\"@type\":\"OBSERVATION\",\"archetype_details\":{\"@type\":\"ARCHETYPED\",\"archetype_id\":{\"@type\":\"ARCHETYPE_ID\",\"domain_concept\":\"ovl-text_report-story-001\",\"qualified_rm_entity\":\"openEHR-EHR-OBSERVATION\",\"rm_entity\":\"OBSERVATION\",\"rm_name\":\"EHR\",\"rm_originator\":\"openEHR\",\"value\":\"openEHR-EHR-OBSERVATION.ovl-text_report-story-001.v1.0.0\",\"versionId\":\"1.0.0\",\"full_id\":\"openEHR-EHR-OBSERVATION.ovl-text_report-story-001.v1.0.0\",\"semantic_id\":\"openEHR-EHR-OBSERVATION.ovl-text_report-story-001.v1\"},\"rm_version\":\"1.0.4\"},\"archetype_node_id\":\"id0.2\",\"data\":{\"@type\":\"HISTORY\",\"archetype_node_id\":\"id2\",\"events\":[{\"@type\":\"POINT_EVENT\",\"archetype_node_id\":\"id3\",\"data\":{\"@type\":\"ITEM_TREE\",\"archetype_node_id\":\"id4\",\"items\":[{\"@type\":\"ELEMENT\",\"archetype_node_id\":\"id5.1\",\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Story\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]/data[id4]/items[id5.1]\",\"value\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"This is an updated dummy value\"}}],\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]/data[id4]\"},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Any event\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]\",\"time\":{\"@type\":\"DV_DATE_TIME\",\"other_reference_ranges\":[],\"value\":\"2021-06-16T11:18:30+0100\"}}],\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"\"},\"origin\":{\"@type\":\"DV_DATE_TIME\",\"other_reference_ranges\":[],\"value\":\"2021-06-16T11:18:30+0100\"},\"path\":\"/content[id0.2]/data[id2]\"},\"encoding\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"UTF-8\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"IANA_character-sets\"}},\"language\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"en\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_639-1\"}},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Story/History\"},\"other_participations\":[],\"path\":\"/content[id0.2]\",\"subject\":{\"@type\":\"PARTY_SELF\"}}],\"language\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"en\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_639-1\"}},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Text report\"},\"path\":\"/\",\"territory\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"NL\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_3166-1\"}}}",
"pathsAndValues": "{\"/content[id0.2]/data[id2]/events[id3]/time/value\": \"2021-06-16T11:18:30+0100\", \"/content[id0.2]/data[id2]/events[id3]/data[id4]/items[id5.1]/value[id10.1]/value\": \"This is an updated dummy value\"}",
"signature": "Dummy",
"attestationPending": false
}
]
}
},
"openehr.CompositionVersionWrapper": {
"required": [
"id",
"objectVersion",
"timeCommitted",
"lifecycleState",
"archetypeId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"uid": {
"type": "string",
"description": "The UID of the composition version with lexical form: 'object_id::creating_system_id::version_tree_id'"
},
"ehrId": {
"type": "integer",
"description": "The numberic id of the EHR containing the composition version",
"format": "int64"
},
"versionedCompositionId": {
"type": "integer",
"description": "The id of the versionedComposition",
"format": "int64"
},
"objectVersion": {
"type": "string",
"description": "The Composition version number as specified by openEHR. 1, 2, 3 for main versions, 1.1, 1.2, 1.3 for different branches, etc"
},
"precedingVersionId": {
"type": "integer",
"description": "The composition version that precedes this composition version",
"format": "int64"
},
"timeCommitted": {
"type": "string",
"description": "Fetched from the contribution. Time that the composition was committed",
"format": "date-time"
},
"committerName": {
"type": "string",
"description": "Fetched from the contribution. Name of the committer of the composition",
"nullable": true
},
"committerEmployeeId": {
"type": "integer",
"description": "Fetched from contribution. Administratie employee id of the committer of the composition",
"format": "int64"
},
"lifecycleState": {
"type": "string",
"description": "State of this particular composition version with possible values: COMPLETE, INCOMPLETE, DELETED",
"nullable": true
},
"composerName": {
"type": "string",
"description": "Name of the composer of this composition version",
"nullable": true
},
"composerEmployeeId": {
"type": "integer",
"description": "Administration employee id of the composer of the composition",
"format": "int64"
},
"archetypeId": {
"type": "string",
"description": "The id of the archetype version contained in this composition version"
},
"referenceModelObject": {
"type": "string",
"description": "The json RM object",
"nullable": true
},
"pathsAndValues": {
"type": "string",
"description": "Contents of this composition version in JSON format",
"nullable": true
},
"signature": {
"type": "string",
"description": "Digital signature of the committer",
"nullable": true
},
"attestationPending": {
"type": "boolean",
"description": "True if this stored composition version is awaiting an attestation",
"nullable": true
}
},
"description": "CompositionVersionWrapper model (no description)",
"example": {
"id": 2,
"uid": "e3d332a0-27bf-42f8-8d7c-0997a9b74ae9::nl.ons-ehr-db.NE0001::2",
"ehrId": 1,
"versionedCompositionId": 1,
"objectVersion": "2",
"precedingVersionId": 1,
"timeCommitted": "2021-06-16T11:18:30.000+02:00",
"committerName": "Dhr. Mike Wazowski",
"committerEmployeeId": 1,
"lifecycleState": "COMPLETE",
"composerName": "Dhr. Mike Wazowski",
"composerEmployeeId": 1,
"archetypeId": "openEHR-EHR-COMPOSITION.text_report.v1.0.0",
"referenceModelObject": "{\"@type\":\"COMPOSITION\",\"archetype_details\":{\"@type\":\"ARCHETYPED\",\"archetype_id\":{\"@type\":\"ARCHETYPE_ID\",\"domain_concept\":\"text_report\",\"qualified_rm_entity\":\"openEHR-EHR-COMPOSITION\",\"rm_entity\":\"COMPOSITION\",\"rm_name\":\"EHR\",\"rm_originator\":\"openEHR\",\"value\":\"openEHR-EHR-COMPOSITION.text_report.v1.0.0\",\"versionId\":\"1.0.0\",\"full_id\":\"openEHR-EHR-COMPOSITION.text_report.v1.0.0\",\"semantic_id\":\"openEHR-EHR-COMPOSITION.text_report.v1\"},\"rm_version\":\"1.0.4\"},\"archetype_node_id\":\"id1.1\",\"category\":{\"@type\":\"DV_CODED_TEXT\",\"defining_code\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"433\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"openehr\"}},\"mappings\":[],\"value\":\"event\"},\"composer\":{\"@type\":\"PARTY_IDENTIFIED\",\"external_ref\":{\"@type\":\"PARTY_REF\",\"id\":{\"@type\":\"HIER_OBJECT_ID\",\"value\":\"com.nedap.NE0001.employee::2\"},\"namespace\":\"demographic\",\"type\":\"PERSON\"},\"identifiers\":[],\"name\":\"administrator\"},\"content\":[{\"@type\":\"OBSERVATION\",\"archetype_details\":{\"@type\":\"ARCHETYPED\",\"archetype_id\":{\"@type\":\"ARCHETYPE_ID\",\"domain_concept\":\"text_report\",\"qualified_rm_entity\":\"openEHR-EHR-OBSERVATION\",\"rm_entity\":\"OBSERVATION\",\"rm_name\":\"EHR\",\"rm_originator\":\"openEHR\",\"value\":\"openEHR-EHR-OBSERVATION.text_report.v1.0.0\",\"versionId\":\"1.0.0\",\"full_id\":\"openEHR-EHR-OBSERVATION.text_report.v1.0.0\",\"semantic_id\":\"openEHR-EHR-OBSERVATION.text_report.v1\"},\"rm_version\":\"1.0.4\"},\"archetype_node_id\":\"id0.2\",\"data\":{\"@type\":\"HISTORY\",\"archetype_node_id\":\"id2\",\"events\":[{\"@type\":\"POINT_EVENT\",\"archetype_node_id\":\"id3\",\"data\":{\"@type\":\"ITEM_TREE\",\"archetype_node_id\":\"id4\",\"items\":[{\"@type\":\"ELEMENT\",\"archetype_node_id\":\"id5\",\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Text report\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]/data[id4]/items[id5]\"}],\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]/data[id4]\"},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Point event\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]\",\"time\":{\"@type\":\"DV_DATE_TIME\",\"other_reference_ranges\":[],\"value\":\"2021-06-16T11:18:30.000+02:00\"}}],\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"\"},\"origin\":{\"@type\":\"DV_DATE_TIME\",\"other_reference_ranges\":[],\"value\":\"2021-06-16T11:18:30.000+02:00\"},\"path\":\"/content[id0.2]/data[id2]\"},\"encoding\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"UTF-8\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"IANA_character-sets\"}},\"language\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"en\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_639-1\"}},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Text report\"},\"other_participations\":[],\"path\":\"/content[id0.2]\",\"subject\":{\"@type\":\"PARTY_SELF\"}}],\"language\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"en\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_639-1\"}},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Text report\"},\"path\":\"/\",\"territory\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"NL\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_3166-1\"}}}",
"pathsAndValues": "{\"/content[id0.2]/data[id2]/events[id3]/time/value\": \"2021-06-16T11:18:30.000+02:00\", \"/content[id0.2]/data[id2]/events[id3]/data[id4]/items[id5,1]\": \"Tekst rapportage test\"}",
"signature": "ea599408eeb005b1013131bd7d2bc05faf9b9b97",
"attestationPending": false
}
},
"openehr.list.LinkedReferenceModelObjectWrapperList": {
"type": "object",
"properties": {
"linkedReferenceModelObjectWrappers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.LinkedReferenceModelObjectWrapper"
},
"nullable": true
}
},
"description": "List of wrapper openEHR LinkedReferenceModelObjects.",
"example": {
"linkedReferenceModelObjectWrappers": [
{
"id": 1,
"ehrId": 1,
"clientId": 1,
"archetypeId": "openEHR-EHR-COMPOSITION.wound.v0.0.0",
"storedCompositionId": 5,
"versionedCompositionUuid": "e3d332a0-27bf-42f8-8d7c-0997a9b74ae8",
"type": "COMPOSITION",
"firstEventTime": "2018-06-08T00:00:00.000+02:00",
"composerId": 9,
"composerName": "R den Doorn",
"composerEmployeeId": 5,
"timeCommitted": "2018-06-08T00:00:00.000+02:00",
"committerName": "R den Doorn",
"committerEmployeeId": 5,
"authorizedForUpdate": true,
"lifecycleState": "COMPLETE",
"referenceModelObject": "{\"@type\":\"COMPOSITION\",\"links\":[{\"target\":{\"@type\":\"DV_EHR_URI\",\"value\":\"ehr:compositions/1\"}}]}",
"pathsAndValues": "{\"/links/target/value\":\"ehr:compositions/1\"}",
"updatedAt": "2018-06-08T00:00:00.000+02:00",
"createdAt": "2018-06-08T00:00:00.000+02:00",
"createdBy": "R den Doorn",
"sourcePath": "/",
"targetEhrUri": "ehr:compositions/1"
},
{
"id": 2,
"ehrId": 1,
"clientId": 1,
"archetypeId": "openEHR-EHR-COMPOSITION.wound.v0.0.0",
"storedCompositionId": 6,
"versionedCompositionUuid": "e3d332a0-27bf-42f8-8d7c-0997a9b74ae9",
"type": "COMPOSITION",
"firstEventTime": "2018-06-08T00:00:00.000+02:00",
"composerId": 9,
"composerName": "R den Doorn",
"composerEmployeeId": 5,
"timeCommitted": "2018-06-08T00:00:00.000+02:00",
"committerName": "R den Doorn",
"committerEmployeeId": 5,
"authorizedForUpdate": true,
"lifecycleState": "COMPLETE",
"referenceModelObject": "{\"@type\":\"COMPOSITION\",\"content\":[{\"@type\":\"OBSERVATION\",\"archetype_node_id\":\"id0.0.100.1\",\"links\":[{\"target\":{\"@type\":\"DV_EHR_URI\",\"value\":\"ehr:compositions/97/content%5Bid0.2%5D/data%5Bid2%5D/events%5Bid3%5D\"}}]}]}",
"pathsAndValues": "{\"/content[id0.0.100.1,1]/links/target/value\":\"ehr:compositions/1/content%5Bid0.2%5D/data%5Bid2%5D/events%5Bid3%5D\"}",
"updatedAt": "2018-06-08T00:00:00.000+02:00",
"createdAt": "2018-06-08T00:00:00.000+02:00",
"createdBy": "R den Doorn",
"sourcePath": "/content[id0.0.100.1,1]",
"targetEhrUri": "ehr:compositions/1/content%5Bid0.2%5D/data%5Bid2%5D/events%5Bid3%5D",
"targetPathInsideTopLevelStructure": "/content[id0.2]/data[id2]/events[id3]",
"linkMeaningValue": "Meaning",
"linkTypeValue": "Type"
}
]
}
},
"openehr.LinkedReferenceModelObjectWrapper": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/openehr.ReferenceModelObjectWrapper"
}
],
"properties": {
"sourcePath": {
"type": "string",
"description": "String containing the path from where the link is made.\nExample: \"/\" or \"/content[id0.2]/data[id2]/events[id3]\".",
"nullable": true
},
"targetEhrUri": {
"type": "string",
"description": "String containing the full target EHR URI of the link.\nNote: Some characters might be escaped, e.g. square brackets can be %5B and %5D and spaces can be %20.\nExample: \"ehr:/32/compositions/42\" or\n\"ehr:compositions/20/content[id0.2]/data[id2]/events[id3]/data[id4]/items[id5.1]\" or\n\"ehr:compositions/20/content%5Bid0.2%5D/data%5Bid2%5D/events%5Bid3%5D/data%5Bid4%5D/items%5Bid5.1%5D\".",
"nullable": true
},
"targetPathInsideTopLevelStructure": {
"type": "string",
"description": "String containing target path inside the top level structure (composition).\nNull when linked to the composition root.\nNote: This will not contain escaped characters.\nExample: \"/content[id0.2]/data[id2]/events[id3]/data[id4]/items[id5.1]\".",
"nullable": true
},
"linkMeaningValue": {
"type": "string",
"description": "String containing meaning value of the link.\nExample: \"related information\".",
"nullable": true
},
"linkTypeValue": {
"type": "string",
"description": "String containing type value of the link.\nExample: \"intake\".",
"nullable": true
}
},
"description": "OpenEHR Linked Reference Model Object Wrapper model.\nObject to return an LinkedReferenceModelObjectWrapper.\n\nThis object includes additional information about linked Reference Model Objects.\n\nCreated on 19/02/2019.",
"example": {
"id": 1,
"ehrId": 1,
"clientId": 1,
"archetypeId": "openEHR-EHR-COMPOSITION.wound.v0.0.0",
"storedCompositionId": 5,
"versionedCompositionUuid": "e3d332a0-27bf-42f8-8d7c-0997a9b74ae8",
"type": "COMPOSITION",
"firstEventTime": "2019-02-18T00:00:00.000+01:00",
"composerId": 9,
"composerName": "R den Doorn",
"composerEmployeeId": 5,
"timeCommitted": "2019-02-18T00:00:00.000+01:00",
"committerName": "R den Doorn",
"committerEmployeeId": 5,
"authorizedForUpdate": true,
"lifecycleState": "COMPLETE",
"referenceModelObject": "{\"@type\":\"COMPOSITION\",\"content\":[{\"@type\":\"OBSERVATION\",\"archetype_node_id\":\"id0.0.100.1\",\"links\":[{\"target\":{\"@type\":\"DV_EHR_URI\",\"value\":\"ehr:compositions/97/content%5Bid0.2%5D/data%5Bid2%5D/events%5Bid3%5D\"}}]}]}",
"pathsAndValues": "{\"/content[id0.0.100.1,1]/links/target/value\":\"ehr:compositions/1/content%5Bid0.2%5D/data%5Bid2%5D/events%5Bid3%5D\"}",
"authorizedEmployeeGroupsForRead": [],
"authorizedEmployeeGroupsForUpdate": [
{
"id": 57,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
},
{
"id": 58,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
}
],
"itemTags": [
{
"id": 59,
"key": "important",
"value": "value",
"targetPath": "/content[id0.1]/data[id2]/events[id3]/data[id4]/items[id5]"
}
],
"updatedAt": "2019-02-18T00:00:00.000+01:00",
"createdAt": "2019-02-18T00:00:00.000+01:00",
"createdBy": "R den Doorn",
"sourcePath": "/content[id0.0.100.1,1]",
"targetEhrUri": "ehr:compositions/1/content%5Bid0.2%5D/data%5Bid2%5D/events%5Bid3%5D",
"targetPathInsideTopLevelStructure": "/content[id0.2]/data[id2]/events[id3]",
"linkMeaningValue": "Meaning",
"linkTypeValue": "Type",
"instructions": []
}
},
"openehr.RuleEvaluationResult": {
"type": "object",
"properties": {
"compositionAfterRuleEvaluation": {
"type": "string",
"description": "String containing the JSON-blob with the openEHR referenceModelObject obtained after rule evaluation of the build composition in Chiron.",
"nullable": true
},
"evaluationResult": {
"type": "string",
"description": "String containing the evaluationResult\nExample:\n\"evaluation_result\": {\n\"assertion_results\": [],\n\"paths_that_must_not_exist\": [],\n\"set_path_values\": {},\n\"paths_that_must_exist\": []\n}",
"nullable": true,
"example": "\"evaluation_result\": {\n \"assertion_results\": [],\n \"paths_that_must_not_exist\": [],\n \"set_path_values\": {},\n \"paths_that_must_exist\": []\n}"
},
"validationMessages": {
"type": "string",
"description": "String containing the validationMessages\nExample: \"validation_messages\":\n\"validation_messages\": [\n{\n\"archetype_path\": \"/category\",\n\"path\": \"/category\",\n\"human_readable_archetype_path\": \"/category\",\n\"message\": \"Attribute category of class COMPOSITION does not match existence 1..1\",\n\"type\": \"REQUIRED\"\n}\n]",
"nullable": true,
"example": "\"validation_messages\": [\n {\n \"archetype_path\": \"/category\",\n \"path\": \"/category\",\n \"human_readable_archetype_path\": \"/category\",\n \"message\": \"Attribute category of class COMPOSITION does not match existence 1..1\",\n \"type\": \"REQUIRED\"\n }\n]"
}
},
"description": "OpenEHR RuleEvaluationResult model.\nObject to return an RuleEvaluationResult, which checks the rules of an archetype.\n\nCreated on 18/06/2018.",
"example": {
"compositionAfterRuleEvaluation": "{\"@type\":\"COMPOSITION\",\"archetype_details\":{\"@type\":\"ARCHETYPED\",\"archetype_id\":{\"@type\":\"ARCHETYPE_ID\",\"domain_concept\":\"text_report\",\"qualified_rm_entity\":\"openEHR-EHR-COMPOSITION\",\"rm_entity\":\"COMPOSITION\",\"rm_name\":\"EHR\",\"rm_originator\":\"openEHR\",\"value\":\"openEHR-EHR-COMPOSITION.text_report.v1.0.0\",\"versionId\":\"1.0.0\",\"full_id\":\"openEHR-EHR-COMPOSITION.text_report.v1.0.0\",\"semantic_id\":\"openEHR-EHR-COMPOSITION.text_report.v1\"},\"rm_version\":\"1.0.4\"},\"archetype_node_id\":\"id1.1\",\"category\":{\"@type\":\"DV_CODED_TEXT\",\"defining_code\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"433\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"openehr\"}},\"mappings\":[],\"value\":\"event\"},\"composer\":{\"@type\":\"PARTY_IDENTIFIED\",\"external_ref\":{\"@type\":\"PARTY_REF\",\"id\":{\"@type\":\"HIER_OBJECT_ID\",\"value\":\"com.nedap.NE0001.employee::2\"},\"namespace\":\"demographic\",\"type\":\"PERSON\"},\"identifiers\":[],\"name\":\"administrator\"},\"content\":[{\"@type\":\"OBSERVATION\",\"archetype_details\":{\"@type\":\"ARCHETYPED\",\"archetype_id\":{\"@type\":\"ARCHETYPE_ID\",\"domain_concept\":\"text_report\",\"qualified_rm_entity\":\"openEHR-EHR-OBSERVATION\",\"rm_entity\":\"OBSERVATION\",\"rm_name\":\"EHR\",\"rm_originator\":\"openEHR\",\"value\":\"openEHR-EHR-OBSERVATION.text_report.v1.0.0\",\"versionId\":\"1.0.0\",\"full_id\":\"openEHR-EHR-OBSERVATION.text_report.v1.0.0\",\"semantic_id\":\"openEHR-EHR-OBSERVATION.text_report.v1\"},\"rm_version\":\"1.0.4\"},\"archetype_node_id\":\"id0.2\",\"data\":{\"@type\":\"HISTORY\",\"archetype_node_id\":\"id2\",\"events\":[{\"@type\":\"POINT_EVENT\",\"archetype_node_id\":\"id3\",\"data\":{\"@type\":\"ITEM_TREE\",\"archetype_node_id\":\"id4\",\"items\":[{\"@type\":\"ELEMENT\",\"archetype_node_id\":\"id5\",\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Text report\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]/data[id4]/items[id5]\"}],\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]/data[id4]\"},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Point event\"},\"path\":\"/content[id0.2]/data[id2]/events[id3]\",\"time\":{\"@type\":\"DV_DATE_TIME\",\"other_reference_ranges\":[],\"value\":\"2021-06-16T11:18:30.000+02:00\"}}],\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"\"},\"origin\":{\"@type\":\"DV_DATE_TIME\",\"other_reference_ranges\":[],\"value\":\"2021-06-16T11:18:30.000+02:00\"},\"path\":\"/content[id0.2]/data[id2]\"},\"encoding\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"UTF-8\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"IANA_character-sets\"}},\"language\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"en\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_639-1\"}},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Text report\"},\"other_participations\":[],\"path\":\"/content[id0.2]\",\"subject\":{\"@type\":\"PARTY_SELF\"}}],\"language\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"en\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_639-1\"}},\"links\":[],\"name\":{\"@type\":\"DV_TEXT\",\"mappings\":[],\"value\":\"Text report\"},\"path\":\"/\",\"territory\":{\"@type\":\"CODE_PHRASE\",\"code_string\":\"NL\",\"terminology_id\":{\"@type\":\"TERMINOLOGY_ID\",\"value\":\"ISO_3166-1\"}}}",
"evaluationResult": "{\"assertion_results\":[\"raw result in json format per rule in the archetype\"],\"paths_that_must_exist\":[\"/content[id0.0.100.1]/data[id3]/events[id4]/data[id2]/items[id12]/items[id1201]/value[id1211]/magnitude\"],\"paths_that_must_not_exist\":[\"/content[id0.0.100.1]/data[id3]/events[id4]/data[id2]/items[id12]/items[id1201]/value[id124]/magnitude\"],\"set_path_values\":{\"/content[id0.0.100.1]/data[id3]/events[id4]/data[id2]/items[id5]/items[id508]/value/magnitude\":{\"paths\":[],\"null\":true},\"/content[id0.0.100.1]/data[id3]/events[id4]/data[id2]/items[id6]/items[id608]/value/magnitude\":{\"paths\":[],\"null\":true}}}",
"validationMessages": "[{\"archetype_path\":\"/content[id0.0.100.1]/data[id3]/events[id4]/data[id2]/items[id12]/items[id1201]/value[id1211]/magnitude\",\"path\":\"/content[id0.0.100.1, 1]/data[id3]/events[id4, 1]/data[id2]/items[id12, 1]/items[id1201, 1]/value/magnitude[id9999]\",\"human_readable_archetype_path\":\"/content[id0.0.100.1]/data[id3]/events[id4]/data[id2]/items[id12]/items[id1201]/value[id1211]/magnitude\",\"message\":\"De waarde 101 moet minimaal 0 en maximaal 100 zijn\",\"type\":\"DEFAULT\"},{\"archetype_path\":\"/content[id0.0.100.1]/data[id3]/events[id4]/data[id2]/items[id12]/items[id1202]\",\"path\":\"/content[id0.0.100.1, 1]/data[id3]/events[id4, 1]/data[id2]/items[id12, 1]/items[id1202]\",\"human_readable_archetype_path\":\"/content[id0.0.100.1]/data[id3]/events[id4]/data[id2]/items[id12]/items[id1202]\",\"message\":\"Attribuut komt 0 keer voor, maar dit moet 1..1 zijn\",\"type\":\"REQUIRED\"}]"
}
},
"openehr.list.CompositionValuesForArchetypeList": {
"type": "object",
"properties": {
"compositionValuesForArchetypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.CompositionValuesForArchetype"
}
}
},
"description": "List of the requested archetype ids and the values for the matching compositions. Will contain one entry for each of the requested archetype ids.",
"example": {
"compositionValuesForArchetypes": [
{
"archetypeId": "openEHR-EHR-OBSERVATION.bem.v1",
"compositionValues": [
{
"archetypeId": "openEHR-EHR-COMPOSITION.bem_ggz_report.v0.0.2",
"versionedCompositionId": 5,
"versionedCompositionUuid": "e3d332a0-27bf-42f8-8d7c-0997a9b74ae9",
"ehrId": 1,
"clientId": 3,
"composerId": 1,
"composerName": "Dhr. Mike Wazowski",
"composerEmployeeId": 10,
"timeCommitted": "2024-05-03T10:43:45.000+02:00",
"firstEventTime": "2023-05-03T10:43:45.000+02:00",
"lifecycleState": "COMPLETE",
"authorizedForUpdate": true,
"authorizedEmployeeGroupsForRead": [
{
"id": 57,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
}
],
"authorizedEmployeeGroupsForUpdate": [
{
"id": 57,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
}
],
"valuesForPath": [
{
"path": "/data[id2]/events[id3]/time/value",
"values": [
"\"2021-06-16T11:18:30+0100\""
]
},
{
"path": "/data[id2]/events[id3]/data[id4]/items[id31]/items[id77.1]/value/value",
"values": [
"\"Categorie 1: cliënt bestelt en gebruikt medicatie zelf\""
]
}
]
}
]
}
]
}
},
"openehr.CompositionValuesForArchetype": {
"type": "object",
"properties": {
"archetypeId": {
"type": "string",
"description": "The requested archetype id"
},
"compositionValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.CompositionValues"
},
"description": "List of compositions with the values for the requested paths"
}
},
"description": "The requested archetype id and returned composition data including values for requested paths",
"example": {
"archetypeId": "openEHR-EHR-OBSERVATION.bem.v1",
"compositionValues": [
{
"archetypeId": "openEHR-EHR-COMPOSITION.bem_ggz_report.v0.0.2",
"versionedCompositionId": 5,
"versionedCompositionUuid": "e3d332a0-27bf-42f8-8d7c-0997a9b74ae9",
"ehrId": 1,
"clientId": 3,
"composerId": 1,
"composerName": "Dhr. Mike Wazowski",
"composerEmployeeId": 10,
"timeCommitted": "2024-05-03T10:43:45.000+02:00",
"firstEventTime": "2023-05-03T10:43:45.000+02:00",
"lifecycleState": "COMPLETE",
"authorizedForUpdate": true,
"authorizedEmployeeGroupsForRead": [
{
"id": 57,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
}
],
"authorizedEmployeeGroupsForUpdate": [
{
"id": 57,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
}
],
"valuesForPath": [
{
"path": "/data[id2]/events[id3]/time/value",
"values": [
"\"2021-06-16T11:18:30+0100\""
]
},
{
"path": "/data[id2]/events[id3]/data[id4]/items[id31]/items[id77.1]/value/value",
"values": [
"\"Categorie 1: cliënt bestelt en gebruikt medicatie zelf\""
]
}
]
}
]
}
},
"openehr.CompositionValues": {
"type": "object",
"properties": {
"archetypeId": {
"type": "string",
"description": "The archetype id of the actual archetype of the composition"
},
"versionedCompositionId": {
"type": "integer",
"description": "The numberic id of the versioned composition",
"format": "int64"
},
"versionedCompositionUuid": {
"type": "string",
"description": "The UUID of the versioned composition"
},
"ehrId": {
"type": "integer",
"description": "The numberic id of the EHR containing the versioned composition",
"format": "int64"
},
"clientId": {
"type": "integer",
"description": "The id of the client in Ons Administratie to who this versioned composition belongs",
"format": "int64"
},
"composerId": {
"type": "integer",
"description": "The numberic id of the person in Chiron who composed this composition",
"format": "int64"
},
"composerName": {
"type": "string",
"description": "The name of the composer of this composition"
},
"composerEmployeeId": {
"type": "integer",
"description": "The id of the employee in Ons Administratie who composed this composition",
"format": "int64"
},
"timeCommitted": {
"type": "string",
"description": "The date/time the latest composition version of this composition was committed",
"format": "date-time"
},
"firstEventTime": {
"type": "string",
"description": "The date/time of the chronological first event in this composition",
"format": "date-time"
},
"lifecycleState": {
"type": "string",
"description": "State of this particular composition version with possible values: COMPLETE, INCOMPLETE, ABANDONED, INACTIVE, DELETED"
},
"authorizedForUpdate": {
"type": "boolean",
"description": "Indicates whether the current user is authorized to update this composition"
},
"authorizedEmployeeGroupsForRead": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.EmployeeGroup"
},
"description": "List of EmployeeGroups who are by allowed to read this composition. An empty list means all employees are allowed to read this composition."
},
"authorizedEmployeeGroupsForUpdate": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.EmployeeGroup"
},
"description": "List of EmployeeGroups who are allowed to update this composition. An empty list means all employees are allowed to update this composition."
},
"valuesForPath": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.CompositionValuesForPath"
},
"description": "List of requested paths with their values from the composition."
},
"itemTags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.ItemTag"
},
"description": "List of {@link ItemTag}s connected to this composition."
}
},
"description": "Values of a specific Composition, including the values for the requested path",
"example": {
"archetypeId": "openEHR-EHR-COMPOSITION.bem_ggz_report.v0.0.2",
"versionedCompositionId": 5,
"versionedCompositionUuid": "e3d332a0-27bf-42f8-8d7c-0997a9b74ae9",
"ehrId": 1,
"clientId": 3,
"composerId": 1,
"composerName": "Dhr. Mike Wazowski",
"composerEmployeeId": 10,
"timeCommitted": "2024-05-03T10:43:45.000+02:00",
"firstEventTime": "2023-05-03T10:43:45.000+02:00",
"lifecycleState": "COMPLETE",
"authorizedForUpdate": true,
"authorizedEmployeeGroupsForRead": [
{
"id": 1,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
}
],
"authorizedEmployeeGroupsForUpdate": [
{
"id": 1,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
}
],
"valuesForPath": [
{
"path": "/data[id2]/events[id3]/time/value",
"values": [
"\"2021-06-16T11:18:30+0100\""
]
},
{
"path": "/data[id2]/events[id3]/data[id4]/items[id31]/items[id77.1]/value/value",
"values": [
"\"Categorie 1: cliënt bestelt en gebruikt medicatie zelf\""
]
}
],
"itemTags": [
{
"id": 59,
"key": "important",
"value": "value",
"targetPath": "/content[id0.1]/data[id2]/events[id3]/data[id4]/items[id5]"
},
{
"id": 60,
"key": "evaluation",
"value": "value",
"targetPath": "/content[id0.1]/data[id2]/events[id3]/data[id4]/items[id7]"
}
]
}
},
"openehr.CompositionValuesForPath": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "The requested path"
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of JSON-encoded values for the requested path in this composition"
}
},
"description": "Combination of requested path and its values in this composition",
"example": {
"path": "/data[id2]/events[id3]/time/value",
"values": [
"\"2021-06-16T11:18:30+0100\""
]
}
},
"openehr.list.EmployeeGroupList": {
"type": "object",
"properties": {
"employeeGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.EmployeeGroup"
}
}
},
"description": "EmployeeGroupList model (no description)",
"example": {
"employeeGroups": [
{
"id": 132,
"employeeGroupType": "EXPERTISE_GROUP",
"originatingSystemId": "Administratie",
"originatingSystemItemId": "11",
"parentGroups": [
{
"id": 57,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "TestGroup",
"deleted": false
}
],
"childGroups": [
{
"id": 134,
"employeeGroupType": "EXPERTISE_PROFILE",
"name": "Profile1",
"deleted": false
}
],
"name": "Group1",
"beginDate": "2020-05-11",
"endDate": "2020-05-25",
"deleted": false
},
{
"id": 133,
"employeeGroupType": "EXPERTISE_GROUP",
"name": "Group2",
"deleted": false
},
{
"id": 134,
"employeeGroupType": "EXPERTISE_PROFILE",
"originatingSystemId": "Administratie",
"originatingSystemItemId": "13",
"name": "Profile1",
"parentGroups": [
{
"id": 132,
"employeeGroupType": "EXPERTISE_GROUP",
"originatingSystemId": "Administratie",
"originatingSystemItemId": "11",
"name": "Group1",
"beginDate": "2020-05-11",
"endDate": "2020-05-25",
"deleted": false
}
],
"beginDate": "2020-05-17",
"deleted": false
},
{
"id": 135,
"employeeGroupType": "EXPERTISE_PROFILE",
"name": "Profile2",
"endDate": "2020-05-19",
"deleted": true
}
]
}
},
"ons_ehr.LastVisitedPlan": {
"type": "object",
"properties": {
"planType": {
"allOf": [
{
"$ref": "#/components/schemas/ons_ehr.LastVisitedPlanType"
}
],
"description": "The type of plan last visited"
},
"employeeId": {
"type": "integer",
"description": "The employee id",
"format": "int64",
"x-cupido-id": true
}
},
"description": "Last visited plan",
"example": {
"planType": "care_plan",
"employeeId": 123
}
},
"ons_ehr.LastVisitedPlanType": {
"enum": [
"ggz_plan",
"sfmpc_plan",
"care_plan"
],
"type": "string",
"description": "Unique code that identifies the visited plan type",
"example": "sfmpc_plan"
},
"ons_ehr.GgzPlanStatistics": {
"type": "object",
"properties": {
"customerCode": {
"type": "string"
},
"pilotEnabled": {
"type": "boolean"
},
"plans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ons_ehr.GgzPlanStatistic"
}
}
},
"description": "GgzPlanStatistics model",
"example": {
"customerCode": "NE0001",
"pilotEnabled": true,
"plans": [
{
"planId": 1,
"clientId": "2",
"createdAt": "2023-10-12T10:00:00.000+02:00",
"employeeId": "3"
}
]
}
},
"ons_ehr.GgzPlanStatistic": {
"type": "object",
"properties": {
"planId": {
"type": "integer",
"description": "The plan composition id",
"format": "int64"
},
"clientId": {
"type": "string",
"description": "The client id"
},
"createdAt": {
"type": "string",
"description": "When the plan was created",
"format": "date-time"
},
"employeeId": {
"type": "string",
"description": "The employee id"
}
},
"description": "GgzPlanStatistic model",
"example": {
"planId": 1,
"clientId": "2",
"createdAt": "2023-10-12T10:00:00.000+02:00",
"employeeId": "3"
}
},
"ons_ehr.list.SettingList": {
"type": "object",
"properties": {
"settings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ons_ehr.Setting"
}
}
},
"description": "SettingList model (no description)",
"example": {
"settings": [
{
"name": "Setting1",
"value": "Abc"
},
{
"name": "Setting2",
"value": "true"
}
]
}
},
"ons_ehr.Setting": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the setting"
},
"value": {
"type": "string",
"description": "The value of the setting"
}
},
"description": "A setting from OnsEhr",
"example": {
"name": "XPilot",
"value": "true"
}
},
"openehr.list.CarePlanVvtCareProfileLinkList": {
"type": "object",
"properties": {
"carePlanVvtCareProfileLinks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/openehr.CarePlanVvtCareProfileLink"
}
}
},
"description": "CarePlanVvtCareProfileLinkList model (no description)",
"example": {
"carePlanVvtCareProfileLinks": [
{
"carePlanId": 1189,
"compositionId": 2077
},
{
"carePlanId": 8119,
"compositionId": 7022
}
]
}
},
"openehr.CarePlanVvtCareProfileLink": {
"type": "object",
"properties": {
"carePlanId": {
"type": "integer",
"format": "int64"
},
"compositionId": {
"type": "integer",
"format": "int64"
}
},
"description": "CarePlanVvtCareProfileLink model (no description)",
"example": {
"carePlanId": 1189,
"compositionId": 2077
}
},
"moves.list.ClientPlanningFilterList": {
"type": "object",
"properties": {
"clientPlanningFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.ClientPlanningFilter"
}
}
},
"description": "ClientPlanningFilterList model (no description)",
"example": {
"clientPlanningFilters": [
{
"clientId": 7607,
"reason": "sick",
"availabilityName": "Ziek",
"validFrom": "2013-12-05",
"validTo": "2013-12-06",
"teamScope": "only",
"teamId": 328,
"teamName": "V&V De Terp",
"teamCode": "1410",
"teamType": "Intramuraal",
"startTime": "15:00",
"stopTime": "18:00"
},
{
"clientId": 7607,
"reason": "sick",
"validFrom": "2013-12-02",
"validTo": "2013-12-04",
"teamScope": "all",
"startTime": "15:00",
"stopTime": "18:00"
},
{
"clientId": 7607,
"reason": "unavailable",
"validFrom": "2013-12-06",
"validTo": "2013-12-07",
"teamScope": "except",
"teamId": 301,
"teamName": "HV OOST",
"teamCode": "121",
"teamType": "Intramuraal",
"startTime": "15:00",
"stopTime": "18:00"
},
{
"clientId": 7607,
"reason": "hospitalized",
"comment": "我能吞下玻璃而不傷身體",
"validFrom": "2013-12-06",
"teamScope": "none",
"startTime": "15:00",
"stopTime": "18:00"
},
{
"clientId": 7607,
"reason": "unavailable",
"comment": "Τη γλώσσα μου έδωσαν ελληνική",
"validFrom": "2013-12-03",
"validTo": "2013-12-04",
"teamScope": "only",
"teamName": "Subunit 1A",
"teamCode": "UNLINKED",
"teamType": "Intramuraal",
"startTime": "15:00",
"stopTime": "18:00"
},
{
"clientId": 7607,
"reason": "not_yet_in_care",
"validFrom": "1900-01-01",
"validTo": "2010-02-25",
"teamScope": "all",
"teamType": "Intramuraal",
"startTime": "15:00",
"stopTime": "18:00"
},
{
"clientId": 7607,
"reason": "out_of_care",
"validFrom": "2014-02-01",
"teamScope": "all"
}
]
}
},
"moves.ClientPlanningFilter": {
"type": "object",
"properties": {
"clientId": {
"type": "integer",
"format": "int64"
},
"reason": {
"type": "string"
},
"availabilityName": {
"type": "string",
"description": "The availabiltity type name: e.g. Sick, Vacation, etc."
},
"comment": {
"type": "string"
},
"validFrom": {
"type": "string",
"format": "date"
},
"validTo": {
"type": "string",
"format": "date"
},
"teamScope": {
"type": "string",
"description": "To which team(s) is this filter applied. When 'only' or 'except', team properties should be filled. Other possible values: 'all', 'none'."
},
"teamId": {
"type": "integer",
"format": "int64"
},
"teamName": {
"type": "string",
"description": "The name of the team"
},
"teamType": {
"$ref": "#/components/schemas/moves.UnitType"
},
"teamCode": {
"type": "string",
"description": "The customer's internal identifier for the team"
},
"startTime": {
"type": "string"
},
"stopTime": {
"type": "string"
}
},
"description": "Relation between an Client and an Employee.",
"example": {
"clientId": 7607,
"reason": "sick",
"availabilityName": "Ziek",
"comment": "comment",
"validFrom": "2013-12-05",
"validTo": "2013-12-06",
"teamScope": "only",
"teamId": 328,
"teamName": "V&V De Terp",
"teamCode": "1410",
"teamType": "Intramuraal",
"startTime": "15:00",
"stopTime": "18:00"
}
},
"moves.UnitType": {
"enum": [
"Extramuraal",
"Intramuraal",
"WMO"
],
"type": "string",
"description": "Type of the unit",
"example": "Intramuraal"
},
"moves.list.ClientPlannedSchedulePlannedVisitList": {
"type": "object",
"properties": {
"plannedVisits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.ClientPlannedSchedulePlannedVisit"
}
}
},
"description": "The planned schedule for a client",
"example": {
"plannedVisits": [
{
"description": "Verzorging niveau 4",
"duration": 2700,
"time": "2021-07-21T20:26:00.000+02:00",
"employees": []
},
{
"description": "Verzorging niveau 5",
"duration": 2700,
"time": "2021-07-21T21:11:00.000+02:00",
"employees": [
{
"externalId": 123,
"name": "Dhr. Bakker"
}
]
}
]
}
},
"moves.ClientPlannedSchedulePlannedVisit": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"duration": {
"type": "integer",
"format": "int64"
},
"time": {
"type": "string",
"format": "date-time"
},
"employees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.ClientPlannedSchedulePlannedVisitEmployee"
}
}
},
"description": "A single visit in the planned schedule of a client",
"example": {
"description": "Verzorging niveau 5",
"duration": 2700,
"time": "2021-07-21T21:11:00.000+02:00",
"employees": [
{
"externalId": 123,
"name": "Dhr. Bakker"
}
]
}
},
"moves.ClientPlannedSchedulePlannedVisitEmployee": {
"type": "object",
"properties": {
"externalId": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
}
},
"description": "An employee during a single visit in the planned schedule of a client",
"example": {
"externalId": 123,
"name": "Dhr. Bakker"
}
},
"moves.list.ContainerList": {
"title": "ContainerList",
"required": [
"containers"
],
"type": "object",
"properties": {
"containers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.Container"
},
"nullable": false
}
},
"description": "A response body that contains a list of containers.",
"nullable": false,
"example": {
"containers": [
{
"containerId": "|EMPLOYEE:1|UNIT:1|DAY:MONDAY|",
"containerType": "EMPLOYEE",
"containerChecksum": "1:3AVMN3il5ywyQXDqzgfKITtet6kEKcnmxgKM6TDD2hLLb23SQzA685S",
"unitId": 1,
"date": "2025-05-25",
"startDateTime": "2025-05-25T09:30:00.000+02:00",
"endDateTime": "2025-05-25T12:30:00.000+02:00",
"timeBlocks": [
{
"startDateTime": "2025-05-25T09:30:00.000+02:00",
"endDateTime": "2025-05-25T12:30:00.000+02:00",
"type": "AVAILABLE",
"plannable": true
}
]
}
]
}
},
"moves.Container": {
"title": "Container",
"required": [
"containerId",
"containerType",
"containerChecksum",
"unitId",
"date",
"startDateTime",
"endDateTime",
"timeBlocks"
],
"type": "object",
"properties": {
"containerId": {
"type": "string",
"description": "The unique identifier that links to this specific Shift or Employee. Only used for referring to assignments.",
"nullable": false
},
"containerType": {
"$ref": "#/components/schemas/moves.ContainerType"
},
"containerChecksum": {
"type": "string",
"description": "The url-encoded checksum used to check if planning changes to this container are made with the correct updated data.",
"nullable": false
},
"employeeId": {
"type": "integer",
"description": "The employee identifier linked to this container",
"format": "int64",
"nullable": true
},
"shiftTimelineId": {
"type": "integer",
"description": "The timeline of the shift linked to this container",
"format": "int64",
"nullable": true
},
"unitId": {
"type": "integer",
"description": "The identifier of the unit that is attached to this container.",
"format": "int64",
"nullable": true
},
"rosterSlotId": {
"type": "string",
"description": "The shift occurrence id of this container (only for shifts).",
"nullable": true
},
"expertiseProfileIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "A list of expertise profiles of this container (only for shifts).",
"nullable": true
},
"date": {
"type": "string",
"description": "Date on which this container occurs.",
"format": "date",
"nullable": false
},
"startDateTime": {
"type": "string",
"description": "The date and time on which this container is supposed to start. Includes timezone information to account for DST changes.",
"format": "date-time"
},
"endDateTime": {
"type": "string",
"description": "The date and time on which this container is supposed to end. Includes timezone information to account for DST changes.",
"format": "date-time"
},
"timeBlocks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.ContainerTimeBlock"
},
"description": "Blocks of time in which plan cards are (not) allowed to be planned in.",
"nullable": false
}
},
"description": "A slot of time that can be used to plan care into, like a shift or directly to employee",
"nullable": false,
"example": {
"containerId": "|UNIT:1|EMPLOYEE:1|DAY:FRIDAY|",
"containerType": "EMPLOYEE",
"containerChecksum": "1:3AoLHR75RHPxdC78zVAZeUI.eaQkNLTQFko76niqvP5otuCzN2rxFpK",
"employeeId": 1,
"unitId": 1,
"shiftTimelineId": 2,
"rosterSlotId": "2@2025-05-23",
"expertiseProfileIds": [
2
],
"date": "2025-05-23",
"startDateTime": "2025-05-25T09:00:00.000+02:00",
"endDateTime": "2025-05-25T12:00:00.000+02:00",
"timeBlocks": [
{
"startDateTime": "2025-05-25T09:30:00.000+02:00",
"endDateTime": "2025-05-25T12:30:00.000+02:00",
"plannable": true,
"type": "AVAILABLE"
}
]
}
},
"moves.ContainerType": {
"enum": [
"SHIFT",
"EMPLOYEE"
],
"type": "string",
"description": "The type of container, either a Shift or an Employee.",
"nullable": false,
"example": "SHIFT"
},
"moves.ContainerTimeBlock": {
"title": "ContainerTimeBlock",
"required": [
"startDateTime",
"endDateTime",
"type",
"plannable"
],
"type": "object",
"properties": {
"startDateTime": {
"type": "string",
"description": "The starting time of the (un)availability for this container.",
"format": "date-time",
"nullable": false
},
"endDateTime": {
"type": "string",
"description": "The ending time of the (un)availability for this container.",
"format": "date-time",
"nullable": false
},
"type": {
"$ref": "#/components/schemas/moves.ContainerTimeBlockType"
},
"plannable": {
"type": "boolean",
"description": "Describes if we can plan inside of this time block",
"nullable": false
}
},
"description": "A block of time in which plan cards are (not) allowed to be planned in.",
"example": {
"startDateTime": "2025-05-25T09:30:00.000+02:00",
"endDateTime": "2025-05-25T12:30:00.000+02:00",
"type": "AVAILABLE",
"plannable": true
}
},
"moves.ContainerTimeBlockType": {
"enum": [
"AVAILABLE",
"UNAVAILABLE"
],
"type": "string",
"description": "Whether this availability marks an unavailability in which work cannot be planned, or an availability in which work can be planned.",
"nullable": false,
"example": "AVAILABLE"
},
"moves.MovesRatelimitError": {
"title": "MovesRatelimitError",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of error raised",
"nullable": false
},
"title": {
"type": "string",
"description": "The human readable title of the rate limit error",
"nullable": false
},
"status": {
"type": "integer",
"description": "The HTTP status code being given",
"format": "int64",
"nullable": false
}
},
"description": "An error describing a specific rate limit has been reached and that the client should wait to retry the response",
"nullable": false,
"example": {
"type": "ratelimit-error",
"title": "Rate-limit reached",
"status": 429
}
},
"moves.EmployeeSchedule": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"from": {
"type": "string",
"description": "Describes, together with the \"to\" attribute, for which period the EmployeeSchedule was retrieved.",
"format": "date"
},
"to": {
"type": "string",
"description": "Describes, together with the \"from\" attribute, for which period the EmployeeSchedule was retrieved.",
"format": "date"
},
"employeeScheduleDays": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.EmployeeScheduleDay"
},
"description": "List of EmployeeScheduleDays that make up this EmployeeSchedule."
}
},
"description": "EmployeeSchedule model (no description)",
"example": {
"employeeId": 1,
"from": "2019-11-25",
"to": "2019-11-26",
"employeeScheduleDays": [
{
"date": "2019-11-25",
"employeeScheduleItems": [
{
"rosterSlot": {
"id": "21@2019-11-25",
"date": "2019-11-25",
"beginTime": "2019-11-25T22:00:00.000+01:00",
"endTime": "2019-11-25T23:00:00.000+01:00",
"note": "Some note",
"shiftId": "1@2019-10-25",
"externalExpertiseProfileId": 1,
"externalTeamId": 1,
"authorizesForLocationId": 12,
"shiftAssignments": [
{
"id": 1,
"date": "1999-12-31",
"beginTime": "1999-12-31T22:00:00.000+01:00",
"endTime": "1999-12-31T23:00:00.000+01:00",
"externalExpertiseProfileId": 1,
"expertiseProfileName": "Verpleegkundige",
"shiftId": "1@2014-03-28",
"employeeId": 1,
"employeeLeadingName": "Jan Henk",
"employeeName": "Jan Henk Heilersig",
"onCall": true
}
],
"flexSignups": [],
"plannedVisits": [
{
"date": "2013-12-06",
"calculatedStart": "2013-12-06T12:51:00.000+01:00",
"totalDuration": -1386330660,
"travelTimeBefore": 3600,
"gapTimeBefore": 0,
"notes": [],
"plancards": [],
"shiftTimelineId": 6,
"shiftName": "Middag De Terp PV",
"shiftCode": "MDT",
"teamId": 328,
"teamUuid": "8978eec1-55c8-4c2f-bf63-4d9ae599263c",
"unitId": 1090,
"teamName": "V&V De Terp",
"teamCode": "1410",
"teamBlockplanned": false,
"authorizesForLocationId": 12,
"clientId": 14947,
"clientUuid": "3c18790a-145a-4281-b5bd-0d7e0013ce5d",
"clientCode": "05645",
"clientName": "A Radstaak - de Doring",
"clientGender": "F",
"clientIsDummy": false,
"clientBirthDate": "1932-05-23",
"employeeId": 1,
"employeeUuid": "1234567890",
"employeeCode": "code",
"employeeName": "employee",
"employeeGender": "m",
"employeeIsDummy": true
}
]
}
},
{
"unavailabilityOccurrence": {
"timelineId": 1,
"date": "2019-11-19",
"employeeId": 1,
"typeName": "Ziek",
"typeAbbreviation": "Z",
"allDay": true,
"beginTime": "2019-11-19T00:00:00.000+01:00",
"endTime": "2019-11-19T00:00:00.000+01:00",
"note": "Dummy"
}
},
{
"directlyPlannedVisits": [
{
"date": "2013-12-06",
"calculatedStart": "2013-12-06T12:51:00.000+01:00",
"totalDuration": -1386330660,
"travelTimeBefore": 3600,
"gapTimeBefore": 0,
"notes": [],
"plancards": [],
"shiftTimelineId": 6,
"shiftName": "Middag De Terp PV",
"shiftCode": "MDT",
"teamId": 328,
"teamUuid": "8978eec1-55c8-4c2f-bf63-4d9ae599263c",
"unitId": 1090,
"teamName": "V&V De Terp",
"teamCode": "1410",
"teamBlockplanned": false,
"authorizesForLocationId": 12,
"clientId": 14947,
"clientUuid": "3c18790a-145a-4281-b5bd-0d7e0013ce5d",
"clientCode": "05645",
"clientName": "A Radstaak - de Doring",
"clientGender": "F",
"clientIsDummy": false,
"clientBirthDate": "1932-05-23",
"employeeId": 1,
"employeeUuid": "1234567890",
"employeeCode": "code",
"employeeName": "employee",
"employeeGender": "m",
"employeeIsDummy": true
}
]
}
]
}
]
}
},
"moves.EmployeeScheduleDay": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The logical date for the EmployeeScheduleItems, which can be different from the actual date.",
"format": "date"
},
"employeeScheduleItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.EmployeeScheduleItem"
},
"description": "List of items rostered, planned, or otherwise scheduled for the Employee in Ons Planning.\n\nThe order of items is the same as the order in whicn Ons Planning displays them.\nItems should be displayed in this same order by other applications."
},
"onsdraaiboekMyPlanningUrl": {
"type": "string",
"description": "Link to view the planning of this day in OnsDraaiboek."
},
"onsdraaiboekMyRosterUrl": {
"type": "string",
"description": "Link to view the roster of this day in OnsDraaiboek."
},
"partiallyUnpublished": {
"type": "boolean",
"description": "If true, one of more teams have not published their roster/planning,\nand information contained in this EmployeeScheduleDay is incomplete."
}
},
"description": "EmployeeScheduleDay model (no description)",
"example": {
"date": "2019-11-25",
"employeeScheduleItems": [
{
"rosterSlot": {
"id": "21@2019-11-25",
"date": "2019-11-25",
"beginTime": "2019-11-25T22:00:00.000+01:00",
"endTime": "2019-11-25T23:00:00.000+01:00",
"note": "Some note",
"shiftId": "1@2019-10-25",
"externalExpertiseProfileId": 1,
"externalTeamId": 1,
"authorizesForLocationId": 12,
"shiftAssignments": [
{
"id": 1,
"date": "1999-12-31",
"beginTime": "1999-12-31T22:00:00.000+01:00",
"endTime": "1999-12-31T23:00:00.000+01:00",
"externalExpertiseProfileId": 1,
"expertiseProfileName": "Verpleegkundige",
"shiftId": "1@2014-03-28",
"employeeId": 1,
"employeeLeadingName": "Jan Henk",
"employeeName": "Jan Henk Heilersig",
"onCall": true
}
],
"flexSignups": [],
"plannedVisits": [
{
"date": "2013-12-06",
"calculatedStart": "2013-12-06T12:51:00.000+01:00",
"totalDuration": -1386330660,
"travelTimeBefore": 3600,
"gapTimeBefore": 0,
"notes": [],
"plancards": [],
"shiftTimelineId": 6,
"shiftName": "Middag De Terp PV",
"shiftCode": "MDT",
"teamId": 328,
"teamUuid": "8978eec1-55c8-4c2f-bf63-4d9ae599263c",
"unitId": 1090,
"teamName": "V&V De Terp",
"teamCode": "1410",
"teamBlockplanned": false,
"authorizesForLocationId": 12,
"clientId": 14947,
"clientUuid": "3c18790a-145a-4281-b5bd-0d7e0013ce5d",
"clientCode": "05645",
"clientName": "A Radstaak - de Doring",
"clientGender": "F",
"clientIsDummy": false,
"clientBirthDate": "1932-05-23",
"employeeId": 1,
"employeeUuid": "1234567890",
"employeeCode": "code",
"employeeName": "employee",
"employeeGender": "m",
"employeeIsDummy": true
}
]
}
},
{
"unavailabilityOccurrence": {
"timelineId": 1,
"date": "2019-11-19",
"employeeId": 1,
"typeName": "Ziek",
"typeAbbreviation": "Z",
"allDay": true,
"beginTime": "2019-11-19T00:00:00.000+01:00",
"endTime": "2019-11-19T00:00:00.000+01:00",
"note": "Dummy"
}
},
{
"directlyPlannedVisits": [
{
"date": "2013-12-06",
"calculatedStart": "2013-12-06T12:51:00.000+01:00",
"totalDuration": -1386330660,
"travelTimeBefore": 3600,
"gapTimeBefore": 0,
"notes": [],
"plancards": [],
"shiftTimelineId": 6,
"shiftName": "Middag De Terp PV",
"shiftCode": "MDT",
"teamId": 328,
"teamUuid": "8978eec1-55c8-4c2f-bf63-4d9ae599263c",
"unitId": 1090,
"teamName": "V&V De Terp",
"teamCode": "1410",
"teamBlockplanned": false,
"authorizesForLocationId": 12,
"clientId": 14947,
"clientUuid": "3c18790a-145a-4281-b5bd-0d7e0013ce5d",
"clientCode": "05645",
"clientName": "A Radstaak - de Doring",
"clientGender": "F",
"clientIsDummy": false,
"clientBirthDate": "1932-05-23",
"employeeId": 1,
"employeeUuid": "1234567890",
"employeeCode": "code",
"employeeName": "employee",
"employeeGender": "m",
"employeeIsDummy": true
}
]
}
],
"onsdraaiboekMyPlanningUrl": "https://customer.hasmoves.com/onsdraaiboek/planning/2019-11-25",
"onsdraaiboekMyRosterUrl": "https://customer.hasmoves.com/onsdraaiboek/roster/2019-11-25",
"partiallyUnpublished": false
}
},
"moves.EmployeeScheduleItem": {
"type": "object",
"properties": {
"rosterSlot": {
"allOf": [
{
"$ref": "#/components/schemas/moves.RosterSlot"
}
],
"description": "A RosterSlot that has been assigned to the Employee,\nor that the Employee has signed-up for.\n\nNote 1: When rosterSlot is set, unavailabilityOccurrence, directlyPlannedVisits, availabilityOccurrence and leaveRequestOccurrence are all null.\nNote 2: When multiple Employees are assigned to this RosterSlot, a ShiftAssignment will be included for each one of them."
},
"unavailabilityOccurrence": {
"allOf": [
{
"$ref": "#/components/schemas/moves.UnavailabilityOccurrence"
}
],
"description": "An UnavailabilityOccurrence of the Employee.\n\nWhen unavailabilityOccurrence is set, rosterSlot, directlyPlannedVisits, availabilityOccurrence and leaveRequestOccurrence are all null."
},
"directlyPlannedVisits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.PlannedVisit"
},
"description": "PlannedVisits that have been directly planned to the Employee.\n\nWhen directlyPlannedVisits is set, rosterSlot, unavailabilityOccurrence, availabilityOccurrence and leaveRequestOccurrence are all null."
},
"availabilityOccurrence": {
"$ref": "#/components/schemas/moves.AvailabilityOccurrence"
},
"leaveRequestOccurrence": {
"$ref": "#/components/schemas/moves.LeaveRequestOccurrence"
},
"displayCategory": {
"type": "string",
"description": "Indicates how this item should be presented to the user.\n\nworking\nnot-working\nnot-working-tentative\navailable\nflex-signed-up\n
"
},
"onsdraaiboekUrl": {
"type": "string",
"description": "URL to OnsDraaiboek where this item can be found."
}
},
"description": "An item rostered, planned, or otherwise scheduled for an Employee in Ons Planning.",
"example": {
"rosterSlot": {
"id": "21@2019-11-25",
"date": "2019-11-25",
"beginTime": "2019-11-25T22:00:00.000+01:00",
"endTime": "2019-11-25T23:00:00.000+01:00",
"note": "Some note",
"shiftId": "1@2019-10-25",
"externalExpertiseProfileId": 1,
"externalTeamId": 1,
"authorizesForLocationId": 12,
"shiftAssignments": [
{
"id": 1,
"date": "1999-12-31",
"beginTime": "1999-12-31T22:00:00.000+01:00",
"endTime": "1999-12-31T23:00:00.000+01:00",
"externalExpertiseProfileId": 1,
"expertiseProfileName": "Verpleegkundige",
"shiftId": "1@2014-03-28",
"employeeId": 1,
"employeeLeadingName": "Jan Henk",
"employeeName": "Jan Henk Heilersig",
"onCall": true
}
],
"flexSignups": [],
"plannedVisits": [
{
"date": "2013-12-06",
"calculatedStart": "2013-12-06T12:51:00.000+01:00",
"totalDuration": -1386330660,
"travelTimeBefore": 3600,
"gapTimeBefore": 0,
"notes": [],
"plancards": [],
"shiftTimelineId": 6,
"shiftName": "Middag De Terp PV",
"shiftCode": "MDT",
"teamId": 328,
"teamUuid": "8978eec1-55c8-4c2f-bf63-4d9ae599263c",
"unitId": 1090,
"teamName": "V&V De Terp",
"teamCode": "1410",
"teamBlockplanned": false,
"authorizesForLocationId": 12,
"clientId": 14947,
"clientUuid": "3c18790a-145a-4281-b5bd-0d7e0013ce5d",
"clientCode": "05645",
"clientName": "A Radstaak - de Doring",
"clientGender": "F",
"clientIsDummy": false,
"clientBirthDate": "1932-05-23",
"employeeId": 1,
"employeeUuid": "1234567890",
"employeeCode": "code",
"employeeName": "employee",
"employeeGender": "m",
"employeeIsDummy": true
}
]
},
"unavailabilityOccurrence": {
"timelineId": 1,
"date": "2019-11-19",
"employeeId": 1,
"typeName": "Ziek",
"typeAbbreviation": "Z",
"allDay": true,
"beginTime": "2019-11-19T00:00:00.000+01:00",
"endTime": "2019-11-19T00:00:00.000+01:00",
"note": "Dummy"
},
"directlyPlannedVisits": [
{
"date": "2013-12-06",
"calculatedStart": "2013-12-06T12:51:00.000+01:00",
"totalDuration": -1386330660,
"travelTimeBefore": 3600,
"gapTimeBefore": 0,
"notes": [],
"plancards": [],
"shiftTimelineId": 6,
"shiftName": "Middag De Terp PV",
"shiftCode": "MDT",
"teamId": 328,
"teamUuid": "8978eec1-55c8-4c2f-bf63-4d9ae599263c",
"unitId": 1090,
"teamName": "V&V De Terp",
"teamCode": "1410",
"teamBlockplanned": false,
"authorizesForLocationId": 12,
"clientId": 14947,
"clientUuid": "3c18790a-145a-4281-b5bd-0d7e0013ce5d",
"clientCode": "05645",
"clientName": "A Radstaak - de Doring",
"clientGender": "F",
"clientIsDummy": false,
"clientBirthDate": "1932-05-23",
"employeeId": 1,
"employeeUuid": "1234567890",
"employeeCode": "code",
"employeeName": "employee",
"employeeGender": "m",
"employeeIsDummy": true
}
],
"availabilityOccurrence": {
"timelineId": 1,
"date": "2019-11-19",
"employeeId": 1,
"beginTime": "2019-11-19T00:00:00.000+01:00",
"endTime": "2019-11-20T00:00:00.000+01:00",
"note": "Dummy"
},
"leaveRequestOccurrence": {
"timelineId": 1,
"date": "2019-11-19",
"employeeId": 1,
"beginTime": "2019-11-19T00:00:00.000+01:00",
"endTime": "2019-11-20T00:00:00.000+01:00",
"status": "pending"
},
"displayCategory": "working",
"onsdraaiboekUrl": "https://customer.hasmoves.com/onsdraaiboek"
}
},
"moves.AvailabilityOccurrence": {
"type": "object",
"properties": {
"timelineId": {
"type": "integer",
"description": "Same value for all AvailabilityOccurrences generated from the same Availability.",
"format": "int64"
},
"date": {
"type": "string",
"description": "Date on which this AvailabilityOccurrence occurs.",
"format": "date"
},
"employeeId": {
"type": "integer",
"description": "Refers to the Employee this AvailabilityOccurrence belongs to.",
"format": "int64"
},
"beginTime": {
"type": "string",
"description": "Time at which this AvailabilityOccurrence begins.",
"format": "date-time"
},
"endTime": {
"type": "string",
"description": "Time at which this AvailabilityOccurrence ends.",
"format": "date-time"
},
"note": {
"type": "string",
"description": "Note/comment about this AvailabilityOccurrence."
}
},
"description": "AvailabilityOccurrence model (no description)",
"example": {
"timelineId": 1,
"date": "2019-11-19",
"employeeId": 1,
"beginTime": "2019-11-19T00:00:00.000+01:00",
"endTime": "2019-11-20T00:00:00.000+01:00",
"note": "Dummy"
}
},
"moves.LeaveRequestOccurrence": {
"type": "object",
"properties": {
"timelineId": {
"type": "integer",
"description": "Same value for all LeaveRequestOccurrences generated from the same Availability.",
"format": "int64"
},
"date": {
"type": "string",
"description": "Date on which this LeaveRequestOccurrence occurs.",
"format": "date"
},
"employeeId": {
"type": "integer",
"description": "Refers to the Employee this LeaveRequestOccurrence belongs to.",
"format": "int64"
},
"beginTime": {
"type": "string",
"description": "Time at which the LeaveRequest begins.\nFor longer LeaveRequests, this DateTime will not be on the same Date as the date attribute.",
"format": "date-time"
},
"endTime": {
"type": "string",
"description": "Time at which the LeaveRequest ends.\nFor longer LeaveRequests, this DateTime will not be on the same Date as the date attribute.",
"format": "date-time"
},
"status": {
"type": "string",
"description": "Status of the LeaveRequest"
}
},
"description": "LeaveRequestOccurrence model (no description)",
"example": {
"timelineId": 1,
"date": "2019-11-19",
"employeeId": 1,
"beginTime": "2019-11-19T00:00:00.000+01:00",
"endTime": "2019-11-20T00:00:00.000+01:00",
"status": "pending"
}
},
"moves.PlannedVisit": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date",
"nullable": true
},
"calculatedStart": {
"type": "string",
"format": "date-time",
"nullable": true
},
"totalDuration": {
"type": "integer",
"format": "int32",
"nullable": true
},
"travelTimeBefore": {
"type": "integer",
"format": "int32",
"nullable": true
},
"gapTimeBefore": {
"type": "integer",
"format": "int32",
"nullable": true
},
"firstAfterMidnight": {
"type": "boolean",
"description": "This visit is the first after midnight, and a visual indication\nshould be shown to the user (e.g. the new date or a 🌙 icon)."
},
"notes": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"plancards": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.Plancard"
},
"nullable": true
},
"plannedAddress": {
"$ref": "#/components/schemas/moves.PlannedAddress"
},
"shiftTimelineId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"shiftName": {
"type": "string",
"nullable": true
},
"shiftCode": {
"type": "string",
"nullable": true
},
"teamId": {
"type": "integer",
"description": "Linked to the Ons Administratie team, can be null if the Moves planning team (unit) is a sub-team from the OA team",
"format": "int64",
"nullable": true
},
"teamUuid": {
"type": "string",
"nullable": true
},
"unitId": {
"type": "integer",
"description": "Linked to the Moves planning team (unit)",
"format": "int64",
"nullable": true
},
"teamName": {
"type": "string",
"nullable": true
},
"teamCode": {
"type": "string",
"nullable": true
},
"teamBlockplanned": {
"type": "boolean",
"description": "Indicates if the Team uses the blockplanscreen (clients planned to\nemployees directly) instead of the route-based planscreen.",
"nullable": true
},
"authorizesForLocationId": {
"type": "integer",
"description": "Being planned as Employee for the Team or Shift\nimplies authorization for this Location.",
"format": "int64",
"nullable": true,
"deprecated": true
},
"locationAuthorizations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.LocationAuthorization"
},
"description": "Being assigned as Employee for the Team or Shift\nimplies authorization for these Locations.",
"nullable": true
},
"clientId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"clientUuid": {
"type": "string",
"nullable": true
},
"clientCode": {
"type": "string",
"nullable": true
},
"clientName": {
"type": "string",
"nullable": true
},
"clientGender": {
"type": "string",
"nullable": true
},
"clientIsDummy": {
"type": "boolean",
"nullable": true
},
"clientBirthDate": {
"type": "string",
"format": "date",
"nullable": true
},
"clientPreferredName": {
"type": "string",
"nullable": true
},
"clientPronouns": {
"x-deprecated-since": "21-08-2026",
"$ref": "#/components/schemas/Pronouns",
"description": "This field is no longer used and has been replaced by clientPronounsType.",
"deprecated": true
},
"clientPronounsType": {
"$ref": "#/components/schemas/PronounsType"
},
"employeeId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"employeeUuid": {
"type": "string",
"nullable": true
},
"employeeCode": {
"type": "string",
"nullable": true
},
"employeeName": {
"type": "string",
"nullable": true
},
"employeeGender": {
"type": "string",
"nullable": true
},
"employeeIsDummy": {
"type": "boolean",
"nullable": true
}
},
"description": "A Visit from an {@Employee} to a {@Client}.",
"nullable": true,
"example": {
"date": "2013-12-06",
"calculatedStart": "2013-12-06T12:51:00.000+01:00",
"totalDuration": -1386330660,
"travelTimeBefore": 3600,
"gapTimeBefore": 0,
"firstAfterMidnight": false,
"notes": [],
"plancards": [],
"plannedAddress": {
"latitude": 0.5,
"longitude": 0.5,
"city": "example",
"street": "example",
"zipcode": "example",
"number": "example",
"numberPostfix": "example"
},
"shiftTimelineId": 6,
"shiftName": "Middag De Terp PV",
"shiftCode": "MDT",
"teamId": 328,
"teamUuid": "8978eec1-55c8-4c2f-bf63-4d9ae599263c",
"unitId": 1090,
"teamName": "V&V De Terp",
"teamCode": "1410",
"teamBlockplanned": false,
"authorizesForLocationId": 12,
"locationAuthorizations": [
{
"locationId": 12
}
],
"clientId": 14947,
"clientUuid": "3c18790a-145a-4281-b5bd-0d7e0013ce5d",
"clientCode": "05645",
"clientName": "A Radstaak - de Doring",
"clientGender": "F",
"clientIsDummy": false,
"clientBirthDate": "1932-05-23",
"clientPreferredName": "Arie",
"clientPronouns": {
"description": "zij/haar",
"type": "SHE_HER"
},
"clientPronounsType": "SHE_HER",
"employeeId": 1,
"employeeUuid": "1234567890",
"employeeCode": "code",
"employeeName": "employee",
"employeeGender": "m",
"employeeIsDummy": true
}
},
"moves.PlannedAddress": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"format": "double",
"nullable": true
},
"longitude": {
"type": "number",
"format": "double",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"street": {
"type": "string",
"nullable": true
},
"zipcode": {
"type": "string",
"nullable": true
},
"number": {
"type": "string",
"nullable": true
},
"numberPostfix": {
"type": "string",
"nullable": true
},
"residenceAccessInfo": {
"type": "string",
"nullable": true
},
"roomNumber": {
"type": "string",
"nullable": true
}
},
"description": "Address where {@link PlannedVisit}s are planned.\n\nMoves has it's own Address model, and plancards can be\nplanned tp addresses not known in other systems.",
"nullable": true,
"example": {
"latitude": 52.038398,
"longitude": 6.624163,
"city": "Groenlo",
"street": "Parallelweg",
"zipcode": "7141DC",
"number": "31",
"numberPostfix": "a",
"residenceAccessInfo": "Keybox is behind drain pipe. Code is 1234",
"roomNumber": "1"
}
},
"moves.Plancard": {
"type": "object",
"properties": {
"hourTypeId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"hourTypeName": {
"type": "string",
"nullable": true
},
"hourTypeCode": {
"type": "string",
"nullable": true
},
"duration": {
"type": "integer",
"description": "Duration of this Plancard in seconds.",
"format": "int32",
"nullable": true
},
"note": {
"type": "string",
"description": "The note added to this Plancard in the planscreen.",
"nullable": true
},
"promisedStart": {
"type": "string",
"description": "The entered start time of this Plancard. This time is an intent, not a guarantee.",
"format": "date-time",
"nullable": true
},
"dayPart": {
"type": "integer",
"description": "Daypart on which this Plancard is defined in the care arrangement.\n\n\n1 - Morning\n2 - Afternoon\n3 - Evening\n0 - Night (Night-plancards generally occur after Evening-plancards for the same date)\nnull - Incidentally added Plancard that is not linked to a care arrangement.\n
",
"format": "int32",
"nullable": true
},
"deleted": {
"type": "boolean",
"description": "Indicates if this Planccard has been incidentally deleted.",
"nullable": true
},
"cycleBase": {
"type": "string",
"description": "The date from which the recurrence pattern is calculated (usually a Sunday)",
"format": "date"
},
"cycleInterval": {
"type": "integer",
"description": "The plancard occurs every N-days",
"format": "int32"
},
"cycleOffset": {
"type": "integer",
"description": "The number of days from cycleBase the plancard occurs, effectively indicating a day of the week. Usually [0-6], 0 is Sunday",
"format": "int32"
},
"originalCycleOffset": {
"type": "integer",
"description": "When the plancard was incidentally moved, this attribute holds the original value of cycleOffset.",
"format": "int32"
},
"incidentallyChanged": {
"type": "boolean",
"description": "The information on this plancard is different from its regular/structural state."
},
"instanceOfType": {
"type": "string",
"description": "Either 'PatternRule' (a regular plancard created from the care arrangement) or 'EventRule' (a plancard that was incidentally added from the planscreen)"
},
"instanceOfId": {
"type": "integer",
"description": "Reference to 'PatternRule'-record in case `instanceOfType` is `PatternRule`",
"format": "int32"
},
"kind": {
"type": "string",
"description": "Unused",
"nullable": true
},
"exportable": {
"type": "boolean",
"description": "Indicates if this Plancard will be exported. Only available through specific APIs.",
"nullable": true
}
},
"description": "{@link PlannedVisit}s are the aggregation of a list of Plancards.",
"example": {
"hourTypeId": 25,
"hourTypeName": "PV eten en drinken",
"hourTypeCode": "31",
"duration": 600,
"note": "Les naïfs ægithales hâtifs pondant à Noël où il gèle sont sûrs d'être déçus en voyant leurs drôles d'œufs abîmés.",
"promisedStart": "2010-03-15T00:00:00.000+01:00",
"dayPart": 1,
"deleted": false,
"cycleBase": "2021-06-24",
"cycleInterval": 7,
"cycleOffset": 3,
"originalCycleOffset": 5,
"incidentallyChanged": false,
"instanceOfType": "PatternRule",
"instanceOfId": 16,
"kind": "arrangement",
"exportable": true
}
},
"moves.LocationAuthorization": {
"type": "object",
"properties": {
"locationId": {
"type": "integer",
"description": "The location this LocationAuthorization grants access to.\nReference to Cupido::Location.",
"format": "int64",
"nullable": true
}
},
"description": "LocationAuthorization model (no description)",
"example": {
"locationId": 1
}
},
"moves.RosterSlot": {
"type": "object",
"properties": {
"id": {
"type": "string",
"x-cupido-id": true
},
"date": {
"type": "string",
"format": "date"
},
"beginTime": {
"type": "string",
"description": "Regular begin time of the Shift.\nThe date component of this field is always the same as the date of this RosterSlot.",
"format": "date-time"
},
"beginBreakTime": {
"type": "string",
"description": "Regular begin time of the break in this Shift (if any).\nCan be after midnight, relative to the date of this RosterSlot.",
"format": "date-time"
},
"endBreakTime": {
"type": "string",
"description": "Regular end time of the break in this Shift (if any).\nCan be after midnight, relative to the date of this RosterSlot.",
"format": "date-time"
},
"endTime": {
"type": "string",
"description": "Regular end time of this Shift.\nCan be after midnight, relative to the date of this RosterSlot.",
"format": "date-time"
},
"note": {
"type": "string"
},
"code": {
"type": "string",
"description": "The code of the Shift.\nUsually a shortend version of the description."
},
"description": {
"type": "string",
"description": "The description of the Shift."
},
"transportationMethodName": {
"type": "string",
"description": "Name of the transportation method of the Shift."
},
"transportationMethodImage": {
"type": "string",
"description": "Image of the transportation method of the Shift.\n\nPossible values:\n\ncar\nperson\nbike\nmoped\ntrain\nbus\nunknown\n
"
},
"expertiseProfileName": {
"type": "string",
"description": "Name of expertise required for this RosterSlot."
},
"teamName": {
"type": "string",
"description": "Name of the team this RosterSlot belongs to."
},
"shiftId": {
"type": "string"
},
"externalExpertiseProfileId": {
"type": "integer",
"description": "Id of the related expertise profile in OA",
"format": "int64"
},
"externalTeamId": {
"type": "integer",
"description": "Id of the related team in OA",
"format": "int64"
},
"authorizesForLocationId": {
"type": "integer",
"description": "Being assigned as Employee for the Team or Shift\nimplies authorization for this Location.",
"format": "int64",
"deprecated": true
},
"locationAuthorizations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.LocationAuthorization"
},
"description": "Being assigned as Employee for the Team or Shift\nimplies authorization for these Locations."
},
"shiftAssignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.ShiftAssignment"
}
},
"flexRequests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.FlexRequest"
}
},
"flexSignups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.FlexSignup"
}
},
"plannedVisits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.PlannedVisit"
},
"description": "The PlannedVisits that are planned to this RosterSlot."
}
},
"description": "A RosterSlot that has been assigned to the Employee,\nor that the Employee has signed-up for.\n\nNote 1: When rosterSlot is set, unavailabilityOccurrence, directlyPlannedVisits, availabilityOccurrence and leaveRequestOccurrence are all null.\nNote 2: When multiple Employees are assigned to this RosterSlot, a ShiftAssignment will be included for each one of them.",
"example": {
"id": "21@2014-04-11",
"date": "2013-12-31",
"beginTime": "2013-12-31T22:00:00.000+01:00",
"beginBreakTime": "2013-12-31T22:15:00.000+01:00",
"endBreakTime": "2013-12-31T22:30:00.000+01:00",
"endTime": "2013-12-31T23:00:00.000+01:00",
"note": "Some note",
"code": "A2",
"description": "Avond 2",
"transportationMethodName": "Auto in de binnenstad",
"transportationMethodImage": "car",
"expertiseProfileName": "Verzorgende",
"teamName": "Groenlo Noord",
"shiftId": "1@2014-03-28",
"externalExpertiseProfileId": 1,
"externalTeamId": 1,
"authorizesForLocationId": 12,
"locationAuthorizations": [
{
"locationId": 12
}
],
"shiftAssignments": [
{
"id": 1,
"date": "1999-12-31",
"beginTime": "1999-12-31T22:00:00.000+01:00",
"endTime": "1999-12-31T23:00:00.000+01:00",
"externalExpertiseProfileId": 1,
"expertiseProfileName": "Verpleegkundige",
"shiftId": "1@2014-03-28",
"employeeId": 1,
"employeeLeadingName": "Jan Henk",
"employeeName": "Jan Henk Heilersig",
"onCall": true
},
{
"id": 2,
"date": "1999-12-31",
"beginTime": "1999-12-31T22:00:00.000+01:00",
"endTime": "1999-12-31T23:00:00.000+01:00",
"externalExpertiseProfileId": 1,
"expertiseProfileName": "Verpleegkundige",
"shiftId": "1@2014-03-28",
"employeeId": 2,
"employeeLeadingName": "Selvi",
"employeeName": "Selvi Ratnasingam",
"onCall": false
}
],
"flexRequests": [
{
"id": 1,
"date": "2025-01-15",
"shiftTimelineId": 123,
"shiftId": "123@2024-03-28",
"order": 0,
"rosterTeamId": 8,
"rosterUnitId": 15,
"requestingTeamId": 8,
"flexTeamId": 432,
"flexUnitId": 10,
"startTime": "2024-01-15T08:00:00.000+01:00",
"endTime": "2024-01-15T16:00:00.000+01:00",
"breakStartTime": "2024-01-15T12:00:00.000+01:00",
"breakEndTime": "2024-01-15T12:30:00.000+01:00",
"externalExpertiseProfileId": 10,
"expertiseProfileName": "Expertise Profile Name",
"requestedAt": "2024-01-10T14:30:00.000+01:00",
"flexSignups": [
{
"id": 1,
"shiftId": "123@2025-01-15",
"date": "2025-01-15",
"employeeId": 1,
"employeeLeadingName": "Pieter",
"employeeName": "Pieter Bos",
"suggested": false,
"struckOut": false,
"signedUpAt": "2025-01-15T00:00:00.000+01:00"
}
]
}
],
"flexSignups": [
{
"id": 1,
"shiftId": "123@2025-01-15",
"date": "2025-01-15",
"employeeId": 1,
"employeeLeadingName": "Pieter",
"employeeName": "Pieter Bos",
"suggested": false,
"struckOut": false,
"signedUpAt": "2025-01-15T00:00:00.000+01:00"
}
],
"plannedVisits": [
{
"date": "2013-12-06",
"calculatedStart": "2013-12-06T12:51:00.000+01:00",
"totalDuration": -1386330660,
"travelTimeBefore": 3600,
"gapTimeBefore": 0,
"notes": [],
"plancards": [],
"shiftTimelineId": 6,
"shiftName": "Middag De Terp PV",
"shiftCode": "MDT",
"teamId": 328,
"teamUuid": "8978eec1-55c8-4c2f-bf63-4d9ae599263c",
"unitId": 1090,
"teamName": "V&V De Terp",
"teamCode": "1410",
"teamBlockplanned": false,
"authorizesForLocationId": 12,
"clientId": 14947,
"clientUuid": "3c18790a-145a-4281-b5bd-0d7e0013ce5d",
"clientCode": "05645",
"clientName": "A Radstaak - de Doring",
"clientGender": "F",
"clientIsDummy": false,
"clientBirthDate": "1932-05-23",
"employeeId": 1,
"employeeUuid": "1234567890",
"employeeCode": "code",
"employeeName": "employee",
"employeeGender": "m",
"employeeIsDummy": true
}
]
}
},
"moves.FlexRequest": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"date": {
"type": "string",
"format": "date"
},
"shiftTimelineId": {
"type": "integer",
"format": "int64"
},
"shiftId": {
"type": "string"
},
"order": {
"type": "integer",
"format": "int64"
},
"rosterTeamId": {
"type": "integer",
"format": "int64"
},
"rosterUnitId": {
"type": "integer",
"format": "int64"
},
"requestingTeamId": {
"type": "integer",
"format": "int64"
},
"flexTeamId": {
"type": "integer",
"format": "int64"
},
"flexUnitId": {
"type": "integer",
"format": "int64"
},
"startTime": {
"type": "string",
"format": "date-time"
},
"endTime": {
"type": "string",
"format": "date-time"
},
"breakStartTime": {
"type": "string",
"format": "date-time"
},
"breakEndTime": {
"type": "string",
"format": "date-time"
},
"externalExpertiseProfileId": {
"type": "integer",
"format": "int64"
},
"expertiseProfileName": {
"type": "string"
},
"requestedAt": {
"type": "string",
"format": "date-time"
},
"flexSignups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.FlexSignup"
}
}
},
"description": "FlexRequest model (no description)",
"example": {
"id": 1,
"date": "2025-01-15",
"shiftTimelineId": 123,
"shiftId": "123@2025-01-15",
"order": 0,
"rosterTeamId": 8,
"rosterUnitId": 15,
"requestingTeamId": 8,
"flexTeamId": 432,
"flexUnitId": 10,
"startTime": "2025-01-15T08:00:00.000+01:00",
"endTime": "2025-01-15T16:00:00.000+01:00",
"breakStartTime": "2025-01-15T12:00:00.000+01:00",
"breakEndTime": "2025-01-15T12:30:00.000+01:00",
"externalExpertiseProfileId": 10,
"expertiseProfileName": "Verpleegkundige",
"requestedAt": "2025-01-01T14:30:00.000+01:00",
"flexSignups": [
{
"id": 1,
"shiftId": "123@2025-01-15",
"date": "2025-01-15",
"employeeId": 1,
"employeeLeadingName": "Jan Henk",
"employeeName": "Jan Henk Heilersig",
"suggested": false,
"struckOut": false,
"signedUpAt": "2025-01-01T00:00:00.000+01:00"
}
]
}
},
"moves.FlexSignup": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"date": {
"type": "string",
"format": "date"
},
"shiftId": {
"type": "string"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"employeeLeadingName": {
"type": "string"
},
"employeeName": {
"type": "string"
},
"suggested": {
"type": "boolean"
},
"struckOut": {
"type": "boolean"
},
"signedUpAt": {
"type": "string",
"format": "date-time"
}
},
"description": "FlexSignup model (no description)",
"example": {
"id": 1,
"date": "1999-12-31",
"shiftId": "1@2014-03-28",
"employeeId": 1,
"employeeLeadingName": "Jan Henk",
"employeeName": "Jan Henk Heilersig"
}
},
"moves.UnavailabilityOccurrence": {
"type": "object",
"properties": {
"timelineId": {
"type": "integer",
"description": "Same value for all UnavailabilityOccurrences generated from the same Unavailability.",
"format": "int64"
},
"date": {
"type": "string",
"format": "date"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"typeName": {
"type": "string",
"description": "Human-readable name indicating kind of Unavailability. For examle \"Sick\" or \"Holiday\"."
},
"typeAbbreviation": {
"type": "string",
"description": "Short (one or two characters) representation that can be used instead of typeName when space is limited."
},
"allDay": {
"type": "boolean",
"description": "Indicates if this UnavailabilityOccurrence last the whole."
},
"beginTime": {
"type": "string",
"format": "date-time"
},
"endTime": {
"type": "string",
"format": "date-time"
},
"note": {
"type": "string"
},
"exportable": {
"type": "boolean",
"description": "Indicates if this UnavailabilityOccurrence will be exported. Only available through specific APIs."
}
},
"description": "An UnavailabilityOccurrence of the Employee.\n\nWhen unavailabilityOccurrence is set, rosterSlot, directlyPlannedVisits, availabilityOccurrence and leaveRequestOccurrence are all null.",
"example": {
"timelineId": 1,
"date": "2019-11-19",
"employeeId": 1,
"typeName": "Ziek",
"typeAbbreviation": "Z",
"allDay": true,
"beginTime": "2019-11-19T00:00:00.000+01:00",
"endTime": "2019-11-20T00:00:00.000+01:00",
"note": "Dummy",
"exportable": true
}
},
"moves.EmployeeMovesProfile": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"memberOfFlexRosterTeam": {
"type": "boolean"
},
"memberOfSelfRosterTeam": {
"type": "boolean"
},
"memberOfSelfAvailabilityTeam": {
"type": "boolean"
},
"memberOfIntramuralTeam": {
"type": "boolean"
},
"useOnsDraaiboekRoster": {
"type": "boolean",
"description": "Feature flag for the roster in OnsDraaiboek."
},
"useOnsDraaiboekPlanning": {
"type": "boolean",
"description": "Feature flag for the planning in OnsDraaiboek."
},
"useOnsDraaiboekVacationOverview": {
"type": "boolean",
"description": "Timepilot/feature flag indicating which version of the VacationOverview to use.\nThe new Vacation Overview that is part of OnsDraaiboek, or the old one that is part of the EmployeePortal."
},
"vacationOverviewEnabled": {
"type": "boolean",
"description": "Feature flag indicating if the VacationOverview is enabled at all."
},
"useSelfAvailabilityViaMoves": {
"type": "boolean",
"description": "Timepilot flag for when we want to repatriate SelfAvailability from the EmployeePortal to Moves in the future."
}
},
"description": "EmployeeMovesProfile describes dynamic properties\nof an Employee, based on the Memberships of that Employees\nas known in Moves and on team settings configured in Moves.",
"example": {
"employeeId": 2002,
"memberOfFlexRosterTeam": false,
"memberOfSelfRosterTeam": true,
"memberOfSelfAvailabilityTeam": false,
"memberOfIntramuralTeam": true,
"useOnsDraaiboekRoster": true,
"useOnsDraaiboekPlanning": true,
"useOnsDraaiboekVacationOverview": true,
"vacationOverviewEnabled": true,
"useSelfAvailabilityViaMoves": true
}
},
"moves.EmployeeHoursReport": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"segments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.EmployeeHoursReportSegment"
}
}
},
"description": "Describes a report of the worked and leave hours of an employee in the current state and the future.",
"example": {
"employeeId": 1,
"segments": [
{
"name": "current",
"label": "Nu",
"categories": [
{
"name": "worked_hours",
"label": "Gewerke uren",
"minutes": 60,
"link": "https://example.com",
"description": "Aantal gewerkte uren deze week"
},
{
"name": "compensation",
"label": "Compensatie",
"minutes": 480,
"link": "https://example.com",
"description": "Compensatiesaldo tot en met afgelopen zondag"
},
{
"name": "vacation",
"label": "Vakantie",
"minutes": 480,
"link": "https://example.com",
"description": "Vakantiesaldo tot en met afgelopen zondag"
}
]
},
{
"name": "future",
"label": "Toekomst",
"categories": [
{
"name": "compensation",
"label": "Compensatie",
"minutes": 480,
"link": "https://example.com",
"description": "Compensatiesaldo tot publicatiedatum",
"subCategory": {
"name": "until_publication_date",
"label": "Tot aan publicatiedatum (25-3-2024)"
}
},
{
"name": "vacation",
"label": "Vakantie",
"minutes": 480,
"link": "https://example.com",
"description": "Verwacht vakantieuren saldo aan het eind van dit jaar",
"subCategory": {
"name": "expected_end_of_year",
"label": "Verwacht eind 2024"
}
}
]
}
]
}
},
"moves.EmployeeHoursReportSegment": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"label": {
"type": "string"
},
"categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.EmployeeHoursReportCategory"
}
}
},
"description": "Describes a segment of the worked and leave hours of an employee. E.g. 'current' or 'future'",
"example": {
"name": "current",
"label": "Nu",
"categories": [
{
"name": "worked_hours",
"label": "Gewerke uren",
"minutes": 60,
"link": "https://example.com",
"description": "Aantal gewerkte uren deze week"
}
]
}
},
"moves.EmployeeHoursReportCategory": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"label": {
"type": "string"
},
"minutes": {
"type": "integer",
"format": "int64"
},
"link": {
"type": "string"
},
"description": {
"type": "string"
},
"subCategory": {
"$ref": "#/components/schemas/moves.EmployeeHoursReportSubCategory"
}
},
"description": "Describes a category of the worked and leave hours of an employee. E.g. 'worked_hours' or 'compensation'",
"example": {
"name": "compensation",
"label": "Compensatie",
"minutes": 480,
"link": "https://example.com",
"description": "Compensatiesaldo tot publicatiedatum",
"subCategory": {
"name": "until_publication_date",
"label": "Tot aan publicatiedatum (25-3-2024)"
}
}
},
"moves.EmployeeHoursReportSubCategory": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"label": {
"type": "string"
}
},
"description": "Describes a subcategory to determine sub headings in the widget",
"example": {
"name": "until_publication_date",
"label": "Tot aan publicatiedatum (25-3-2024)"
}
},
"moves.list.NavigationAvailabilityList": {
"type": "object",
"properties": {
"navigationAvailabilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.NavigationAvailability"
}
}
},
"description": "List of navigation items with their availability",
"example": {
"navigationAvailabilities": [
{
"key": "PLANNING",
"state": "AVAILABLE"
},
{
"key": "ROSTER",
"state": "DISABLED"
},
{
"key": "SHIFT_TRANSFERS",
"state": "UNAVAILABLE"
}
]
}
},
"moves.NavigationAvailability": {
"required": [
"key",
"state"
],
"type": "object",
"properties": {
"key": {
"$ref": "#/components/schemas/moves.NavigationAvailabilityKey"
},
"state": {
"$ref": "#/components/schemas/moves.NavigationAvailabilityState"
}
},
"description": "A navigation item with its availability",
"example": {
"key": "ROSTER",
"state": "AVAILABLE"
}
},
"moves.NavigationAvailabilityKey": {
"enum": [
"PLANNING",
"ROSTER",
"SHIFT_TRANSFERS",
"FLEX_REQUESTS",
"VACATION_OVERVIEW",
"LEAVE_REQUESTS"
],
"type": "string",
"description": "item for navigation availability request",
"example": "PLANNING"
},
"moves.NavigationAvailabilityState": {
"enum": [
"AVAILABLE",
"DISABLED",
"UNAVAILABLE"
],
"type": "string",
"description": "State of the navigation availability",
"example": "AVAILABLE"
},
"moves.EmployeePlanning": {
"type": "object",
"properties": {
"eventGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.EmployeePlanningEventGroup"
}
}
},
"description": "The employee planning",
"example": {
"eventGroups": [
{
"startsAt": "2023-11-24T13:29:00.000+01:00",
"duration": 1234,
"client": {
"externalId": 123,
"identificationNo": "abc123",
"name": "Koning, F.C.",
"address": "Groeneweg 25, Groenlo",
"gender": "M"
},
"notes": [
"sleutel onder de mat"
],
"planCards": [
{
"startsAt": "2023-11-24T16:39:00.000+01:00",
"duration": 1337,
"description": "(O4) Ochtenddienst 4"
}
]
}
]
}
},
"moves.EmployeePlanningEventGroup": {
"type": "object",
"properties": {
"startsAt": {
"type": "string",
"format": "date-time"
},
"duration": {
"type": "integer",
"format": "int64"
},
"client": {
"$ref": "#/components/schemas/moves.EmployeePlanningClient"
},
"notes": {
"type": "array",
"items": {
"type": "string"
}
},
"planCards": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.EmployeePlanningPlanCard"
}
}
},
"description": "Part of the employee planning",
"example": {
"startsAt": "2023-11-24T13:29:00.000+01:00",
"duration": 1234,
"client": {
"externalId": 123,
"identificationNo": "abc123",
"name": "Koning, F.C.",
"address": "Groeneweg 25, Groenlo",
"gender": "M"
},
"notes": [
"sleutel onder de mat"
],
"planCards": [
{
"startsAt": "2023-11-24T16:39:00.000+01:00",
"duration": 1337,
"description": "(O4) Ochtenddienst 4"
}
]
}
},
"moves.EmployeePlanningClient": {
"type": "object",
"properties": {
"externalId": {
"type": "integer",
"format": "int64"
},
"identificationNo": {
"type": "string"
},
"name": {
"type": "string"
},
"address": {
"type": "string"
},
"gender": {
"type": "string"
}
},
"description": "Part of the employee planning",
"example": {
"externalId": 123,
"identificationNo": "abc123",
"name": "Koning, F.C.",
"address": "Groeneweg 25, Groenlo",
"gender": "M"
}
},
"moves.EmployeePlanningPlanCard": {
"type": "object",
"properties": {
"startsAt": {
"type": "string",
"format": "date-time"
},
"duration": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
}
},
"description": "Part of the employee planning",
"example": {
"startsAt": "2023-11-24T16:39:00.000+01:00",
"duration": 1337,
"description": "(O4) Ochtenddienst 4"
}
},
"moves.list.EmployeeRosterDayList": {
"type": "object",
"properties": {
"employeeRosterDays": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.EmployeeRosterDay"
}
}
},
"description": "Employee roster day list",
"example": {
"employeeRosterDays": [
{
"date": "2023-11-25",
"availabilities": [
{
"startTime": "2023-11-25T07:00:00.000+01:00",
"stopTime": "2023-11-25T11:00:00.000+01:00",
"name": "Hallo"
}
],
"shiftAssignments": [
{
"startTime": "2023-11-25T07:00:00.000+01:00",
"stopTime": "2023-11-25T11:00:00.000+01:00",
"name": "Ochtenddienst 4"
}
]
}
]
}
},
"moves.EmployeeRosterDay": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date"
},
"availabilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.EmployeeRosterDayAvailability"
}
},
"shiftAssignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.EmployeeRosterDayShiftAssignment"
}
}
},
"description": "Employee roster",
"example": {
"date": "2023-11-25",
"availabilities": [
{
"startTime": "2023-11-25T07:00:00.000+01:00",
"stopTime": "2023-11-25T11:00:00.000+01:00",
"name": "Hallo"
}
],
"shiftAssignments": [
{
"startTime": "2023-11-25T07:00:00.000+01:00",
"stopTime": "2023-11-25T11:00:00.000+01:00",
"name": "Ochtenddienst 4"
}
]
}
},
"moves.EmployeeRosterDayAvailability": {
"type": "object",
"properties": {
"startTime": {
"type": "string",
"format": "date-time"
},
"stopTime": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
}
},
"description": "Employee roster availability",
"example": {
"startTime": "2023-11-25T07:00:00.000+01:00",
"stopTime": "2023-11-25T11:00:00.000+01:00",
"name": "Hallo"
}
},
"moves.EmployeeRosterDayShiftAssignment": {
"type": "object",
"properties": {
"startTime": {
"type": "string",
"format": "date-time"
},
"stopTime": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
}
},
"description": "Employee roster shift assignment",
"example": {
"startTime": "2023-11-25T07:00:00.000+01:00",
"stopTime": "2023-11-25T11:00:00.000+01:00",
"name": "Ochtenddienst 4"
}
},
"moves.list.ShiftAssignmentList": {
"title": "ShiftAssignmentList",
"type": "object",
"properties": {
"shiftAssignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.ShiftAssignment"
},
"nullable": true,
"xml": {
"name": "shiftAssignment"
}
}
},
"description": "ShiftAssignmentList model (no description)",
"example": {
"shiftAssignments": [
{
"id": 1,
"date": "1999-12-31",
"beginTime": "1999-12-31T22:00:00.000+01:00",
"endTime": "1999-12-31T23:00:00.000+01:00",
"externalExpertiseProfileId": 1,
"expertiseProfileName": "Verpleegkundige",
"shiftId": "1@2014-03-28",
"employeeId": 1,
"employeeLeadingName": "Jan Henk",
"employeeName": "Jan Henk Heilersig",
"onCall": true,
"timelineShiftId": 1654,
"unitId": 5,
"breakDuration": 15,
"incidental": true,
"order": 0,
"startBreakTime": "1999-12-31T22:15:00.000+01:00",
"stopBreakTime": "1999-12-31T23:29:00.000+01:00",
"discardedAt": "2000-12-31T23:29:00.000+01:00"
},
{
"id": 2,
"date": "1999-12-31",
"beginTime": "1999-12-31T22:00:00.000+01:00",
"endTime": "1999-12-31T23:00:00.000+01:00",
"externalExpertiseProfileId": 1,
"expertiseProfileName": "Verpleegkundige",
"shiftId": "2@2014-03-28",
"employeeId": 2,
"employeeLeadingName": "Jan Hendrik",
"employeeName": "Jan Hendrik Croockewit",
"onCall": false,
"timelineShiftId": 1754,
"unitId": 6,
"breakDuration": 16,
"incidental": true,
"order": 0,
"startBreakTime": "1999-12-31T22:15:00.000+01:00",
"stopBreakTime": "1999-12-31T23:29:00.000+01:00",
"discardedAt": "2000-12-31T23:29:00.000+01:00"
}
]
},
"xml": {
"name": "shiftAssignments"
}
},
"moves.Absence": {
"title": "Absence",
"required": [
"remoteId",
"employeeNumber",
"beginDateTime",
"absenceType"
],
"type": "object",
"properties": {
"remoteId": {
"type": "string",
"description": "The unique identifier of the absence in the remote system",
"nullable": false
},
"employeeNumber": {
"type": "string",
"description": "The employee number of the employee this absence belongs to",
"nullable": false
},
"employmentNumber": {
"type": "integer",
"description": "The employment number, used when an employee has multiple employments",
"format": "int64",
"nullable": true
},
"beginDateTime": {
"type": "string",
"description": "The date and time the absence started",
"format": "date-time",
"nullable": false
},
"expectedEndDateTime": {
"type": "string",
"description": "The expected date and time the absence will end",
"format": "date-time",
"nullable": true
},
"actualEndDateTime": {
"type": "string",
"description": "The actual date and time the absence ended",
"format": "date-time",
"nullable": true
},
"absenceType": {
"$ref": "#/components/schemas/moves.AbsenceType"
}
},
"description": "An absence to be processed as a signal from a remote system",
"example": {
"remoteId": "12345",
"employeeNumber": "EMP001",
"employmentNumber": 1,
"beginDateTime": "2024-01-15T08:00:00.000+01:00",
"expectedEndDateTime": "2024-01-22T08:00:00.000+01:00",
"actualEndDateTime": "2024-01-22T08:00:00.000+01:00",
"absenceType": "Z"
}
},
"moves.PlanCardOccurrenceResponse": {
"title": "PlanCardOccurrenceResponse",
"type": "object",
"properties": {
"metadata": {
"$ref": "#/components/schemas/moves.PlanCardOccurrenceResponseMetadata"
},
"planCardOccurrences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.PlanCardOccurrence"
},
"nullable": false
}
},
"description": "The response from a successful plan card planning mutation",
"nullable": false,
"example": {
"metadata": {
"impact": {
"containers": [
{
"containerId": "|SHIFT:1|UNIT:1|THURSDAY|",
"containerChecksum": "1:3AjzryeZVF5WQXkpToQYFst.07yuJc.vN.2pPMBhjPvJOV.grawLgU2"
},
{
"containerId": "|SHIFT:1|UNIT:1|FRIDAY|",
"containerChecksum": "1:3AVMN3il5ywyQXDqzgfKITtet6kEKcnmxgKM6TDD2hLLb23SQzA685S"
}
]
}
},
"planCardOccurrences": [
{
"occurrenceId": "2025-05-18--2025-05-23--98--true--1--null",
"planCardChecksum": "1:3AoAdyjHX3rvpvjlbc%2F4TkTunSATrXeAnjKt8.ToIBL9yq5sZzlf.D2",
"planCardTimelineId": 1,
"clientId": 1,
"hourTypeId": 1,
"durationInSeconds": 900,
"travelTimeBeforeInSeconds": 18000,
"travelTimeAfterInSeconds": 18000,
"transportationMethodId": 1,
"date": "2025-05-23",
"startDateTime": "2025-05-23T12:30:00.000+02:00",
"fixedStartTime": "12:30:00",
"incidental": false,
"canceled": false,
"address": {
"latitude": 52.1,
"longitude": 5.1
},
"assignment": {
"containerId": "|SHIFT:1|UNIT:1|FRIDAY|",
"containerChecksum": "1:3AVMN3il5ywyQXDqzgfKITtet6kEKcnmxgKM6TDD2hLLb23SQzA685S"
},
"recurrence": {
"recurrenceStartDate": "2025-05-09",
"recurrenceType": "WEEKLY",
"stepSize": 1
}
}
]
}
},
"moves.PlanCardOccurrenceResponseMetadata": {
"title": "PlanCardOccurrenceResponseMetadata",
"type": "object",
"properties": {
"impact": {
"$ref": "#/components/schemas/moves.PlanCardOccurrenceResponseMetadataImpact"
}
},
"description": "Metadata about the impact of the plan card occurrence planning",
"nullable": false,
"example": {
"impact": {
"containers": [
{
"containerId": "|SHIFT:1|UNIT:1|THURSDAY|",
"containerChecksum": "1:3AjzryeZVF5WQXkpToQYFst.07yuJc.vN.2pPMBhjPvJOV.grawLgU2"
},
{
"containerId": "|SHIFT:1|UNIT:1|FRIDAY|",
"containerChecksum": "1:3AVMN3il5ywyQXDqzgfKITtet6kEKcnmxgKM6TDD2hLLb23SQzA685S"
}
]
}
}
},
"moves.PlanCardOccurrenceResponseMetadataImpact": {
"title": "PlanCardOccurrenceResponseMetadataImpact",
"type": "object",
"properties": {
"containers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.ContainerAssignment"
}
}
},
"description": "Metadata about the impact of the plan card occurrence planning",
"example": {
"containers": [
{
"containerId": "|SHIFT:1|UNIT:1|THURSDAY|",
"containerChecksum": "1:3AjzryeZVF5WQXkpToQYFst.07yuJc.vN.2pPMBhjPvJOV.grawLgU2"
},
{
"containerId": "|SHIFT:1|UNIT:1|FRIDAY|",
"containerChecksum": "1:3AVMN3il5ywyQXDqzgfKITtet6kEKcnmxgKM6TDD2hLLb23SQzA685S"
}
]
}
},
"moves.PlanCardOccurrence": {
"title": "PlanCardOccurrence",
"required": [
"occurrenceId",
"planCardChecksum",
"planCardTimelineId",
"clientId",
"hourTypeId",
"durationInSeconds",
"travelTimeBeforeInSeconds",
"travelTimeAfterInSeconds",
"transportationMethodId",
"date",
"startDateTime",
"fixedStartTime",
"incidental",
"canceled",
"address",
"assignment",
"recurrence"
],
"type": "object",
"properties": {
"occurrenceId": {
"type": "string",
"description": "The ID that links to this specific plan card occurrence",
"nullable": false
},
"planCardChecksum": {
"type": "string",
"description": "The url-encoded checksum used to check if planning changes are made with the correct updated data",
"nullable": false
},
"planCardTimelineId": {
"type": "integer",
"description": "The timeline id that links this plan card occurrence to the other moments that were planned in the past and in the future",
"format": "int64",
"nullable": false
},
"clientId": {
"type": "integer",
"description": "The identifier of the client that is linked to this plan card",
"format": "int64",
"nullable": true
},
"hourTypeId": {
"type": "integer",
"description": "The identifier of the hour type attached to this planned care moment",
"format": "int64",
"nullable": true
},
"durationInSeconds": {
"type": "integer",
"description": "The total duration in seconds that this planned care moment is going to take.",
"format": "int64",
"nullable": true
},
"travelTimeBeforeInSeconds": {
"type": "integer",
"description": "The total duration in seconds that is calculated to travel from the previous plan card to this plan card",
"format": "int64",
"nullable": true
},
"travelTimeAfterInSeconds": {
"type": "integer",
"description": "The total duration in seconds that is calculated to travel from the current plan card to the next plan card",
"format": "int64",
"nullable": true
},
"transportationMethodId": {
"type": "integer",
"description": "The identifier of the transportation method that is being used to travel to this plan card",
"format": "int64",
"nullable": true
},
"date": {
"type": "string",
"description": "Date on which this PlanCardOccurrence occurs.",
"format": "date",
"nullable": true
},
"startDateTime": {
"type": "string",
"description": "Date and start time on which this PlanCardOccurrence occurs.",
"format": "date-time",
"nullable": true
},
"fixedStartTime": {
"pattern": "^\\d{2}:\\d{2}:\\d{2}$",
"type": "string",
"description": "The local fixed start time on which this PlanCardOccurrence should occur. This time remains the same when going through DST changes.",
"nullable": true
},
"incidental": {
"type": "boolean",
"description": "Whether this PlanCardOccurrence has been incidentally changed for only this date",
"nullable": false
},
"canceled": {
"type": "boolean",
"description": "Whether this PlanCardOccurrence has been incidentally canceled for this date",
"nullable": false
},
"address": {
"$ref": "#/components/schemas/moves.PlannedAddress"
},
"assignment": {
"$ref": "#/components/schemas/moves.ContainerAssignment"
},
"recurrence": {
"$ref": "#/components/schemas/moves.PlanCardRecurrenceInformation"
}
},
"description": "A single instance of a recurring plan card as retrieved from the new Plancore.",
"nullable": false,
"example": {
"occurrenceId": "2025-05-18--2025-05-23--98--true--1--null",
"planCardChecksum": "1:3AoAdyjHX3rvpvjlbc%2F4TkTunSATrXeAnjKt8.ToIBL9yq5sZzlf.D2",
"planCardTimelineId": 1,
"clientId": 1,
"hourTypeId": 1,
"durationInSeconds": 900,
"travelTimeBeforeInSeconds": 300,
"travelTimeAfterInSeconds": 300,
"transportationMethodId": 1,
"date": "2025-05-23",
"startDateTime": "2025-05-23T12:30:00.000+02:00",
"fixedStartTime": "12:30:00",
"incidental": false,
"canceled": false,
"address": {
"latitude": 52.1,
"longitude": 5.1
},
"assignment": {
"containerId": "|SHIFT:1|UNIT:1|FRIDAY|",
"containerChecksum": "1:3AVMN3il5ywyQXDqzgfKITtet6kEKcnmxgKM6TDD2hLLb23SQzA685S"
},
"recurrence": {
"recurrenceStartDate": "2025-05-09",
"recurrenceType": "WEEKLY",
"stepSize": 1
}
}
},
"moves.PlanCardRecurrenceInformation": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/moves.Recurrence"
}
],
"description": "This describes how often this plan card should occur.",
"example": {
"recurrenceStartDate": "2025-05-09",
"recurrenceType": "WEEKLY",
"stepSize": 1
}
},
"moves.Recurrence": {
"title": "Recurrence",
"required": [
"recurrenceStartDate",
"recurrenceType",
"stepSize"
],
"type": "object",
"properties": {
"recurrenceStartDate": {
"type": "string",
"description": "The starting date from which this plan card is supposed to take place. The expected weekday can be infered from this date.",
"format": "date",
"nullable": false
},
"recurrenceType": {
"$ref": "#/components/schemas/moves.RecurrenceType"
},
"stepSize": {
"type": "integer",
"description": "Describes how many recurrence periods are between every occurrence. For example, with this being 2 and the recurrenceType being WEEKLY, it means this plan card occurs once every two weeks.",
"format": "int64",
"nullable": true
}
},
"description": "This describes how often this plan card should occur.",
"nullable": false,
"example": {
"recurrenceStartDate": "2025-05-09",
"recurrenceType": "WEEKLY",
"stepSize": 1
}
},
"moves.RecurrenceType": {
"enum": [
"WEEKLY",
"INCIDENTAL"
],
"type": "string",
"description": "The type of repetition between occurrences. Weekly means once a week, Incidental means once for this validFrom until validTo period.",
"nullable": false,
"example": "WEEKLY"
},
"moves.PlanCardOccurrenceList": {
"title": "PlanCardOccurrenceList",
"required": [
"metadata",
"planCardOccurrences"
],
"type": "object",
"properties": {
"metadata": {
"$ref": "#/components/schemas/moves.ContainerSearchRequest"
},
"planCardOccurrences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.PlanCardOccurrence"
},
"nullable": false
}
},
"description": "A response body that contains a list of plan tasks found for this search",
"nullable": false,
"example": {
"metadata": {
"from": "2025-05-20",
"to": "2025-05-30",
"unitIds": [
1,
2
],
"shiftTimelineIds": [],
"employeeIds": []
},
"planCardOccurrences": [
{
"occurrenceId": "2025-05-18--2025-05-23--98--true--1--null",
"planCardChecksum": "1:3AoAdyjHX3rvpvjlbc%2F4TkTunSATrXeAnjKt8.ToIBL9yq5sZzlf.D2",
"planCardTimelineId": 1,
"clientId": 1,
"hourTypeId": 1,
"durationInSeconds": 900,
"travelTimeBeforeInSeconds": 18000,
"travelTimeAfterInSeconds": 18000,
"transportationMethodId": 1,
"date": "2025-05-23",
"startDateTime": "2025-05-23T12:30:00.000+02:00",
"fixedStartTime": "12:30:00",
"incidental": false,
"canceled": false,
"address": {
"latitude": 52.1,
"longitude": 5.1
},
"assignment": {
"containerId": "|SHIFT:1|UNIT:1|FRIDAY|",
"containerChecksum": "1:3AVMN3il5ywyQXDqzgfKITtet6kEKcnmxgKM6TDD2hLLb23SQzA685S"
},
"recurrence": {
"recurrenceStartDate": "2025-05-09",
"recurrenceType": "WEEKLY",
"stepSize": 1
}
}
]
}
},
"moves.list.PlannedVisitList": {
"type": "object",
"properties": {
"plannedVisits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.PlannedVisit"
}
}
},
"description": "PlannedVisitList model (no description)",
"example": {
"plannedVisits": [
{
"calculatedStart": "2013-12-06T08:00:00.000+01:00",
"totalDuration": 14400,
"travelTimeBefore": 0,
"gapTimeBefore": 0,
"notes": [
"sleutelcode 1234",
"contactpers: kleindochter 06123456789"
],
"plancards": [
{
"hourTypeId": 39,
"hourTypeName": "HH2 hulp bij huishouden",
"hourTypeCode": "0",
"duration": 14400,
"note": "Some note",
"promisedStart": "2013-12-05T08:00:00.000+01:00",
"kind": "arrangement"
}
],
"plannedAddress": {
"latitude": 52.038398,
"longitude": 6.624163,
"zipcode": "7141DC",
"number": "31"
},
"teamId": 301,
"teamUuid": "8978eec1-55c8-4c2f-bf63-4d9ae599263c",
"unitId": 1091,
"teamName": "HV OOST",
"teamCode": "121",
"teamBlockplanned": false,
"authorizesForLocationId": 12,
"clientId": 14947,
"clientUuid": "3c18790a-145a-4281-b5bd-0d7e0013ce5d",
"clientCode": "05645",
"clientName": "A Radstaak - de Doring",
"clientGender": "F",
"clientIsDummy": false,
"clientBirthDate": "1932-05-23",
"employeeId": 9197,
"employeeUuid": "91f118c2-cd22-4105-a5ee-a05758288b68",
"employeeCode": "9197-02",
"employeeName": "Gerrie Nijenhuis",
"employeeGender": "M",
"employeeIsDummy": false
},
{
"calculatedStart": "2013-12-06T08:37:00.000+01:00",
"totalDuration": -1386315420,
"travelTimeBefore": 0,
"gapTimeBefore": 0,
"notes": [],
"plancards": [
{
"hourTypeId": 29,
"hourTypeName": "VP overige handelingen",
"hourTypeCode": "41",
"duration": 600,
"note": "Some note",
"kind": "arrangement"
},
{
"hourTypeId": 30,
"hourTypeName": "VP controle lichaamsfuncties",
"hourTypeCode": "41",
"duration": 600,
"note": "Some note",
"kind": "arrangement"
}
],
"plannedAddress": {
"latitude": 52.038398,
"longitude": 6.624163,
"zipcode": "7141DC",
"number": "31"
},
"shiftTimelineId": 33,
"shiftName": "Ochtend 2 VP Oost",
"shiftCode": "O2VP",
"teamId": 328,
"teamUuid": "ef538153-f686-4ef7-b5aa-f6f2d363d9f6",
"unitId": 1090,
"teamName": "V&V De Terp",
"teamCode": "1410",
"teamBlockplanned": false,
"authorizesForLocationId": 12,
"clientId": 14947,
"clientUuid": "3c18790a-145a-4281-b5bd-0d7e0013ce5d",
"clientCode": "05645",
"clientName": "A Radstaak - de Doring",
"clientGender": "F",
"clientIsDummy": false,
"clientBirthDate": "1932-05-23",
"employeeId": 8996,
"employeeUuid": "ae3a0b12-88a1-4fde-8ce0-30f5f7b83b3b",
"employeeCode": "8996-02",
"employeeName": "Dorien Arentsen - Arentsen",
"employeeGender": "M",
"employeeIsDummy": false
},
{
"totalDuration": 0,
"travelTimeBefore": 0,
"gapTimeBefore": 0,
"notes": [],
"plancards": [
{
"hourTypeId": 33,
"hourTypeName": "PV medicijnen",
"hourTypeCode": "31",
"duration": 600,
"note": "Some note",
"kind": "arrangement"
}
],
"plannedAddress": {
"latitude": 52.038398,
"longitude": 6.624163,
"zipcode": "7141DC",
"number": "31"
},
"teamId": 328,
"teamUuid": "ef538153-f686-4ef7-b5aa-f6f2d363d9f6",
"unitId": 1090,
"teamName": "V&V De Terp",
"teamCode": "1410",
"teamBlockplanned": false,
"authorizesForLocationId": 12,
"clientId": 14947,
"clientUuid": "3c18790a-145a-4281-b5bd-0d7e0013ce5d",
"clientCode": "05645",
"clientName": "A Radstaak - de Doring",
"clientGender": "F",
"clientIsDummy": false,
"clientBirthDate": "1932-05-23"
},
{
"calculatedStart": "2013-12-06T12:03:00.000+01:00",
"totalDuration": 900,
"travelTimeBefore": 3600,
"gapTimeBefore": 0,
"notes": [],
"plancards": [
{
"hourTypeId": 24,
"hourTypeName": "PV hulp toilet/stoma",
"hourTypeCode": "31",
"duration": 900,
"note": "Some note",
"kind": "arrangement"
}
],
"plannedAddress": {
"latitude": 52.038398,
"longitude": 6.624163,
"zipcode": "7141DC",
"number": "31"
},
"shiftTimelineId": 6,
"shiftName": "Middag De Terp PV",
"shiftCode": "MDT",
"teamId": 328,
"teamUuid": "ef538153-f686-4ef7-b5aa-f6f2d363d9f6",
"unitId": 1090,
"teamName": "V&V De Terp",
"teamCode": "1410",
"teamBlockplanned": false,
"authorizesForLocationId": 12,
"clientId": 14947,
"clientUuid": "3c18790a-145a-4281-b5bd-0d7e0013ce5d",
"clientCode": "05645",
"clientName": "A Radstaak - de Doring",
"clientGender": "F",
"clientIsDummy": false,
"clientBirthDate": "1932-05-23"
},
{
"calculatedStart": "2013-12-06T12:51:00.000+01:00",
"totalDuration": -1386330660,
"travelTimeBefore": 3600,
"gapTimeBefore": 0,
"notes": [],
"plancards": [
{
"hourTypeId": 25,
"hourTypeName": "PV eten en drinken",
"hourTypeCode": "31",
"duration": 600,
"note": "Les naïfs ægithales hâtifs pondant à Noël où il gèle sont sûrs d'être déçus en voyant leurs drôles d'œufs abîmés.",
"kind": "arrangement"
},
{
"hourTypeId": 35252,
"hourTypeName": "PV-wassen/douchen",
"hourTypeCode": "31",
"duration": 1500,
"note": "Some note",
"kind": "arrangement"
},
{
"hourTypeId": 29,
"hourTypeName": "VP overige handelingen",
"hourTypeCode": "41",
"duration": 1200,
"note": "Some note",
"kind": "arrangement"
}
],
"plannedAddress": {
"latitude": 52.038398,
"longitude": 6.624163,
"zipcode": "7141DC",
"number": "31"
},
"shiftTimelineId": 6,
"shiftName": "Middag De Terp PV",
"shiftCode": "MDT",
"teamId": 328,
"teamUuid": "ef538153-f686-4ef7-b5aa-f6f2d363d9f6",
"unitId": 1090,
"teamName": "V&V De Terp",
"teamCode": "1410",
"teamBlockplanned": false,
"authorizesForLocationId": 12,
"clientId": 14947,
"clientUuid": "3c18790a-145a-4281-b5bd-0d7e0013ce5d",
"clientCode": "05645",
"clientName": "A Radstaak - de Doring",
"clientGender": "F",
"clientIsDummy": false,
"clientBirthDate": "1932-05-23"
},
{
"calculatedStart": "2013-12-06T16:30:00.000+01:00",
"totalDuration": 900,
"travelTimeBefore": 0,
"gapTimeBefore": 0,
"notes": [],
"plancards": [
{
"hourTypeId": 24,
"hourTypeName": "PV hulp toilet/stoma",
"hourTypeCode": "31",
"duration": 900,
"note": "Some note",
"kind": "arrangement"
}
],
"plannedAddress": {
"latitude": 52.038398,
"longitude": 6.624163,
"zipcode": "7141DC",
"number": "31"
},
"shiftTimelineId": 34,
"shiftName": "Avond VP",
"shiftCode": "AV",
"teamId": 328,
"teamUuid": "ef538153-f686-4ef7-b5aa-f6f2d363d9f6",
"unitId": 1090,
"teamName": "V&V De Terp",
"teamCode": "1410",
"teamBlockplanned": false,
"authorizesForLocationId": 12,
"clientId": 14947,
"clientUuid": "3c18790a-145a-4281-b5bd-0d7e0013ce5d",
"clientCode": "05645",
"clientName": "A Radstaak - de Doring",
"clientGender": "F",
"clientIsDummy": false,
"clientBirthDate": "1932-05-23",
"employeeId": 36223,
"employeeUuid": "e2bbd4c3-8b6c-4823-b9dc-b4ab1e478bfc",
"employeeCode": "36223-02",
"employeeName": "Anita Abbink - Overkamp",
"employeeGender": "M",
"employeeIsDummy": false
},
{
"calculatedStart": "2013-12-06T18:45:00.000+01:00",
"totalDuration": 1800,
"travelTimeBefore": 0,
"gapTimeBefore": 0,
"notes": [],
"plancards": [
{
"hourTypeId": 25,
"hourTypeName": "PV eten en drinken",
"hourTypeCode": "31",
"duration": 900,
"note": "Some note",
"kind": "arrangement"
},
{
"hourTypeId": 24,
"hourTypeName": "PV hulp toilet/stoma",
"hourTypeCode": "31",
"duration": 900,
"note": "Some note",
"kind": "arrangement"
}
],
"plannedAddress": {
"latitude": 52.038398,
"longitude": 6.624163,
"zipcode": "7141DC",
"number": "31"
},
"shiftTimelineId": 9,
"shiftName": "Avond 3 PV",
"shiftCode": "A3",
"teamId": 328,
"teamUuid": "ef538153-f686-4ef7-b5aa-f6f2d363d9f6",
"unitId": 1090,
"teamName": "V&V De Terp",
"teamCode": "1410",
"teamBlockplanned": false,
"authorizesForLocationId": 12,
"clientId": 14947,
"clientUuid": "3c18790a-145a-4281-b5bd-0d7e0013ce5d",
"clientCode": "05645",
"clientName": "A Radstaak - de Doring",
"clientGender": "F",
"clientIsDummy": false,
"clientBirthDate": "1932-05-23"
},
{
"calculatedStart": "2013-12-06T21:19:00.000+01:00",
"totalDuration": 600,
"travelTimeBefore": 3600,
"gapTimeBefore": 0,
"notes": [],
"plancards": [
{
"hourTypeId": 24,
"hourTypeName": "PV hulp toilet/stoma",
"hourTypeCode": "31",
"duration": 600,
"note": "Some note",
"kind": "arrangement"
}
],
"plannedAddress": {
"latitude": 52.038398,
"longitude": 6.624163,
"zipcode": "7141DC",
"number": "31"
},
"shiftTimelineId": 9,
"shiftName": "Avond 3 PV",
"shiftCode": "A3",
"teamId": 328,
"teamUuid": "ef538153-f686-4ef7-b5aa-f6f2d363d9f6",
"unitId": 1090,
"teamName": "V&V De Terp",
"teamCode": "1410",
"teamBlockplanned": false,
"authorizesForLocationId": 12,
"clientId": 14947,
"clientUuid": "3c18790a-145a-4281-b5bd-0d7e0013ce5d",
"clientCode": "05645",
"clientName": "A Radstaak - de Doring",
"clientGender": "F",
"clientIsDummy": false,
"clientBirthDate": "1932-05-23"
}
]
}
},
"moves.list.RosterSlotList": {
"type": "object",
"properties": {
"rosterSlots": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.RosterSlot"
}
}
},
"description": "RosterSlotList model (no description)",
"example": {
"rosterSlots": [
{
"id": "21@2014-04-11",
"date": "2013-12-31",
"beginTime": "2013-12-31T22:00:00.000+01:00",
"endTime": "2013-12-31T23:00:00.000+01:00",
"note": "Some note",
"shiftId": "1@2014-03-28",
"externalExpertiseProfileId": 1,
"externalTeamId": 1,
"authorizesForLocationId": 12,
"shiftAssignments": [
{
"id": 1,
"date": "1999-12-31",
"beginTime": "1999-12-31T22:00:00.000+01:00",
"endTime": "1999-12-31T23:00:00.000+01:00",
"externalExpertiseProfileId": 1,
"expertiseProfileName": "Verpleegkundige",
"shiftId": "1@2014-03-28",
"employeeId": 1,
"employeeLeadingName": "Jan Henk",
"employeeName": "Jan Henk Heilersig",
"onCall": true
},
{
"id": 2,
"date": "1999-12-31",
"beginTime": "1999-12-31T22:00:00.000+01:00",
"endTime": "1999-12-31T23:00:00.000+01:00",
"externalExpertiseProfileId": 1,
"expertiseProfileName": "Verpleegkundige",
"shiftId": "1@2014-03-28",
"employeeId": 2,
"employeeLeadingName": "Selvi",
"employeeName": "Selvi Ratnasingam",
"onCall": false
}
],
"flexRequests": [
{
"id": 1,
"date": "2025-01-15",
"shiftTimelineId": 123,
"shiftId": "123@2024-03-28",
"order": 0,
"rosterTeamId": 8,
"rosterUnitId": 15,
"requestingTeamId": 8,
"flexTeamId": 432,
"flexUnitId": 10,
"startTime": "2024-01-15T08:00:00.000+01:00",
"endTime": "2024-01-15T16:00:00.000+01:00",
"breakStartTime": "2024-01-15T12:00:00.000+01:00",
"breakEndTime": "2024-01-15T12:30:00.000+01:00",
"externalExpertiseProfileId": 10,
"expertiseProfileName": "Expertise Profile Name",
"requestedAt": "2024-01-10T14:30:00.000+01:00",
"flexSignups": [
{
"id": 1,
"shiftId": "123@2025-01-15",
"date": "2025-01-15",
"employeeId": 1,
"employeeLeadingName": "Pieter",
"employeeName": "Pieter Bos",
"suggested": false,
"struckOut": false,
"signedUpAt": "2025-01-15T00:00:00.000+01:00"
}
]
}
],
"flexSignups": [
{
"id": 1,
"shiftId": "123@2025-01-15",
"date": "2025-01-15",
"employeeId": 1,
"employeeLeadingName": "Pieter",
"employeeName": "Pieter Bos",
"suggested": false,
"struckOut": false,
"signedUpAt": "2025-01-15T00:00:00.000+01:00"
}
],
"plannedVisits": [
{
"date": "2013-12-06",
"calculatedStart": "2013-12-06T12:51:00.000+01:00",
"totalDuration": -1386330660,
"travelTimeBefore": 3600,
"gapTimeBefore": 0,
"notes": [],
"plancards": [],
"shiftTimelineId": 6,
"shiftName": "Middag De Terp PV",
"shiftCode": "MDT",
"teamId": 328,
"teamUuid": "8978eec1-55c8-4c2f-bf63-4d9ae599263c",
"unitId": 1090,
"teamName": "V&V De Terp",
"teamCode": "1410",
"teamBlockplanned": false,
"authorizesForLocationId": 12,
"clientId": 14947,
"clientUuid": "3c18790a-145a-4281-b5bd-0d7e0013ce5d",
"clientCode": "05645",
"clientName": "A Radstaak - de Doring",
"clientGender": "F",
"clientIsDummy": false,
"clientBirthDate": "1932-05-23",
"employeeId": 1,
"employeeUuid": "1234567890",
"employeeCode": "code",
"employeeName": "employee",
"employeeGender": "m",
"employeeIsDummy": true
}
]
}
]
}
},
"moves.Shift": {
"title": "Shift",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Composite id with id and date",
"nullable": true,
"x-cupido-id": true
},
"code": {
"type": "string",
"description": "Shift code",
"nullable": true
},
"description": {
"type": "string",
"description": "Shift description",
"nullable": true
},
"expertiseProfileId": {
"type": "integer",
"description": "Which expertise profile is needed for this shift",
"format": "int64",
"nullable": true
},
"teamId": {
"type": "integer",
"description": "To which team does this shift belong",
"format": "int64",
"nullable": true
},
"createdById": {
"type": "integer",
"description": "Deprecated since 01-04-2021 (no-joke): Its an internal property",
"format": "int64",
"nullable": true,
"deprecated": true,
"x-deprecated-since": "01-04-2021"
},
"updatedById": {
"type": "integer",
"description": "Deprecated since 01-04-2021 (no-joke): Its an internal property",
"format": "int64",
"nullable": true,
"deprecated": true
},
"deletedById": {
"type": "integer",
"description": "Deprecated since 01-04-2021 (no-joke): Its an internal property",
"format": "int64",
"nullable": true,
"deprecated": true,
"x-deprecated-since": "01-04-2021"
},
"validFrom": {
"type": "string",
"description": "When is the shift valid",
"format": "date",
"nullable": true
},
"validTo": {
"type": "string",
"format": "date",
"nullable": true
},
"transportationMethodId": {
"type": "integer",
"description": "Which transportation method is used for the shift?\nDeprecated since 01-04-2021 (no-joke): Its an internal property",
"format": "int64",
"nullable": true,
"deprecated": true,
"x-deprecated-since": "01-04-2021"
},
"monday": {
"type": "boolean",
"description": "Is the shift 'active' on monday?",
"nullable": true
},
"tuesday": {
"type": "boolean",
"description": "Is the shift 'active' on tuesday?",
"nullable": true
},
"wednesday": {
"type": "boolean",
"description": "Is the shift 'active' on wednesday?",
"nullable": true
},
"thursday": {
"type": "boolean",
"description": "Is the shift 'active' on thursday?",
"nullable": true
},
"friday": {
"type": "boolean",
"description": "Is the shift 'active' on friday?",
"nullable": true
},
"saturday": {
"type": "boolean",
"description": "Is the shift 'active' on saturday?",
"nullable": true
},
"sunday": {
"type": "boolean",
"description": "Is the shift 'active' on sunday?",
"nullable": true
},
"startTimes": {
"type": "string",
"description": "Array of all the start times of the shift",
"nullable": true
},
"stopTimes": {
"type": "string",
"description": "Array of all the stop times of the shift",
"nullable": true
},
"breakType": {
"type": "integer",
"description": "\nbreakType: Possible values:\n0: no break\n1: use breakLength\n2: use startBreakTimes and stopBreakTimes\n
",
"format": "int64",
"nullable": true
},
"breakLength": {
"type": "integer",
"description": "Break length in minutes",
"format": "int64",
"nullable": true
},
"startBreakTimes": {
"type": "string",
"description": "Array of all the break start times",
"nullable": true
},
"stopBreakTimes": {
"type": "string",
"description": "Array of all the break stop times",
"nullable": true
},
"dayPart": {
"type": "integer",
"description": "In which day part is this shift operating in",
"format": "int64",
"nullable": true
},
"number": {
"type": "integer",
"description": "Is used by guess_description_number\nDeprecated since 01-04-2021 (no-joke): Its an internal property",
"format": "int64",
"nullable": true,
"deprecated": true,
"x-deprecated-since": "01-04-2021"
},
"timelineId": {
"type": "integer",
"description": "Is used by the ActsAsPlacedOnTimeline plugin",
"format": "int64",
"nullable": true
},
"exportAssignments": {
"type": "boolean",
"description": "Export shiftassignments as indirect time",
"nullable": true
},
"exportHourTypeId": {
"type": "integer",
"description": "Which hourtype needs to be exported",
"format": "int64",
"nullable": true
},
"exportGroupCare": {
"type": "boolean",
"description": "Do we need to export the hours as GroupCare hours?",
"nullable": true
}
},
"description": "Updated by Jurriën Gosselink on 09-07-18.",
"example": {
"id": "200@2014-04-11",
"code": "O1",
"description": "Ochtend 1",
"expertiseProfileId": 1,
"teamId": 1,
"createdById": 1,
"updatedById": 1,
"deletedById": 1,
"validFrom": "2014-01-01",
"validTo": "2014-12-31",
"transportationMethodId": 1,
"monday": true,
"tuesday": true,
"wednesday": false,
"thursday": true,
"friday": true,
"saturday": false,
"sunday": false,
"startTimes": "--- - 2000-01-01 08:00:00.000000000 +01:00 - 2000-01-01 08:00:00.000000000 +01:00 - 2000-01-01 08:00:00.000000000 +01:00 - 2000-01-01 08:00:00.000000000 +01:00 - 2000-01-01 08:00:00.000000000 +01:00 - 2000-01-01 08:00:00.000000000 +01:00 - 2000-01-01 08:00:00.000000000 +01:00",
"stopTimes": "--- - 2000-01-01 12:00:00.000000000 +01:00 - 2000-01-01 12:00:00.000000000 +01:00 - 2000-01-01 12:00:00.000000000 +01:00 - 2000-01-01 12:00:00.000000000 +01:00 - 2000-01-01 12:00:00.000000000 +01:00 - 2000-01-01 12:00:00.000000000 +01:00 - 2000-01-01 12:00:00.000000000 +01:00",
"breakType": 0,
"breakLength": 15,
"startBreakTimes": "[null,null,null,null,null,null,null]",
"stopBreakTimes": "[null,null,null,null,null,null,null]",
"dayPart": 1,
"number": 2,
"timelineId": 1,
"exportAssignments": false,
"exportHourTypeId": 1,
"exportGroupCare": false
},
"xml": {
"name": "shift"
}
},
"moves.list.TeamList": {
"type": "object",
"properties": {
"teams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.Team"
}
}
},
"description": "List of teams ( also named units ) for planning and rostering purposes",
"example": {
"teams": [
{
"unitId": 1234,
"name": "Nedap VnV",
"parentUnitId": 1233,
"teamId": 4321,
"validFrom": "2019-11-19",
"validTo": "2038-01-19",
"coreUnitId": 0,
"flexUnitId": 1,
"isFlexTeam": true,
"isCoreTeam": false,
"active": true,
"teamType": "Extramuraal",
"useBlockplanning": false,
"useSelfRostering": true,
"selfRosteringStartDate": "2000-01-01",
"rosterPublicationDate": "2025-08-30"
}
]
}
},
"moves.Team": {
"type": "object",
"properties": {
"unitId": {
"type": "integer",
"description": "Unique unit identifier for the team",
"format": "int64",
"nullable": false
},
"name": {
"type": "string",
"description": "Name of the team",
"nullable": true
},
"parentUnitId": {
"type": "integer",
"description": "Unit identifier of the parent team",
"format": "int64",
"nullable": false
},
"teamId": {
"type": "integer",
"description": "Identifier that links this planning team ( unit ) to an administrative team.",
"format": "int64",
"nullable": true
},
"validFrom": {
"type": "string",
"description": "Date from which the team is valid",
"format": "date",
"nullable": true
},
"validTo": {
"type": "string",
"description": "Date until which the team is valid",
"format": "date",
"nullable": true
},
"flexUnitId": {
"type": "integer",
"description": "Unit identifier for the linked flex team",
"format": "int64",
"nullable": true
},
"coreUnitId": {
"type": "integer",
"description": "Unit identifier for the linked core team",
"format": "int64",
"nullable": true
},
"isFlexTeam": {
"type": "boolean",
"description": "Whether this team is a flex team for another team. Deprecated: this is true for a main flex unit as well as for an additional flex unit. Use isPrimaryFlexUnit and isAdditionalFlexUnit to tell those apart.",
"nullable": true,
"deprecated": true,
"x-deprecated-since": "24-08-2026"
},
"isCoreTeam": {
"type": "boolean",
"description": "Whether this team is a core team for another team. Deprecated: in this model a team is the administrative team, while this says something about the unit. Use isCoreUnit instead.",
"nullable": true,
"deprecated": true,
"x-deprecated-since": "25-08-2026"
},
"active": {
"type": "boolean",
"description": "Indicates if this team is actively being used",
"nullable": true
},
"teamType": {
"$ref": "#/components/schemas/moves.UnitType"
},
"useBlockplanning": {
"type": "boolean",
"description": "Indicates if the team is using blokplanning",
"nullable": true
},
"useSelfRostering": {
"type": "boolean",
"description": "Indicates if self-rostering is enabled for this team",
"nullable": false
},
"selfRosteringStartDate": {
"type": "string",
"description": "Date from which self-rostering is available",
"format": "date",
"nullable": true
},
"rosterPublicationDate": {
"type": "string",
"description": "The roster publication date for this team. Shifts and shift assignments made before this publication date are visible to employees.",
"format": "date",
"nullable": false
},
"isFlexUnit": {
"type": "boolean",
"description": "Whether this unit is a flex unit for another unit. Replaces isFlexTeam",
"nullable": true
},
"isCoreUnit": {
"type": "boolean",
"description": "Whether this unit is a core unit for another unit. Replaces isCoreTeam",
"nullable": true
},
"isPrimaryFlexUnit": {
"type": "boolean",
"description": "Whether this unit is the main flex unit of another unit, which is the unit that flex requests are sent to first",
"nullable": true
},
"isAdditionalFlexUnit": {
"type": "boolean",
"description": "Whether this unit is an additional flex unit, which is a unit that a main flex unit can forward its flex requests to",
"nullable": true
},
"isRosterUnit": {
"type": "boolean",
"description": "Whether this unit has a main flex unit or a core unit configured, so it can send flex requests itself",
"nullable": true
},
"additionalFlexUnitIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Unit identifiers of the additional flex units this unit can forward its flex requests to",
"nullable": true
},
"allowFlexSignup": {
"type": "boolean",
"description": "Whether employees can sign up for flex requests in this team",
"nullable": true
},
"flexSignupVisibility": {
"$ref": "#/components/schemas/moves.FlexSignupVisibility"
},
"whoMakesFlexAssignments": {
"$ref": "#/components/schemas/moves.WhoMakesFlexAssignments"
}
},
"description": "A team ( or unit ) used for planning and rostering purposes.\nThis team links to the administrative team through the teamId.",
"example": {
"unitId": 1234,
"name": "Nedap VnV",
"parentUnitId": 1233,
"teamId": 4321,
"validFrom": "2019-11-19",
"validTo": "2038-01-19",
"coreUnitId": 0,
"flexUnitId": 1,
"isFlexTeam": true,
"isCoreTeam": false,
"active": true,
"teamType": "Extramuraal",
"useBlockplanning": false,
"useSelfRostering": true,
"selfRosteringStartDate": "2000-01-01",
"rosterPublicationDate": "2025-08-30",
"isFlexUnit": true,
"isCoreUnit": false,
"isPrimaryFlexUnit": true,
"isAdditionalFlexUnit": false,
"isRosterUnit": false,
"additionalFlexUnitIds": [
1235
],
"allowFlexSignup": true,
"flexSignupVisibility": "show_names",
"whoMakesFlexAssignments": "primary_flex_unit"
}
},
"moves.FlexSignupVisibility": {
"enum": [
"hide_signups",
"show_anonymous",
"show_names"
],
"type": "string",
"description": "How flex request signups of colleagues are shown to employees",
"example": "show_names"
},
"moves.WhoMakesFlexAssignments": {
"enum": [
"requesting_unit",
"primary_flex_unit",
"requesting_unit_and_primary_flex_unit",
"all_units"
],
"type": "string",
"description": "Which unit assigns employees to flex requests",
"example": "primary_flex_unit"
},
"moves.list.ClientList": {
"type": "object",
"properties": {
"clients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.Client"
}
}
},
"description": "List of Clients",
"example": {
"clients": [
{
"id": 5678,
"externalId": 5678
}
]
}
},
"moves.Client": {
"required": [
"id",
"externalId"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The client identifier",
"format": "int64"
},
"externalId": {
"type": "integer",
"description": "This field will be removed as it has the same contents as the id field",
"format": "int64",
"deprecated": true,
"x-deprecated-since": "21-05-2025"
}
},
"description": "A Client object in Moves",
"example": {
"id": 1234,
"externalId": 5678
}
},
"moves.WorkingEmployeeReport": {
"title": "WorkingEmployeeReport",
"type": "object",
"properties": {
"employeeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"nullable": true
}
},
"description": "WorkingEmployeeReport model (no description)",
"example": {
"employeeIds": [
1,
2,
3
]
}
},
"tasque.list.CareTaskGroupStatusList": {
"type": "object",
"properties": {
"careTaskGroupStatuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tasque.CareTaskGroupStatus"
}
}
},
"description": "CareTaskGroupStatusList model (no description)",
"example": {
"careTaskGroupStatuses": [
{
"name": "Care plan",
"overdue": 12,
"upcoming": 20
}
]
}
},
"tasque.CareTaskGroupStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the task group"
},
"filterParam": {
"type": "string",
"description": "Query parameters for task group when linking to Kwaliteitsmonitor"
},
"overdue": {
"type": "integer",
"description": "Count of overdue tasks",
"format": "int32",
"default": 0
},
"upcoming": {
"type": "integer",
"description": "Count of upcoming tasks",
"format": "int32",
"default": 0
}
},
"description": "CareTaskGroupStatus model (no description)",
"example": {
"name": "Care plan",
"filterParam": "group_ids[]=12",
"overdue": 12,
"upcoming": 20
}
},
"tasque.list.CareTaskOccurrenceList": {
"type": "object",
"properties": {
"careTaskOccurrences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tasque.CareTaskOccurrence"
}
}
},
"description": "CareTaskOccurrenceList model (no description)",
"example": {
"careTaskOccurrences": [
{
"id": "123f3e3",
"uuid": "abca58ed-0138-4aec-87c6-5d391e98161b",
"occurrenceDate": "2012-08-02",
"timelineId": 1,
"type": "during",
"subType": "CarePlan",
"subTypeId": "12",
"limitView": true,
"name": "Renew care plan",
"comment": "no comment",
"validFrom": "2012-08-02",
"validTo": "2012-09-02",
"recurrenceType": "single",
"monday": true,
"tuesday": true,
"wednesday": true,
"thursday": true,
"friday": true,
"saturday": true,
"sunday": true,
"cycleInterval": 1,
"subject": {
"clientId": 1,
"employeeId": 1,
"locationId": 1,
"teamId": 1
},
"executors": [
{
"employeeId": 1
}
],
"creatorId": 12,
"finishDate": "2012-08-03",
"finisherId": 12
}
]
}
},
"tasque.list.ClientIdBySubTypeList": {
"type": "object",
"properties": {
"clientIdsBySubType": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/tasque.ClientIdBySubType"
}
],
"xml": {
"name": "clientIdBySubType"
}
}
}
},
"description": "ClientIdBySubTypeList model (no description)",
"example": {
"clientIdsBySubType": [
{
"subType": "test_task_group_16",
"subTypeId": "1",
"clientId": 2
},
{
"subType": "test_task_group_16",
"subTypeId": "1",
"clientId": 4
}
]
}
},
"tasque.ClientIdBySubType": {
"type": "object",
"properties": {
"subType": {
"type": "string",
"description": "sub type of task"
},
"subTypeId": {
"type": "string",
"description": "id of sub type of task"
},
"clientId": {
"type": "integer",
"description": "client id"
}
},
"description": "ClientIdBySubType model (no description)",
"example": {
"subType": "test_task_group_16",
"subTypeId": "1",
"clientId": 2
}
},
"whismur.CareProviderSetting": {
"type": "object",
"properties": {
"provider": {
"allOf": [
{
"$ref": "#/components/schemas/whismur.Provider"
}
],
"description": "The speech to text provider configured for this care organization."
},
"recorder": {
"allOf": [
{
"$ref": "#/components/schemas/whismur.Recorder"
}
],
"description": "Recorder to use for speech to text service."
},
"recordingMode": {
"allOf": [
{
"$ref": "#/components/schemas/whismur.RecordingMode"
}
],
"description": "Recording mode to use."
},
"speechToTextActive": {
"type": "boolean",
"description": "Indicates if speech to text service is enabled for this care organization."
}
},
"description": "The speech to text settings for a care provider",
"example": {
"provider": "ATTENDI",
"recorder": "OnsSpraak",
"recordingMode": "Bulk",
"speechToTextActive": true
}
},
"whismur.Provider": {
"enum": [
"NONE",
"ATTENDI",
"DEEPGRAM",
"TELLJAMES"
],
"type": "string",
"description": "The speech to text provider configured for this care organization.",
"example": "ATTENDI"
},
"whismur.Recorder": {
"enum": [
"OnsSpraak",
"AttendiLimited",
"AttendiFull"
],
"type": "string",
"description": "Recorder to use for speech to text service.",
"example": "OnsSpraak"
},
"whismur.RecordingMode": {
"enum": [
"Bulk",
"Streaming"
],
"type": "string",
"description": "Recording mode to use.",
"example": "Bulk"
},
"moves.list.AvailabilityList": {
"type": "object",
"properties": {
"availabilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.Availability"
},
"xml": {
"name": "availability"
}
}
},
"description": "AvailabilityList model (no description)",
"example": {
"availabilities": [
{
"id": 1,
"containerId": 2891,
"start": "00:00:00.000",
"stop": "00:00:00.000",
"duration": 86400,
"validFrom": "2018-07-09",
"validTo": "2018-07-09",
"recurrenceType": "incidental",
"cycleBase": "2018-07-23",
"cycleInterval": 7,
"cycleOffset": 4,
"unitId": 1,
"availabilityTypeId": 2,
"dayPart": 2,
"comment": "Comment",
"peopleType": "Employee",
"peopleExternalId": 100
}
]
},
"xml": {
"name": "availabilities"
}
},
"moves.Availability": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"containerId": {
"type": "integer",
"format": "int64"
},
"start": {
"type": "string",
"format": "time"
},
"stop": {
"type": "string",
"format": "time"
},
"duration": {
"type": "integer",
"format": "int64"
},
"validFrom": {
"type": "string",
"format": "date"
},
"validTo": {
"type": "string",
"format": "date"
},
"recurrenceType": {
"type": "string",
"description": "\nrecurrenceType: Possible values\nincidental\nwhole_period\nrecurring\n
"
},
"cycleBase": {
"type": "string",
"format": "date"
},
"cycleInterval": {
"type": "integer",
"description": "\ncycleInterval: Every\n1 = day\n7 = week\n14 = 2 weeks\n...\n
",
"format": "int64"
},
"cycleOffset": {
"type": "integer",
"description": "\ncycleOffset: Which day\n0 = Sunday\n1 = Monday\n2 = Tuesday\n...\n
",
"format": "int64"
},
"unitId": {
"type": "integer",
"format": "int64"
},
"availabilityTypeId": {
"type": "integer",
"format": "int64"
},
"dayPart": {
"type": "integer",
"description": "\nDaypart\n0 = Night\n1 = Morning\n2 = Evening\n...\n
",
"format": "int64"
},
"comment": {
"type": "string"
},
"peopleType": {
"type": "string",
"description": "\nPossible values:\nEmployee\nClient\n
"
},
"peopleExternalId": {
"type": "integer",
"format": "int64"
}
},
"description": "An availability is a period of time in which an employee or client has 'something'.\n\nSome examples of availabilities:\n- Employee A is sick in a period\n- Employee B has training every friday in a period\n- Employee C is on holiday for a period",
"example": {
"id": 1,
"containerId": 2891,
"start": "00:00:00.000",
"stop": "00:00:00.000",
"duration": 86400,
"validFrom": "2018-07-09",
"validTo": "2018-07-09",
"recurrenceType": "incidental",
"cycleBase": "2018-07-23",
"cycleInterval": 7,
"cycleOffset": 4,
"unitId": 1,
"availabilityTypeId": 2,
"dayPart": 2,
"comment": "Comment",
"peopleType": "Employee",
"peopleExternalId": 100
},
"xml": {
"name": "availability"
}
},
"moves.list.AvailabilityTypeList": {
"type": "object",
"properties": {
"availabilityTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.AvailabilityType"
},
"xml": {
"name": "availabilityType"
}
}
},
"description": "AvailabilityTypeList model (no description)",
"example": {
"availabilityTypes": [
{
"id": 1,
"name": "Ziek",
"abbreviation": "Z",
"key": "sick",
"available": false,
"forEmployees": true,
"forClients": true,
"hourTypeId": 198,
"externalHourTypeId": 298,
"movesHourTypeId": 398,
"defaultPayrollingType": "SickLeave",
"isPublic": true,
"isSynthetic": false
}
]
},
"xml": {
"name": "availabilityTypes"
}
},
"moves.AvailabilityType": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"name": {
"type": "string"
},
"abbreviation": {
"type": "string"
},
"key": {
"type": "string"
},
"available": {
"type": "boolean",
"description": "\nIs person available\nfalse: unavailable (unavailability)\ntrue: available (availability)\n
"
},
"forEmployees": {
"type": "boolean"
},
"forClients": {
"type": "boolean"
},
"hourTypeId": {
"type": "integer",
"description": "Use moves_hour_type_id instead.",
"format": "int64",
"deprecated": true
},
"externalHourTypeId": {
"type": "integer",
"format": "int64"
},
"movesHourTypeId": {
"type": "integer",
"format": "int64"
},
"defaultPayrollingType": {
"type": "string"
},
"isPublic": {
"type": "boolean"
},
"isSynthetic": {
"type": "boolean"
}
},
"description": "An availability types are for example: Sick, Holiday, Meeting, Training\nAvailabilityTypes are linked to an employee of client via an Availability",
"example": {
"id": 1,
"name": "Ziek",
"abbreviation": "Z",
"key": "sick",
"available": false,
"forEmployees": true,
"forClients": true,
"hourTypeId": 198,
"externalHourTypeId": 298,
"movesHourTypeId": 398,
"defaultPayrollingType": "SickLeave",
"isPublic": true,
"isSynthetic": false
},
"xml": {
"name": "availabilityType"
}
},
"list.BankAccountList": {
"type": "object",
"properties": {
"bankAccounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BankAccount"
},
"xml": {
"name": "bankAccount"
}
}
},
"description": "BankAccountList model (no description)",
"example": {
"bankAccounts": [
{
"id": 1,
"number": "NL27TRIO0207182531",
"nameOfOwner": "Pietje puk",
"cityOfOwner": "Lutjebroek",
"iban": "Dummy",
"bic": "Dummy",
"creditBankAccount": false,
"authorizationDate": "2016-01-01",
"createdAt": "2016-01-01T12:00:00.000+01:00",
"updatedAt": "2016-01-01T12:00:00.000+01:00"
},
{
"id": 2,
"number": "NL27TRIO0207182532",
"nameOfOwner": "Pietje pok",
"cityOfOwner": "Lutjebroek",
"iban": "Dummy",
"bic": "Dummy",
"creditBankAccount": false,
"authorizationDate": "2016-01-01",
"createdAt": "2016-01-01T12:00:00.000+01:00",
"updatedAt": "2016-01-01T12:00:00.000+01:00"
}
]
},
"xml": {
"name": "bankAccounts"
}
},
"list.ClientAddressList": {
"type": "object",
"properties": {
"clientAddresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClientAddress"
},
"xml": {
"name": "clientAddress"
}
}
},
"description": "ClientAddressList model (no description)",
"example": {
"clientAddresses": [
{
"id": 1,
"beginDate": "2010-02-16",
"endDate": "2010-02-17",
"homeNumber": 4,
"homeNumberExtension": "a",
"poBoxNumber": "123a",
"street": "Parallelweg",
"city": "Enschede",
"zipcode": "7513KC",
"municipality": "Enschede",
"country": "Netherlands",
"telephoneNumber": "053-1234567",
"telephoneCountryCode": "+31",
"telephoneNumber2": "053-1234567",
"telephoneCountryCode2": "+31",
"faxNumber": "053-1234567",
"email": "mike.wazowski@nedap.com",
"type": "residence address",
"typeString": "local",
"residentType": "0",
"personType": "1",
"personTypeString": "client",
"roomNumber": "1",
"locationDescription": "Afdeling noord",
"updatedAt": "2016-01-01T12:00:00.000+01:00",
"createdAt": "2016-01-01T12:00:00.000+01:00",
"latitude": 52.1,
"longitude": 6.9,
"clientId": 2,
"situationDescription": "Test"
}
]
},
"xml": {
"name": "clientAddresses"
}
},
"list.ClientContactRelationAddressList": {
"type": "object",
"properties": {
"clientContactRelationAddresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClientContactRelationAddress"
},
"xml": {
"name": "clientContactRelationAddress"
}
}
},
"description": "ClientContactRelationAddressList model (no description)",
"example": {
"clientContactRelationAddresses": [
{
"id": 1,
"beginDate": "2010-02-16",
"endDate": "2010-02-17",
"homeNumber": 4,
"homeNumberExtension": "a",
"street": "Parallelweg",
"city": "Enschede",
"zipcode": "7513KC",
"municipality": "Enschede",
"country": "Netherlands",
"telephoneNumber": "053-1234567",
"telephoneCountryCode": "+31",
"telephoneNumber2": "053-1234567",
"telephoneCountryCode2": "+31",
"faxNumber": "053-1234567",
"email": "mike.wazowski@nedap.com",
"type": "residence address",
"typeString": "local",
"residentType": "0",
"personType": "client",
"personTypeString": "birthname",
"roomNumber": "1",
"locationDescription": "Afdeling noord",
"updatedAt": "2016-01-01T12:00:00.000+01:00",
"createdAt": "2016-01-01T12:00:00.000+01:00",
"latitude": 52.1,
"longitude": 6.9,
"clientContactRelationId": 1,
"situationDescription": "Test"
}
]
},
"xml": {
"name": "clientContactRelationAddresses"
}
},
"payroll.list.ContractTypeList": {
"type": "object",
"properties": {
"contractTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payroll.ContractType"
},
"xml": {
"name": "contractType"
}
}
},
"description": "ContractTypeList model (no description)",
"example": {
"contractTypes": [
{
"id": 1,
"name": "Dummy",
"importCode": "Dummy",
"payHoursDirectly": true,
"removed": true
}
]
},
"xml": {
"name": "contractTypes"
}
},
"list.EmployeeAddressList": {
"type": "object",
"properties": {
"employeeAddresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeeAddress"
},
"xml": {
"name": "employeeAddress"
}
}
},
"description": "EmployeeAddressList model (no description)",
"example": {
"employeeAddresses": [
{
"id": 1,
"beginDate": "2010-02-16",
"endDate": "2010-02-17",
"homeNumber": 4,
"homeNumberExtension": "a",
"poBoxNumber": "123a",
"street": "Parallelweg",
"city": "Enschede",
"zipcode": "7513KC",
"municipality": "Enschede",
"country": "Netherlands",
"telephoneNumber": "053-1234567",
"telephoneCountryCode": "+31",
"telephoneNumber2": "053-1234567",
"telephoneCountryCode2": "+31",
"faxNumber": "053-1234567",
"email": "mike.wazowski@nedap.com",
"type": "residence address",
"typeString": "temporary",
"residentType": "0",
"personType": "client",
"personTypeString": "birthname",
"roomNumber": "1",
"locationDescription": "Afdeling noord",
"updatedAt": "2016-01-01T12:00:00.000+01:00",
"createdAt": "2016-01-01T12:00:00.000+01:00",
"latitude": 52.1,
"longitude": 6.9,
"employeeId": 2,
"situationDescription": "Test"
}
]
},
"xml": {
"name": "employeeAddresses"
}
},
"moves.list.ExpertiseProfileList": {
"type": "object",
"properties": {
"expertiseProfiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.ExpertiseProfile"
}
}
},
"description": "ExpertiseProfileList model (no description)",
"example": {
"expertiseProfiles": [
{
"id": 1,
"externalId": 2,
"name": "Verpleegkundige",
"hidden": false,
"parent": 10
}
]
}
},
"moves.ExpertiseProfile": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"externalId": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"hidden": {
"type": "boolean"
},
"parent": {
"type": "integer",
"format": "int64"
}
},
"description": "ExpertiseProfile model (no description)",
"example": {
"id": 1,
"externalId": 2,
"name": "Verpleegkundige",
"hidden": false,
"parent": 10
}
},
"finance.list.ExportProfileList": {
"type": "object",
"properties": {
"exportProfiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/finance.ExportProfile"
},
"xml": {
"name": "exportProfile"
}
}
},
"description": "ExportProfileList model (no description)",
"example": {
"exportProfiles": [
{
"id": 1,
"beginDate": "2016-01-28T00:00:00.000+01:00",
"name": "exportProfile1",
"type": "exportProfileType1",
"filterId": 123,
"invoiceProfileId": 23,
"active": true,
"exportJournaling": true,
"exportRetourJournaling": true,
"createdAt": "2016-02-01T00:00:00.000+01:00",
"updatedAt": "2016-02-07T00:00:00.000+01:00"
},
{
"id": 2,
"beginDate": "2016-01-28T00:00:00.000+01:00",
"name": "exportProfile2",
"type": "exportProfileType2",
"filterId": 124,
"invoiceProfileId": 24,
"active": false,
"exportJournaling": true,
"exportRetourJournaling": true,
"createdAt": "2016-02-02T00:00:00.000+01:00",
"updatedAt": "2016-02-07T00:00:00.000+01:00"
}
]
},
"xml": {
"name": "exportProfiles"
}
},
"finance.ExportProfile": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"beginDate": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"filterId": {
"type": "integer",
"format": "int64"
},
"invoiceProfileId": {
"type": "integer",
"format": "int64"
},
"active": {
"type": "boolean",
"default": false
},
"exportJournaling": {
"type": "boolean",
"default": false
},
"exportRetourJournaling": {
"type": "boolean",
"default": false
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"description": "ExportProfile model (no description)",
"example": {
"id": 1,
"beginDate": "2016-01-28T00:00:00.000+01:00",
"name": "exportProfile1",
"type": "exportProfileType1",
"filterId": 123,
"invoiceProfileId": 23,
"active": true,
"exportJournaling": true,
"exportRetourJournaling": true,
"createdAt": "2016-02-01T00:00:00.000+01:00",
"updatedAt": "2016-02-07T00:00:00.000+01:00"
},
"xml": {
"name": "exportProfile"
}
},
"finance.list.FinanceLogList": {
"type": "object",
"properties": {
"financeLogs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/finance.FinanceLog"
},
"xml": {
"name": "financeLog"
}
}
},
"description": "FinanceLogList model (no description)",
"example": {
"financeLogs": [
{
"id": 1,
"clientId": 1,
"employeeId": 1,
"teamId": 1,
"careOrderProductId": 1,
"locationId": 1,
"date": "2015-01-28T00:00:00.000+01:00",
"productId": 1,
"unit": 1,
"tarief": 1,
"amount": 1,
"issue": 1,
"tariefUnit": 1,
"provider": "Dummy",
"vat": 1.234,
"debtorId": 1,
"source": "ExportPresenceLog",
"costCenter": "12345678",
"originalProductId": 1
},
{
"id": 1,
"clientId": 1,
"employeeId": 1,
"teamId": 1,
"careOrderProductId": 1,
"locationId": 1,
"date": "2015-01-28T00:00:00.000+01:00",
"productId": 1,
"unit": 1,
"tarief": 1,
"amount": 1,
"issue": 1,
"tariefUnit": 1,
"provider": "Dummy",
"vat": 1.234,
"debtorId": 1,
"source": "ExportPresenceLog",
"costCenter": "12345678",
"originalProductId": 1
}
]
},
"xml": {
"name": "financeLogs"
}
},
"finance.FinanceLog": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"clientId": {
"type": "integer",
"format": "int64"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"teamId": {
"type": "integer",
"format": "int64"
},
"careOrderProductId": {
"type": "integer",
"format": "int64"
},
"locationId": {
"type": "integer",
"format": "int64"
},
"date": {
"type": "string",
"format": "date-time"
},
"productId": {
"type": "integer",
"format": "int64"
},
"unit": {
"type": "integer",
"format": "int32"
},
"tarief": {
"type": "integer",
"format": "int32"
},
"amount": {
"type": "integer",
"format": "int32"
},
"issue": {
"type": "integer",
"format": "int32"
},
"tariefUnit": {
"type": "integer",
"format": "int32"
},
"provider": {
"type": "string"
},
"vat": {
"type": "number",
"format": "double"
},
"debtorId": {
"type": "integer",
"format": "int64"
},
"source": {
"type": "string"
},
"costCenter": {
"type": "string"
},
"originalProductId": {
"type": "integer",
"format": "int64"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"description": "Finance log model.",
"example": {
"id": 1,
"clientId": 1,
"employeeId": 1,
"teamId": 1,
"careOrderProductId": 1,
"locationId": 1,
"date": "2015-01-28T00:00:00.000+01:00",
"productId": 1,
"unit": 1,
"tarief": 1,
"amount": 1,
"issue": 1,
"tariefUnit": 1,
"provider": "Dummy",
"vat": 1.234,
"debtorId": 1,
"source": "ExportPresenceLog",
"costCenter": "12345678",
"originalProductId": 1,
"createdAt": "2015-01-28T00:00:00.000+01:00",
"updatedAt": "2015-01-28T00:00:00.000+01:00"
},
"xml": {
"name": "financeLog"
}
},
"finance.list.FinanceTypeList": {
"type": "object",
"properties": {
"financeTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/finance.FinanceType"
},
"xml": {
"name": "financeType"
}
}
},
"description": "FinanceTypeList model (no description)",
"example": {
"financeTypes": [
{
"id": 1,
"externalCode": "Dummy",
"description": "Dummy",
"userIdentifier": "Dummy",
"beginDate": "2015-01-01",
"endDate": "2019-01-01",
"systemDefined": true,
"covRequired": true,
"agbSelectionEnabled": true,
"cakDelivery": false,
"useWmoNumbering": false,
"zzpAllowed": false
}
]
},
"xml": {
"name": "financeTypes"
}
},
"list.FreeFieldAssignmentList": {
"type": "object",
"properties": {
"freeFieldAssignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FreeFieldAssignment"
},
"xml": {
"name": "freeFieldAssignment"
}
}
},
"description": "FreeFieldAssignmentList model (no description)",
"example": {
"freeFieldAssignments": [
{
"id": 1,
"carrierObjectId": 2,
"freeFieldDefinitionObjectId": 3,
"value": "Geen opmerkingen",
"createdAt": "2014-04-17",
"updatedAt": "2014-04-17"
}
]
},
"xml": {
"name": "freeFieldAssignments"
}
},
"FreeFieldAssignment": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"carrierObjectId": {
"type": "integer",
"description": "ObjectID of the table linked to the value of this free field (e.g. employee or client).",
"format": "int64"
},
"freeFieldDefinitionObjectId": {
"type": "integer",
"description": "ObjectID of the FreeFieldDefinition",
"format": "int64"
},
"value": {
"type": "string",
"description": "Value entered in the free field"
},
"createdAt": {
"type": "string",
"format": "date"
},
"updatedAt": {
"type": "string",
"format": "date"
}
},
"description": "Table containing the values of linked free fields for clients or employees",
"example": {
"id": 1,
"carrierObjectId": 2,
"freeFieldDefinitionObjectId": 3,
"value": "Geen opmerkingen",
"createdAt": "2014-04-17",
"updatedAt": "2014-04-17"
},
"xml": {
"name": "freeFieldAssignment"
}
},
"list.FreeFieldCategoryList": {
"type": "object",
"properties": {
"freeFieldCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FreeFieldCategory"
},
"xml": {
"name": "freeFieldCategory"
}
}
},
"description": "FreeFieldCategoryList model (no description)",
"example": {
"freeFieldCategories": [
{
"id": 1,
"carrierType": 1,
"name": "Employee"
}
]
},
"xml": {
"name": "freeFieldCategories"
}
},
"FreeFieldCategory": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"carrierType": {
"$ref": "#/components/schemas/CarrierType"
},
"name": {
"type": "string",
"description": "Name of the FreeFieldCategory"
}
},
"description": "Table containing the categories (such as clients and employees) that make use of free fields",
"example": {
"id": 1,
"carrierType": 1,
"name": "EMPLOYEE"
},
"xml": {
"name": "FreeFieldCategory"
}
},
"CarrierType": {
"type": "integer",
"oneOf": [
{
"title": "ACTIVITY",
"enum": [
0
]
},
{
"title": "EMPLOYEE",
"enum": [
1
]
},
{
"title": "CLIENT",
"enum": [
2
]
}
],
"description": "Specifies the type of the carrier. Possible values: 0 = ACTIVITY, 1 = EMPLOYEE, 2 = CLIENT.",
"example": 0
},
"list.FreeFieldDefinitionList": {
"type": "object",
"properties": {
"freeFieldDefinitions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FreeFieldDefinition"
},
"xml": {
"name": "FreeFieldDefinition"
}
}
},
"description": "FreeFieldDefinitionList model (no description)",
"example": {
"freeFieldDefinitions": [
{
"id": 1,
"categoryObjectId": 1,
"freeFieldType": 0,
"length": 40,
"name": "Vrij veld 1",
"readOnly": true,
"required": true,
"sequenceNumber": 1
}
]
},
"xml": {
"name": "freeFieldDefinitions"
}
},
"FreeFieldDefinition": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"categoryObjectId": {
"type": "integer",
"description": "ObjectID of the FreeFieldCategory",
"format": "int64"
},
"freeFieldType": {
"$ref": "#/components/schemas/FreeFieldType"
},
"length": {
"type": "integer",
"description": "Length of the field value",
"format": "int32"
},
"name": {
"type": "string",
"description": "Name of the free field, e.g. Vrij veld 1"
},
"readOnly": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"sequenceNumber": {
"type": "integer",
"description": "Order in which the fields are displayed",
"format": "int32"
}
},
"description": "Table of the possible free fields per category (clients, employees).",
"example": {
"id": 1,
"categoryObjectId": 1,
"freeFieldType": 0,
"length": 40,
"name": "Vrij veld 1",
"readOnly": true,
"required": true,
"sequenceNumber": 1
},
"xml": {
"name": "FreeFieldDefinition"
}
},
"FreeFieldType": {
"type": "integer",
"oneOf": [
{
"title": "STRING",
"enum": [
0
]
},
{
"title": "NUMBER",
"enum": [
1
]
},
{
"title": "BOOLEAN",
"enum": [
2
]
},
{
"title": "DATE",
"enum": [
3
]
},
{
"title": "TIME",
"enum": [
4
]
},
{
"title": "DATETIME",
"enum": [
5
]
}
],
"description": "Specifies the type of the free field. Possible values: 0 = STRING, 1 = NUMBER, 2 = BOOLEAN, 3 = DATE, 4 = TIME, 5 = DATETIME.",
"example": 0
},
"groepsplanning.list.GroupList": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/groepsplanning.Group"
}
}
},
"description": "List of groups",
"example": {
"groups": [
{
"id": 1,
"name": "alcoholics anonymous",
"description": "A group to help alcoholics recover.",
"createdAt": "2024-03-27T08:00:00.000+01:00",
"updatedAt": "2024-03-27T08:00:00.000+01:00"
},
{
"id": 2,
"name": "boulimia",
"description": "eating disorder group.",
"createdAt": "2024-03-27T08:00:00.000+01:00",
"updatedAt": "2024-03-27T08:00:00.000+01:00"
}
]
}
},
"groepsplanning.Group": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The identifier of the group",
"format": "int64",
"x-cupido-id": true
},
"name": {
"type": "string",
"description": "The name of the group"
},
"description": {
"type": "string",
"description": "The description of the group"
},
"startMoment": {
"type": "string",
"description": "Moment on which group is expected to start. Underlying data model is a date, but only the first of the month is accepted as a valid date. Should be presented to the user as a year-month select.",
"format": "date"
},
"locationId": {
"type": "integer",
"description": "The identifier of the location assigned to this group",
"format": "int64"
},
"createdAt": {
"type": "string",
"description": "The date and time when the group was created",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"description": "The date and time when the group was last altered",
"format": "date-time"
},
"archivedAt": {
"type": "string",
"description": "The date and time when the group was archived",
"format": "date-time"
}
},
"description": "A group represents a (recurring) meeting where multiple clients can participate",
"example": {
"id": 1,
"name": "alcoholics anonymous",
"description": "A group to help alcoholics recover.",
"startMoment": "2024-02-01",
"locationId": 1,
"createdAt": "2024-03-27T08:00:00.000+01:00",
"updatedAt": "2024-03-27T08:00:00.000+01:00",
"archivedAt": "2025-03-27T08:00:00.000+01:00"
}
},
"finance.list.InvoiceRowFinanceLogList": {
"type": "object",
"properties": {
"invoiceRowFinanceLogs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/finance.InvoiceRowFinanceLog"
},
"xml": {
"name": "invoiceRowFinanceLog"
}
}
},
"description": "InvoiceRowFinanceLogList model (no description)",
"example": {
"invoiceRowFinanceLogs": [
{
"invoiceRowId": 1,
"financeLogId": 1
},
{
"invoiceRowId": 1,
"financeLogId": 2
},
{
"invoiceRowId": 2,
"financeLogId": 3
},
{
"invoiceRowId": 2,
"financeLogId": 4
}
]
},
"xml": {
"name": "invoiceRowFinanceLogs"
}
},
"finance.InvoiceRowFinanceLog": {
"type": "object",
"properties": {
"invoiceRowId": {
"type": "integer",
"format": "int64"
},
"financeLogId": {
"type": "integer",
"format": "int64"
}
},
"description": "Relations between InoviceRow and FinanceLog",
"example": {
"invoiceRowId": 1,
"financeLogId": 1
},
"xml": {
"name": "invoiceRowFinanceLog"
}
},
"finance.list.InvoiceRowList": {
"type": "object",
"properties": {
"invoiceRows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/finance.InvoiceRow"
},
"xml": {
"name": "invoiceRow"
}
}
},
"description": "InvoiceRowList model (no description)",
"example": {
"invoiceRows": [
{
"id": 1,
"invoiceId": 1,
"clientId": 1,
"previousInvoiceRowId": -1,
"productId": 1,
"beginDate": "2016-01-28T00:00:00.000+01:00",
"endDate": "2016-01-29T00:00:00.000+01:00",
"careOrderProductType": 0,
"careOrderProductId": 4,
"amount": 1,
"rate": 3204,
"unit": 12,
"provider": "12345678",
"debtorId": 44,
"vat": 6.5,
"vatAmount": 192,
"rateUnit": 12,
"accepted": true,
"acceptedAmount": 3396,
"calculatedAmount": 3396,
"totalCostAmount": 3396,
"createdAt": "2016-02-01T00:00:00.000+01:00",
"updatedAt": "2016-02-07T00:00:00.000+01:00"
},
{
"id": 2,
"invoiceId": 1,
"clientId": 1,
"previousInvoiceRowId": -1,
"productId": 1,
"beginDate": "2016-01-30T00:00:00.000+01:00",
"endDate": "2016-01-31T00:00:00.000+01:00",
"careOrderProductType": 0,
"careOrderProductId": 4,
"amount": 1,
"rate": 3204,
"unit": 12,
"provider": "12345678",
"debtorId": 44,
"vat": 6.5,
"vatAmount": 192,
"rateUnit": 12,
"accepted": true,
"acceptedAmount": 3396,
"calculatedAmount": 3396,
"totalCostAmount": 3396,
"createdAt": "2016-02-01T00:00:00.000+01:00",
"updatedAt": "2016-02-07T00:00:00.000+01:00"
}
]
},
"xml": {
"name": "invoiceRows"
}
},
"finance.InvoiceRow": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"invoiceId": {
"type": "integer",
"format": "int64"
},
"clientId": {
"type": "integer",
"format": "int64"
},
"previousInvoiceRowId": {
"type": "integer",
"format": "int64"
},
"productId": {
"type": "integer",
"format": "int64"
},
"beginDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
},
"careOrderProductType": {
"type": "integer",
"format": "int32"
},
"careOrderProductId": {
"type": "integer",
"format": "int64"
},
"amount": {
"type": "integer",
"format": "int32"
},
"rate": {
"type": "integer",
"format": "int32"
},
"unit": {
"type": "integer",
"format": "int32"
},
"provider": {
"type": "string"
},
"debtorId": {
"type": "integer",
"format": "int64"
},
"vat": {
"type": "number",
"format": "double"
},
"vatAmount": {
"type": "integer",
"format": "int32"
},
"rateUnit": {
"type": "integer",
"format": "int32"
},
"accepted": {
"type": "boolean",
"default": false
},
"acceptedAmount": {
"type": "integer",
"format": "int32"
},
"calculatedAmount": {
"type": "integer",
"format": "int32"
},
"reasonRejected": {
"type": "string"
},
"totalCostAmount": {
"type": "integer",
"format": "int64"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"description": "InvoiceRow model (no description)",
"example": {
"id": 1,
"invoiceId": 1,
"clientId": 1,
"previousInvoiceRowId": -1,
"productId": 1,
"beginDate": "2016-01-28T00:00:00.000+01:00",
"endDate": "2016-01-29T00:00:00.000+01:00",
"careOrderProductType": 0,
"careOrderProductId": 4,
"amount": 1,
"rate": 3204,
"unit": 12,
"provider": "12345678",
"debtorId": 44,
"vat": 6.5,
"vatAmount": 192,
"rateUnit": 12,
"accepted": true,
"acceptedAmount": 3396,
"calculatedAmount": 3396,
"reasonRejected": "",
"totalCostAmount": 3396,
"createdAt": "2016-02-01T00:00:00.000+01:00",
"updatedAt": "2016-02-07T00:00:00.000+01:00"
},
"xml": {
"name": "invoiceRow"
}
},
"finance.list.InvoiceList": {
"type": "object",
"properties": {
"invoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/finance.Invoice"
},
"xml": {
"name": "invoice"
}
}
},
"description": "InvoiceList model (no description)",
"example": {
"invoices": [
{
"id": 1,
"invoiceCreationDate": "2016-02-01T00:00:00.000+01:00",
"exportBeginDate": "2016-01-28T00:00:00.000+01:00",
"beginDate": "2016-01-28T00:00:00.000+01:00",
"endDate": "2016-01-31T00:00:00.000+01:00",
"provider": "12345678",
"debtorId": 44,
"invoiceType": 0,
"exportProfileId": 1,
"description": "desc1",
"invoiceNumber": "ONS1234",
"completed": true,
"returnProcessedAt": "2016-02-07T00:00:00.000+01:00",
"rejected": false,
"bookDate": "2016-02-01T00:00:00.000+01:00",
"numericInvoiceNumber": 1234,
"createdAt": "2016-02-01T00:00:00.000+01:00",
"updatedAt": "2016-02-07T00:00:00.000+01:00"
},
{
"id": 2,
"invoiceCreationDate": "2016-02-02T00:00:00.000+01:00",
"exportBeginDate": "2016-01-28T00:00:00.000+01:00",
"beginDate": "2016-01-28T00:00:00.000+01:00",
"endDate": "2016-01-31T00:00:00.000+01:00",
"provider": "87654321",
"debtorId": 47,
"invoiceType": 0,
"exportProfileId": 1,
"description": "desc2",
"invoiceNumber": "ONS1235",
"completed": true,
"returnProcessedAt": "2016-02-07T00:00:00.000+01:00",
"rejected": false,
"bookDate": "2016-02-01T00:00:00.000+01:00",
"numericInvoiceNumber": 1235,
"createdAt": "2016-02-02T00:00:00.000+01:00",
"updatedAt": "2016-02-07T00:00:00.000+01:00"
}
]
},
"xml": {
"name": "invoices"
}
},
"finance.Invoice": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"invoiceCreationDate": {
"type": "string",
"format": "date-time"
},
"exportBeginDate": {
"type": "string",
"format": "date-time"
},
"beginDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
},
"provider": {
"type": "string"
},
"debtorId": {
"type": "integer",
"format": "int64"
},
"invoiceType": {
"type": "integer",
"format": "int32"
},
"exportProfileId": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"invoiceNumber": {
"type": "string"
},
"completed": {
"type": "boolean",
"default": false
},
"returnProcessedAt": {
"type": "string",
"format": "date-time"
},
"rejected": {
"type": "boolean",
"default": false
},
"returnMessage": {
"type": "string"
},
"bookDate": {
"type": "string",
"format": "date-time"
},
"numericInvoiceNumber": {
"type": "integer",
"format": "int64"
},
"retourEntryNumber": {
"type": "integer",
"format": "int64"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"description": "Invoice model (no description)",
"example": {
"id": 1,
"invoiceCreationDate": "2016-02-01T00:00:00.000+01:00",
"exportBeginDate": "2016-01-28T00:00:00.000+01:00",
"beginDate": "2016-01-28T00:00:00.000+01:00",
"endDate": "2016-01-31T00:00:00.000+01:00",
"provider": "12345678",
"debtorId": 44,
"invoiceType": 0,
"exportProfileId": 1,
"description": "desc1",
"invoiceNumber": "ONS1234",
"completed": true,
"returnProcessedAt": "2016-02-07T00:00:00.000+01:00",
"rejected": false,
"returnMessage": "json",
"bookDate": "2016-02-01T00:00:00.000+01:00",
"numericInvoiceNumber": 1234,
"retourEntryNumber": 1236,
"createdAt": "2016-02-01T00:00:00.000+01:00",
"updatedAt": "2016-02-07T00:00:00.000+01:00"
},
"xml": {
"name": "invoice"
}
},
"moves.list.MembershipList": {
"type": "object",
"properties": {
"memberships": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.Membership"
},
"xml": {
"name": "membership"
}
}
},
"description": "MembershipList model (no description)",
"example": {
"memberships": [
{
"id": 1,
"unitId": 85,
"externalEmployeeId": 421,
"movesEmployeeId": 221,
"externalId": 24,
"validFrom": "1999-12-27",
"validTo": "2015-12-27",
"hidden": true
}
]
},
"xml": {
"name": "memberships"
}
},
"moves.Membership": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"unitId": {
"type": "integer",
"format": "int64"
},
"externalEmployeeId": {
"type": "integer",
"format": "int64"
},
"movesEmployeeId": {
"type": "integer",
"format": "int64"
},
"externalId": {
"type": "integer",
"format": "int64"
},
"validFrom": {
"type": "string",
"format": "date"
},
"validTo": {
"type": "string",
"format": "date"
},
"hidden": {
"type": "boolean"
}
},
"description": "Membership model (no description)",
"example": {
"id": 1,
"unitId": 85,
"externalEmployeeId": 421,
"movesEmployeeId": 221,
"externalId": 24,
"validFrom": "1999-12-27",
"validTo": "2015-12-27",
"hidden": true
},
"xml": {
"name": "membership"
}
},
"finance.list.RestitutionList": {
"type": "object",
"properties": {
"restitutions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/finance.Restitution"
},
"xml": {
"name": "restitution"
}
}
},
"description": "RestitutionList model (no description)",
"example": {
"restitutions": [
{
"id": 1,
"financeLogId": 123,
"invoiceRowId": 124,
"originalAmount": 1,
"originalAmountUnit": 2,
"originalRate": 1,
"originalRateUnit": 2,
"restitutionAmount": 4,
"createdAt": "2016-02-01T00:00:00.000+01:00",
"updatedAt": "2016-02-07T00:00:00.000+01:00"
},
{
"id": 2,
"financeLogId": 128,
"invoiceRowId": 129,
"originalAmount": 2,
"originalAmountUnit": 4,
"originalRate": 2,
"originalRateUnit": 4,
"restitutionAmount": 8,
"createdAt": "2016-02-01T00:00:00.000+01:00",
"updatedAt": "2016-02-07T00:00:00.000+01:00"
}
]
},
"xml": {
"name": "restitutions"
}
},
"finance.Restitution": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"financeLogId": {
"type": "integer",
"format": "int64"
},
"invoiceRowId": {
"type": "integer",
"format": "int64"
},
"originalAmount": {
"type": "integer",
"format": "int64"
},
"originalAmountUnit": {
"type": "integer",
"format": "int32"
},
"originalRate": {
"type": "integer",
"format": "int64"
},
"originalRateUnit": {
"type": "integer",
"format": "int32"
},
"restitutionAmount": {
"type": "integer",
"format": "int64"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"description": "Restitution model (no description)",
"example": {
"id": 1,
"financeLogId": 123,
"invoiceRowId": 124,
"originalAmount": 1,
"originalAmountUnit": 2,
"originalRate": 1,
"originalRateUnit": 2,
"restitutionAmount": 4,
"createdAt": "2016-02-01T00:00:00.000+01:00",
"updatedAt": "2016-02-07T00:00:00.000+01:00"
},
"xml": {
"name": "restitution"
}
},
"moves.list.ShiftList": {
"type": "object",
"properties": {
"shifts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.Shift"
},
"xml": {
"name": "shift"
}
}
},
"description": "ShiftList model (no description)",
"example": {
"shifts": [
{
"id": "200@2014-04-11",
"code": "O1",
"description": "Ochtend 1",
"expertiseProfileId": 1,
"teamId": 1,
"createdById": 1,
"updatedById": 1,
"deletedById": 1,
"validFrom": "2014-01-01",
"validTo": "2014-01-01",
"transportationMethodId": 1,
"monday": true,
"tuesday": true,
"wednesday": false,
"thursday": true,
"friday": true,
"saturday": false,
"sunday": false,
"startTimes": "---\n- 2000-01-01 08:00:00.000000000 +01:00\n- 2000-01-01 08:00:00.000000000 +01:00\n- 2000-01-01 08:00:00.000000000 +01:00\n- 2000-01-01 08:00:00.000000000 +01:00\n- 2000-01-01 08:00:00.000000000 +01:00\n- 2000-01-01 08:00:00.000000000 +01:00\n- 2000-01-01 08:00:00.000000000 +01:00",
"stopTimes": "---\n- 2000-01-01 12:00:00.000000000 +01:00\n- 2000-01-01 12:00:00.000000000 +01:00\n- 2000-01-01 12:00:00.000000000 +01:00\n- 2000-01-01 12:00:00.000000000 +01:00\n- 2000-01-01 12:00:00.000000000 +01:00\n- 2000-01-01 12:00:00.000000000 +01:00\n- 2000-01-01 12:00:00.000000000 +01:00",
"breakType": 0,
"startBreakTimes": "[null,null,null,null,null,null,null]",
"stopBreakTimes": "[null,null,null,null,null,null,null]",
"dayPart": 1,
"number": 2,
"timelineId": 1,
"exportAssignments": false,
"exportHourTypeId": 1,
"exportGroupCare": false
}
]
},
"xml": {
"name": "shifts"
}
},
"moves.list.UnitList": {
"type": "object",
"properties": {
"units": {
"type": "array",
"items": {
"$ref": "#/components/schemas/moves.Unit"
},
"xml": {
"name": "unit"
}
}
},
"description": "UnitList model (no description)",
"example": {
"units": [
{
"id": 1,
"code": "ZTN",
"name": "Zorg Team Nedap",
"unitId": 1,
"externalId": 123,
"validFrom": "1999-12-27",
"validTo": "2015-12-27",
"block": false,
"flexUnitId": 1,
"nexusGroupUuid": "",
"cachedUsed": true,
"showCumulativeLedgersForecast": true,
"unitType": 2,
"allowSelfRostering": true,
"selfRosteringStartDate": "2015-07-13"
}
]
},
"xml": {
"name": "units"
}
},
"moves.Unit": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"unitId": {
"type": "integer",
"description": "use :parent_unit_id instead",
"format": "int64",
"deprecated": true
},
"parentUnitId": {
"type": "integer",
"format": "int64"
},
"externalId": {
"type": "integer",
"format": "int64"
},
"validFrom": {
"type": "string",
"format": "date"
},
"validTo": {
"type": "string",
"format": "date"
},
"block": {
"type": "boolean"
},
"flexUnitId": {
"type": "integer",
"format": "int64"
},
"nexusGroupUuid": {
"type": "string"
},
"cachedUsed": {
"type": "boolean"
},
"showCumulativeLedgersForecast": {
"type": "boolean"
},
"unitType": {
"type": "integer",
"description": "\nunitType: Possible values:\n0: EXTRAMURAL\n1: INTRAMURAL\n2: WMO\n
",
"format": "int64"
},
"allowSelfRostering": {
"type": "boolean"
},
"selfRosteringStartDate": {
"type": "string",
"format": "date"
}
},
"description": "Every unit (mostly) corresponds to a team in Ons Administration \n(however, it is possible to have a unit that is not coupled to a team).",
"example": {
"id": 1,
"code": "ZTN",
"name": "Zorg Team Nedap",
"unitId": 2,
"parentUnitId": 2,
"externalId": 123,
"validFrom": "1999-12-27",
"validTo": "2015-12-27",
"block": false,
"flexUnitId": 1,
"nexusGroupUuid": "",
"cachedUsed": true,
"showCumulativeLedgersForecast": true,
"unitType": 2,
"allowSelfRostering": true,
"selfRosteringStartDate": "2015-07-13"
},
"xml": {
"name": "unit"
}
},
"finance.list.VecozoInvoiceRelationList": {
"type": "object",
"properties": {
"vecozoInvoiceRelationList": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/finance.VecozoInvoiceRelation"
}
],
"xml": {
"name": "vecozoInvoiceRelation"
}
},
"xml": {
"name": "vecozoInvoiceRelation"
}
}
},
"description": "VecozoInvoiceRelationList model (no description)",
"example": {
"vecozoInvoiceRelationList": [
{
"id": 1,
"declarationId": "skywalker",
"invoiceId": 123,
"createdAt": "2018-02-01T00:00:00.000+01:00",
"updatedAt": "2018-02-07T00:00:00.000+01:00"
},
{
"id": 2,
"declarationId": "chewbacca",
"invoiceId": 321,
"createdAt": "2018-04-29T00:00:00.000+02:00",
"updatedAt": "2018-04-30T00:00:00.000+02:00"
}
]
},
"xml": {
"name": "vecozoInvoiceRelationList"
}
},
"finance.VecozoInvoiceRelation": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"declarationId": {
"type": "string",
"description": "ID of vecozo declaration reference"
},
"invoiceId": {
"type": "integer",
"description": "ID of related invoice",
"format": "int64"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"description": "Model containing relation between vecozo and invoice",
"example": {
"id": 1,
"declarationId": "skywalker",
"invoiceId": 123,
"createdAt": "2016-02-01T00:00:00.000+01:00",
"updatedAt": "2016-02-07T00:00:00.000+01:00"
},
"xml": {
"name": "vecozoInvoiceRelation"
}
},
"zorgmail_module.DiagnosticProcedureSearchResult": {
"type": "object",
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"diagnosticProcedures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zorgmail_module.DiagnosticProcedure"
},
"xml": {
"wrapped": true
}
}
},
"description": "DiagnosticProcedureSearchResult model (no description)",
"example": {
"hasMoreResults": true,
"diagnosticProcedures": [
{
"id": 1,
"issued": "2017-11-15T00:00:00.000+01:00",
"diagnosticReports": [
{
"id": 1,
"observations": [
{
"id": 1,
"referenceValueIndication": true,
"code": "HT B",
"comment": "Some observation",
"name": "Hb",
"lowerLimit": "0.40",
"unit": "l/l",
"upperLimit": "0.52",
"value": "0.42",
"groupName": "Differentiatie"
}
],
"category": "HEAMATOLOGIE",
"comment": "Here is all the bloodwork"
}
],
"clientId": 1,
"identification": "0805-12345",
"requestComment": "I would like a full checkup for mister X",
"reportComment": "Here is all we could find and more",
"status": "finished"
}
]
},
"xml": {
"name": "diagnosticProcedureSearchResult"
}
},
"zorgmail_module.DiagnosticProcedure": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"issued": {
"type": "string",
"description": "When was the report made",
"format": "date-time"
},
"diagnosticReports": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zorgmail_module.DiagnosticReport"
},
"xml": {
"wrapped": true
}
},
"clientId": {
"type": "integer",
"description": "id of the client",
"format": "int64"
},
"identification": {
"type": "string",
"description": "unique identification for this procedure"
},
"requestComment": {
"type": "string",
"description": "comment made by requester"
},
"reportComment": {
"type": "string",
"description": "comment made by the lab"
},
"status": {
"type": "string",
"description": "one of: PARTIAL or FINAL"
}
},
"description": "DiagnosticProcedure model (no description)",
"example": {
"id": 1,
"issued": "2017-11-15T00:00:00.000+01:00",
"diagnosticReports": [
{
"id": 1,
"observations": [
{
"id": 1,
"referenceValueIndication": true,
"code": "HT B",
"comment": "Some observation",
"name": "Hb",
"lowerLimit": "0.40",
"unit": "l/l",
"upperLimit": "0.52",
"value": "0.42",
"groupName": "Differentiatie"
}
],
"category": "HEAMATOLOGIE",
"comment": "Here is all the bloodwork"
}
],
"clientId": 1,
"identification": "0805-12345",
"requestComment": "I would like a full checkup for mister X",
"reportComment": "Here is all we could find and more",
"status": "finished"
},
"xml": {
"name": "diagnosticProcedure"
}
},
"zorgmail_module.DiagnosticReport": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"observations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/zorgmail_module.Observation"
},
"xml": {
"wrapped": true
}
},
"category": {
"type": "string",
"description": "the type of diagnostics"
},
"comment": {
"type": "string",
"description": "comment for this report made by the lab"
}
},
"description": "DiagnosticReport model (no description)",
"example": {
"id": 1,
"observations": [
{
"id": 1,
"referenceValueIndication": true,
"code": "HT B",
"comment": "Some observation",
"name": "Hb",
"lowerLimit": "0.40",
"unit": "l/l",
"upperLimit": "0.52",
"value": "0.42",
"groupName": "Differentiatie"
}
],
"category": "HEAMATOLOGIE",
"comment": "Here is all the bloodwork"
},
"xml": {
"name": "diagnosticReport"
}
},
"zorgmail_module.Observation": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"x-cupido-id": true
},
"referenceValueIndication": {
"type": "boolean",
"description": "value outside of reference values?"
},
"code": {
"type": "string",
"description": "official coding system"
},
"comment": {
"type": "string",
"description": "comment made by lab"
},
"name": {
"type": "string",
"description": "name of test"
},
"lowerLimit": {
"type": "string",
"description": "lower limit for reference values"
},
"unit": {
"type": "string",
"description": "unit of values"
},
"upperLimit": {
"type": "string",
"description": "upper limit for reference values"
},
"value": {
"type": "string",
"description": "test result"
},
"groupName": {
"type": "string",
"description": "optional name indicating a group of observations (SectieDeelBepaling)"
}
},
"description": "Observation model (no description)",
"example": {
"id": 1,
"referenceValueIndication": true,
"code": "HT B",
"comment": "Some observation",
"name": "Hb",
"lowerLimit": "0.40",
"unit": "l/l",
"upperLimit": "0.52",
"value": "0.42",
"groupName": "Differentiatie"
},
"xml": {
"name": "observation"
}
},
"carepath.CarePath": {
"required": [
"uuid",
"clientId",
"name",
"startDate",
"endDate"
],
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "The UUID of this template",
"x-cupido-id": true
},
"clientId": {
"type": "integer",
"description": "The client object identifier",
"format": "int64"
},
"name": {
"type": "string",
"description": "The name of the first template used for creating this care path"
},
"startDate": {
"type": "string",
"description": "The start date of this care path",
"format": "date"
},
"endDate": {
"type": "string",
"description": "The end date of this care path",
"format": "date"
},
"templates": {
"type": "array",
"items": {
"type": "string",
"description": "The templates that have been used to create this care path",
"xml": {
"name": "template"
}
},
"description": "The templates that have been used to create this care path",
"xml": {
"wrapped": true
}
},
"activeModules": {
"type": "array",
"items": {
"type": "string",
"description": "Modules that are active in this care path",
"xml": {
"name": "activeModule"
}
},
"description": "Modules that are active in this care path",
"xml": {
"wrapped": true
}
}
},
"description": "A 'Zorgpad' of a client",
"example": {
"uuid": "a96d1820-bf15-4797-961b-735407ee7230",
"clientId": 123,
"name": "Dummy",
"startDate": "2010-10-10",
"endDate": "2011-01-01",
"templates": [
"Template"
],
"activeModules": [
"Module"
]
},
"xml": {
"name": "carePath"
}
}
}
},
"tags": [
{
"name": "Address"
},
{
"name": "admin.BackgroundImage"
},
{
"name": "admin.License"
},
{
"name": "admin.LogoImage"
},
{
"name": "admin.TimesheetConfig"
},
{
"name": "admin.Version"
},
{
"name": "Agbcode"
},
{
"name": "agenda.AgendaOccurrence"
},
{
"name": "agenda.AgendaSeries"
},
{
"name": "agenda.ClientAbsenceOccurrence"
},
{
"name": "agenda.Label"
},
{
"name": "agenda.RegistrationStatus"
},
{
"name": "agenda.ReservationCreate"
},
{
"name": "agenda.ReservationOccurrence"
},
{
"name": "agenda.Unavailability"
},
{
"name": "arrangement.Intent"
},
{
"name": "arrangement.IntentPreference"
},
{
"name": "arrangement.Stakeholder"
},
{
"name": "arrangement.TimeSlot"
},
{
"name": "authorization.provisioning.DefaultScope"
},
{
"name": "authorization.provisioning.MyLocations"
},
{
"name": "authorization.provisioning.MyTeams"
},
{
"name": "authorization.provisioning.Role"
},
{
"name": "authorization.provisioning.User"
},
{
"name": "authorization.provisioning.UserDuties"
},
{
"name": "authorization.provisioning.UserScopeSettings"
},
{
"name": "BankAccount"
},
{
"name": "Bsn"
},
{
"name": "capacity.CapacityProfile"
},
{
"name": "CareAllocation"
},
{
"name": "CareArrangement"
},
{
"name": "carepath.CarePath"
},
{
"name": "carepath.Template"
},
{
"name": "CareProvider"
},
{
"name": "CareProviderAddress"
},
{
"name": "caretech.Order"
},
{
"name": "caretech.ProductAllocation"
},
{
"name": "caretech.ReturnRequest"
},
{
"name": "Client"
},
{
"name": "client_story.ChangeSet"
},
{
"name": "client_story.Story"
},
{
"name": "ClientAbsence"
},
{
"name": "ClientAbsenceReason"
},
{
"name": "ClientAddress"
},
{
"name": "ClientCard"
},
{
"name": "ClientContactRelation"
},
{
"name": "ClientContactRelationAddress"
},
{
"name": "ClientContactRelationType"
},
{
"name": "ClientEmployeeRelation"
},
{
"name": "ClientEmployeeRelationType"
},
{
"name": "ClientsInCare"
},
{
"name": "CostCenterSelectionOption"
},
{
"name": "DashboardProfile"
},
{
"name": "dbc.DBCSubTraject"
},
{
"name": "dbc.DBCTraject"
},
{
"name": "dbc.ggz.DiagnoseToekenning"
},
{
"name": "dbc.ggz.fz.Subtraject"
},
{
"name": "dbc.ggz.PresenceLogSynchronisationError"
},
{
"name": "dbc.ggz.Subtraject"
},
{
"name": "dbc.ggz.ValidationError"
},
{
"name": "dbc.ggz.Zorgtraject"
},
{
"name": "Debtor"
},
{
"name": "dienst_verwijzen_module.BundleWrapper"
},
{
"name": "Document"
},
{
"name": "dossier.Action"
},
{
"name": "dossier.ActionEntry"
},
{
"name": "dossier.ActionEntrySummary"
},
{
"name": "dossier.ActiveCarePlanMetadata"
},
{
"name": "dossier.admin.alerts.Topic"
},
{
"name": "dossier.Alert"
},
{
"name": "dossier.CarePlan"
},
{
"name": "dossier.CarePlanAgreement"
},
{
"name": "dossier.CarePlanEntry"
},
{
"name": "dossier.CarePlanReportRight"
},
{
"name": "dossier.CarePlanSignatureRequirement"
},
{
"name": "dossier.ClientNote"
},
{
"name": "dossier.Demand"
},
{
"name": "dossier.DemandEntry"
},
{
"name": "dossier.Domain"
},
{
"name": "dossier.episodes.Action"
},
{
"name": "dossier.episodes.Episode"
},
{
"name": "dossier.episodes.SubGoal"
},
{
"name": "dossier.Goal"
},
{
"name": "dossier.GoalEntry"
},
{
"name": "dossier.InvoluntaryCareExportEntry"
},
{
"name": "dossier.LastMedicalMoment"
},
{
"name": "dossier.medical.advance_directives.Context"
},
{
"name": "dossier.medical.dsm.Classification"
},
{
"name": "dossier.medical.dsm.ClassificationSeries"
},
{
"name": "dossier.medical.involuntary_care.Incompetence"
},
{
"name": "dossier.medical.involuntary_care.LegalStatus"
},
{
"name": "dossier.medical.MedicalSummary"
},
{
"name": "dossier.medical.Problem"
},
{
"name": "dossier.medical.PropensityToAdverseReaction"
},
{
"name": "dossier.medical.SimplifiedPropensityToAdverseReaction"
},
{
"name": "dossier.MedicalNote"
},
{
"name": "dossier.omaha.ClassifiedProblem"
},
{
"name": "dossier.omaha.InterventionCategory"
},
{
"name": "dossier.omaha.InterventionTarget"
},
{
"name": "dossier.omaha.OmahaClassification"
},
{
"name": "dossier.omaha.Problem"
},
{
"name": "dossier.Report"
},
{
"name": "dossier.ReportType"
},
{
"name": "dossier.ReportWithActions"
},
{
"name": "dossier.RestrictiveMeasureCarePlanEntry"
},
{
"name": "dossier.RestrictiveMeasureRegistration"
},
{
"name": "dossier.SystemNote"
},
{
"name": "Employee"
},
{
"name": "EmployeeAddress"
},
{
"name": "EmployeePrivacySettings"
},
{
"name": "EmployeeWorkflow"
},
{
"name": "evs.EvsAbility"
},
{
"name": "evs.ResponseMessage"
},
{
"name": "expense.Expense"
},
{
"name": "expense.ExpenseAddressModel"
},
{
"name": "expense.ExpenseType"
},
{
"name": "ExpertiseGroup"
},
{
"name": "ExpertiseProfile"
},
{
"name": "ExpertiseProfileAssignment"
},
{
"name": "export.ExportPresenceLog"
},
{
"name": "finance.CareOrder"
},
{
"name": "finance.CareOrderProduct"
},
{
"name": "finance.ClientFinancedProduct"
},
{
"name": "finance.DebtorGroup"
},
{
"name": "finance.DeclarationRule"
},
{
"name": "finance.ExportProfile"
},
{
"name": "finance.FinanceLog"
},
{
"name": "finance.FinanceType"
},
{
"name": "finance.ForensicCareOrder"
},
{
"name": "finance.GroupActivitySuggestionModel"
},
{
"name": "finance.Invoice"
},
{
"name": "finance.InvoiceProviderGroup"
},
{
"name": "finance.InvoiceRow"
},
{
"name": "finance.InvoiceRowFinanceLog"
},
{
"name": "finance.ParallelCareOrder"
},
{
"name": "finance.Product"
},
{
"name": "finance.Restitution"
},
{
"name": "finance.VecozoInvoiceRelation"
},
{
"name": "FreeFieldAssignment"
},
{
"name": "FreeFieldCategory"
},
{
"name": "FreeFieldDefinition"
},
{
"name": "fvc.FvcMessage"
},
{
"name": "groepsplanning.Group"
},
{
"name": "groupcare.Group"
},
{
"name": "groupcare.Occurrence"
},
{
"name": "harmony.ZorgdomeinFhirConnector"
},
{
"name": "herald.AnnouncementCount"
},
{
"name": "hermes.CareProviderSettings"
},
{
"name": "hermes.ContactMethod"
},
{
"name": "hermes.Notification"
},
{
"name": "HourType"
},
{
"name": "HourTypeCategory"
},
{
"name": "HourTypeProductAssignment"
},
{
"name": "Insurance"
},
{
"name": "jw.JwZorglegitimatie"
},
{
"name": "kamino.KaminoSetting"
},
{
"name": "Location"
},
{
"name": "LocationAssignment"
},
{
"name": "LocationAssignmentResidence"
},
{
"name": "LocationAssignmentWaitingList"
},
{
"name": "medication.DoubleCheck"
},
{
"name": "medication.DoubleCheckChange"
},
{
"name": "medication.MedicationAdministration"
},
{
"name": "medication.MedicationPlan"
},
{
"name": "milo.Device"
},
{
"name": "moves.Absence"
},
{
"name": "moves.Availability"
},
{
"name": "moves.AvailabilityType"
},
{
"name": "moves.ClientPlannedSchedulePlannedVisit"
},
{
"name": "moves.ClientPlanningFilter"
},
{
"name": "moves.Container"
},
{
"name": "moves.EmployeeExportJob"
},
{
"name": "moves.EmployeeHoursReport"
},
{
"name": "moves.EmployeeMovesProfile"
},
{
"name": "moves.EmployeePlanning"
},
{
"name": "moves.EmployeeSchedule"
},
{
"name": "moves.ExpertiseProfile"
},
{
"name": "moves.FlexSignup"
},
{
"name": "moves.Membership"
},
{
"name": "moves.NavigationAvailability"
},
{
"name": "moves.PlanCardOccurrence"
},
{
"name": "moves.PlannedVisit"
},
{
"name": "moves.RosterSlot"
},
{
"name": "moves.Shift"
},
{
"name": "moves.ShiftAssignment"
},
{
"name": "moves.Team"
},
{
"name": "moves.Unit"
},
{
"name": "moves.WorkingEmployeeReport"
},
{
"name": "NavigationAvailability"
},
{
"name": "nexus.ClientContactRelationType"
},
{
"name": "nexus.ClientEmployeeRelation"
},
{
"name": "nexus.ClientEmployeeRelationType"
},
{
"name": "nexus.OrganisationCategory"
},
{
"name": "nexus.PersonalRelationType"
},
{
"name": "nuts.Consent"
},
{
"name": "ons_administration.EmployeeWorkdaysOverviewModel"
},
{
"name": "ons_administration.ExtendedEmployeeModel"
},
{
"name": "ons_administration.TimeCompensationFactorModel"
},
{
"name": "ons_administration.WorkdayHourTypeModel"
},
{
"name": "ons_administration.WorkdayNormPeriodModel"
},
{
"name": "ons_administration.WorkdayNormSettingsModel"
},
{
"name": "ons_client.SharedResource"
},
{
"name": "ons_ehr.GgzPlanStatistics"
},
{
"name": "ons_ehr.LastVisitedPlan"
},
{
"name": "ons_ehr.NavigationAvailability"
},
{
"name": "ons_ehr.Setting"
},
{
"name": "onsimport.Run"
},
{
"name": "openehr.ArchetypeWrapper"
},
{
"name": "openehr.CarePlanVvtCareProfileLink"
},
{
"name": "openehr.CompositionWrapper"
},
{
"name": "openehr.EmployeeGroup"
},
{
"name": "openehr.ItemTag"
},
{
"name": "openehr.MultimediaFile"
},
{
"name": "payroll.AccountEntry"
},
{
"name": "payroll.AccountType"
},
{
"name": "payroll.AccountTypeExpireStatistic"
},
{
"name": "payroll.CollectiveAgreement"
},
{
"name": "payroll.CollectiveAgreementAssignment"
},
{
"name": "payroll.CollectiveAgreementRule"
},
{
"name": "payroll.Contract"
},
{
"name": "payroll.ContractType"
},
{
"name": "payroll.holiday.Holiday"
},
{
"name": "payroll.HourlyWage"
},
{
"name": "payroll.PayableHoursAverage"
},
{
"name": "payroll.WorkHoursBalance"
},
{
"name": "payroll.WorkLoad"
},
{
"name": "PersonalRelationType"
},
{
"name": "portal.EmployeePortalProfile"
},
{
"name": "Practitioner"
},
{
"name": "PractitionerAgbCode"
},
{
"name": "PractitionerBigCode"
},
{
"name": "PractitionerProfession"
},
{
"name": "PresenceLog"
},
{
"name": "ProfileActivityAssignment"
},
{
"name": "Referral"
},
{
"name": "Skn"
},
{
"name": "status.ApplicationStatus"
},
{
"name": "survey.Answer"
},
{
"name": "survey.AnswerDefinitionGroup"
},
{
"name": "survey.GroupAnswer"
},
{
"name": "survey.Survey"
},
{
"name": "survey.SurveyResult"
},
{
"name": "tasque.CareTaskGroup"
},
{
"name": "tasque.CareTaskGroupStatus"
},
{
"name": "tasque.CareTaskOccurrence"
},
{
"name": "tasque.CareTaskSeries"
},
{
"name": "Team"
},
{
"name": "TeamAddress"
},
{
"name": "TeamAssignment"
},
{
"name": "toezicht.Audit"
},
{
"name": "transport.ClientTransport"
},
{
"name": "TreatmentLocation"
},
{
"name": "User"
},
{
"name": "VehicleAssignmentModel"
},
{
"name": "WeeksheetProfile"
},
{
"name": "whismur.CareProviderSetting"
},
{
"name": "wlz.WlzZorglegitimatie"
},
{
"name": "wmo.WmoZorglegitimatie"
},
{
"name": "worksheet.Worksheet"
},
{
"name": "zorgdomein_module.BundleWrapper"
},
{
"name": "zorgmail_module.DiagnosticProcedure"
},
{
"name": "zorgmail_module.ZorgmailMailboxDto"
},
{
"name": "zpm.CareOrderZpmDetails"
},
{
"name": "zpm.ZpmGbggzProfiel"
},
{
"name": "zpm.ZpmSetting"
},
{
"name": "zpm.ZpmZorglabel"
}
]
}