Nedap Dossier.Report API

The dossier.Report API from Nedap — 52 operation(s) for dossier.report.

Operations 56

POST /t/dossier/reports Create Report #
GET /t/dossier/reports/{id} Return the Report corresponding to the given id #
PUT /t/dossier/reports/{id} Updates the given Report #
DELETE /t/dossier/reports/{id} Deletes the Report with given id #
GET /t/dossier/reports/{report_id}/children Returns all the reactions for a given report #
GET /t/dossier/reports/by_care_plan_entry_unescaped/{care_plan_entry_id} Returns all reports filtered by care plan entry without applying HTML esaping #
GET /t/dossier/reports/by_care_plan_entry/{care_plan_entry_id} Returns all reports filtered by care plan entry with HTML escaping applied to… #
GET /t/dossier/reports/by_date Returns all reports filtered by date #
GET /t/dossier/reports/by_demand/{demand_id} Returns all reports filtered by demand id #
GET /t/dossier/reports/by_episode/{episode_id} Returns all reports filtered by episode id #
GET /t/dossier/reports/by_restrictive_measure/{restrictive_measure_id} Returns all reports filtered by restrictive measures id #
GET /t/dossier/reports/by_uuid/{uuid} Return the Report corresponding to the given uuid #
GET /t/dossier/reports/last_report_authorizations Return the child Reports of a Report corresponding to the given id #
GET /t/dossier/reports/search_by_client Searches for Reports for the Client (corresponding to the given id) #
POST /t/dossier/reports/soap/report Create a SOAP report where each soap-part (optionally) has it's own… #
PUT /t/dossier/reports/soap/report/{id} Updates a SOAP report where each soap-part (optionally) has it's own… #
POST /t/dossier/authorized/clients/{client_id}/reports Create Report. Authorization is done in dossier controller this points to #
PUT /t/dossier/authorized/clients/{client_id}/reports/{report_id} Update Report. Authorization is done in dossier controller this points to #
GET /t/dossier/authorized/clients/{client_id}/reports/search_by_client Return Reports, filtered by params Authorization is done in dossier controller… #
GET /t/dossier/authorized/clients/{client_id}/reports/search_by_client_with_updated_since Return Reports with updated since option, filtered by params Authorization is… #
GET /t/dossier/clients/{client_id}/reports/vital_signs_reports Lists vital signs from reports #
GET /t/dossier/authorized/reports/with_actions Return reports that have actions created by user or for user's expertise #
GET /t/dossier/authorized/reports/with_actions_summary Return a count of reports that have actions created by user or for user's… #
GET /t/dossier/authorized/clients/{client_id}/reports/unfiltered_search_by_client Return Reports Unfiltered, filtered by params Authorization is done in dossier… #
GET /t/dossier/reports/x-stream-connect/data Return all Report models in a streaming manner #
GET /t/dossier/reports/x-stream-connect/updates Return all Report models which were updated since the date given in the request #
POST /v0/administration/dossier/reports Create Report #
GET /v0/administration/dossier/reports/{id} Return the Report corresponding to the given id #
PUT /v0/administration/dossier/reports/{id} Updates the given Report #
DELETE /v0/administration/dossier/reports/{id} Deletes the Report with given id #
GET /v0/administration/dossier/reports/{report_id}/children Returns all the reactions for a given report #
GET /v0/administration/dossier/reports/by_care_plan_entry_unescaped/{care_plan_entry_id} Returns all reports filtered by care plan entry without applying HTML esaping #
GET /v0/administration/dossier/reports/by_care_plan_entry/{care_plan_entry_id} Returns all reports filtered by care plan entry with HTML escaping applied to… #
GET /v0/administration/dossier/reports/by_date/{valid_from}...{valid_to} Returns all reports filtered by date #
GET /v0/administration/dossier/reports/by_demand/{demand_id} Returns all reports filtered by demand id #
GET /v0/administration/dossier/reports/by_episode/{episode_id} Returns all reports filtered by episode id #
GET /v0/administration/dossier/reports/by_restrictive_measure/{restrictive_measure_id} Returns all reports filtered by restrictive measures id #
GET /v0/administration/dossier/reports/by_uuid/{uuid} Return the Report corresponding to the given uuid #
GET /v0/administration/dossier/reports/last_report_authorizations Return the child Reports of a Report corresponding to the given id #
GET /v0/administration/dossier/reports/search_by_client Searches for Reports for the Client (corresponding to the given id) #
POST /v0/administration/dossier/reports/soap/report Create a SOAP report where each soap-part (optionally) has it's own… #
PUT /v0/administration/dossier/reports/soap/report/{id} Updates a SOAP report where each soap-part (optionally) has it's own… #
POST /v0/dossier/back_channel/authorized/clients/{client_id}/reports Create Report. Authorization is done in dossier controller this points to #
PUT /v0/dossier/back_channel/authorized/clients/{client_id}/reports/{report_id} Update Report. Authorization is done in dossier controller this points to #
GET /v0/dossier/back_channel/authorized/clients/{client_id}/reports/search_by_client Return Reports, filtered by params Authorization is done in dossier controller… #
GET /v0/dossier/back_channel/authorized/clients/{client_id}/reports/search_by_client_with_updated_since Return Reports with updated since option, filtered by params Authorization is… #
GET /v0/dossier/back_channel/authorized/clients/{client_id}/reports/vital_signs_reports Lists vital signs from reports #
GET /v0/dossier/back_channel/authorized/reports/with_actions Return reports that have actions created by user or for user's expertise #
GET /v0/dossier/back_channel/authorized/reports/with_actions_summary Return a count of reports that have actions created by user or for user's… #
GET /v0/dossier/back_channel/unauthorized/clients/{client_id}/reports/unfiltered_search_by_client Return Reports Unfiltered, filtered by params Authorization is done in dossier… #
GET /v0/xstream/reports/data Return all Report models in a streaming manner #
GET /v0/xstream/reports/updates Return all Report models which were updated since the date given in the request #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/nedap-dossier-report-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nedap-dossier-report-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nedap Dossier.Report API
  version: 0.0.0
  description: 'Operations tagged dossier.Report across 2 of this provider''s published API definitions: nedap-ons-deprecated-openapi-original.json, nedap-ons-openapi-original.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api-development.ons.io
tags:
- name: dossier.Report
paths:
  /t/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-replaced-by: /v0/administration/dossier/reports
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/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-replaced-by: /v0/administration/dossier/reports/{id}
      deprecated: true
      x-deprecated-since: 19-11-2025
    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-replaced-by: /v0/administration/dossier/reports/{id}
      deprecated: true
      x-deprecated-since: 19-11-2025
    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-replaced-by: /v0/administration/dossier/reports/{id}
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/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-replaced-by: /v0/administration/dossier/reports/{report_id}/children
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/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-replaced-by: /v0/administration/dossier/reports/by_care_plan_entry_unescaped/{care_plan_entry_id}
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/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…
      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-replaced-by: /v0/administration/dossier/reports/by_care_plan_entry/{care_plan_entry_id}
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/dossier/reports/by_date:
    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: query
        description: starting time
        required: true
        schema:
          type: string
          format: date
      - name: valid_to
        in: query
        description: end time
        required: true
        schema:
          type: string
          format: date
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dossier.list.ReportList'
      x-replaced-by: /v0/administration/dossier/reports/by_date/{valid_from}...{valid_to}
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/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-replaced-by: /v0/administration/dossier/reports/by_demand/{demand_id}
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/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-replaced-by: /v0/administration/dossier/reports/by_episode/{episode_id}
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/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-replaced-by: /v0/administration/dossier/reports/by_report_link/{report_link_id}
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/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-replaced-by: /v0/administration/dossier/reports/by_restrictive_measure/{restrictive_measure_id}
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/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-replaced-by: /v0/administration/dossier/reports/by_uuid/{uuid}
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/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-replaced-by: /v0/administration/dossier/reports/last_report_authorizations
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/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-replaced-by: /v0/administration/dossier/reports/search_by_client
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/dossier/reports/soap/report:
    post:
      tags:
      - dossier.Report
      summary: Create a SOAP report where each soap-part (optionally) has it's own…
      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-replaced-by: /v0/administration/dossier/reports/soap/report
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/dossier/reports/soap/report/{id}:
    put:
      tags:
      - dossier.Report
      summary: Updates a SOAP report where each soap-part (optionally) has it's own…
      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-replaced-by: /v0/administration/dossier/reports/soap/report/{id}
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/dossier/authorized/clients/{client_id}/reports:
    post:
      tags:
      - dossier.Report
      summary: Create Report. Authorization 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-replaced-by: /v0/dossier/back_channel/authorized/clients/{client_id}/reports
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/dossier/authorized/clients/{client_id}/reports/{report_id}:
    put:
      tags:
      - dossier.Report
      summary: Update Report. Authorization 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-replaced-by: /v0/dossier/back_channel/authorized/clients/{client_id}/reports/{report_id}
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/dossier/authorized/clients/{client_id}/reports/search_by_client:
    get:
      tags:
      - dossier.Report
      summary: Return Reports, filtered by params Authorization is done in dossier controller…
      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-replaced-by: /v0/dossier/back_channel/authorized/clients/{client_id}/reports/search_by_client
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/dossier/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 Authorization is…
      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-replaced-by: /v0/dossier/back_channel/authorized/clients/{client_id}/reports/search_by_client_with_updated_since
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/dossier/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-replaced-by: /v0/dossier/back_channel/authorized/clients/{client_id}/reports/vital_signs_reports
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/dossier/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
        re

# --- truncated at 32 KB (97 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/nedap/refs/heads/main/openapi/nedap-dossier-report-api-openapi.yml