Nedap Care Provider API

The CareProvider API from Nedap — 16 operation(s) for careprovider.

Operations 16

POST /t/external_care_providers Create CareProvider #
POST /t/external_care_providers/{care_provider_id}/assign_to_client/{client_id} Assigns an external care provider to a client #
DELETE /t/external_care_providers/{care_provider_id}/unassign_from_client/{client_id} Unassigns an external care provider from a client #
GET /t/external_care_providers/{id} Return the Care Provider corresponding to the given id #
GET /t/external_care_providers/category/{category_id}/{identification} Care provider API by category and identification #
GET /t/external_care_providers/identification/{identification} Return the Care Provider corresponding to the given identification #
GET /t/external_care_providers/ura/{ura_number} Return the Care Providers corresponding to the given URA number #
GET /t/clients/{client_id}/care_providers Return the care providers of a Client corresponding to the given id #
POST /v0/administration/careproviders Create CareProvider #
POST /v0/administration/careproviders/{care_provider_id}/assign_to_client/{client_id} Assigns an external care provider to a client #
DELETE /v0/administration/careproviders/{care_provider_id}/unassign_from_client/{client_id} Unassigns an external care provider from a client #
GET /v0/administration/careproviders/{id} Return the Care Provider corresponding to the given id #
GET /v0/administration/careproviders/category/{category_id}/{identification} Care provider API by category and identification #
GET /v0/administration/careproviders/identification/{identification} Return the Care Provider corresponding to the given identification #
GET /v0/administration/careproviders/ura/{ura_number} Return the Care Providers corresponding to the given URA number #
GET /v0/administration/clients/{client_id}/careproviders Return the care providers of a Client corresponding to the given id #

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-careprovider-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-careprovider-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nedap Care Provider API
  version: 0.0.0
  description: 'Operations tagged CareProvider 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: CareProvider
paths:
  /t/external_care_providers:
    post:
      tags:
      - CareProvider
      summary: Create CareProvider
      operationId: CareProviderAPI.create
      requestBody:
        description: CareProvider to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CareProvider'
        required: true
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CareProvider'
        '400':
          description: Bad request
      x-cupido-common-method: true
      x-replaced-by: /v0/administration/careproviders
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/external_care_providers/{care_provider_id}/assign_to_client/{client_id}:
    post:
      tags:
      - CareProvider
      summary: Assigns an external care provider to a client
      description: After doing this, that care provider will be returned when calling /clients/{id}/care_providers
      operationId: CareProviderAPI.assignCareProviderToClient
      parameters:
      - name: care_provider_id
        in: path
        description: the id of the care provider
        required: true
        schema:
          type: integer
          format: int64
      - name: client_id
        in: path
        description: the id of the client
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: External care provider assigned
      x-replaced-by: /v0/administration/careproviders/{care_provider_id}/assign_to_client/{client_id}
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/external_care_providers/{care_provider_id}/unassign_from_client/{client_id}:
    delete:
      tags:
      - CareProvider
      summary: Unassigns an external care provider from a client
      description: After doing this, that care provider will no longer be returned when calling /clients/{id}/care_providers
      operationId: CareProviderAPI.unassignCareProviderFromClient
      parameters:
      - name: care_provider_id
        in: path
        description: the id of the care provider
        required: true
        schema:
          type: integer
          format: int64
      - name: client_id
        in: path
        description: the id of the client
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: External care provider unassigned
      x-replaced-by: /v0/administration/careproviders/{care_provider_id}/unassign_from_client/{client_id}
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/external_care_providers/{id}:
    get:
      tags:
      - CareProvider
      summary: Return the Care Provider corresponding to the given id
      operationId: CareProviderAPI.byId
      parameters:
      - name: id
        in: path
        description: used for selecting CareProvider
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CareProvider'
        '404':
          description: Care provider not found
      x-cupido-common-method: true
      x-replaced-by: /v0/administration/careproviders/{id}
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/external_care_providers/category/{category_id}/{identification}:
    get:
      tags:
      - CareProvider
      operationId: CareProviderAPI.byCategoryAndIdentification
      parameters:
      - name: category_id
        in: path
        description: Category of CareProvider
        required: true
        schema:
          type: integer
          format: int64
      - name: identification
        in: path
        description: ID of care provider (not object ID)
        required: true
        schema:
          type: string
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CareProvider'
      x-replaced-by: /v0/administration/careproviders/category/{category_id}/{identification}
      deprecated: true
      x-deprecated-since: 19-11-2025
      summary: Care provider API by category and identification
      x-summary-source: derived
    servers:
    - url: https://api-development.ons.io
  /t/external_care_providers/identification/{identification}:
    get:
      tags:
      - CareProvider
      summary: Return the Care Provider corresponding to the given identification
      operationId: CareProviderAPI.byIdentification
      parameters:
      - name: identification
        in: path
        description: identification of care provider (not object ID)
        required: true
        schema:
          type: string
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list.CareProviderList'
        '404':
          description: Care provider not found
      x-replaced-by: /v0/administration/careproviders/identification/{identification}
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/external_care_providers/ura/{ura_number}:
    get:
      tags:
      - CareProvider
      summary: Return the Care Providers corresponding to the given URA number
      operationId: CareProviderAPI.byUraNumber
      parameters:
      - name: ura_number
        in: path
        description: URA number used for selecting CareProviders. Must consist of exactly 8 digits.
        required: true
        schema:
          pattern: ^[0-9]{8}$
          type: string
          example: '12345678'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list.CareProviderList'
        '400':
          description: Invalid URA number. Must consist of exactly 8 digits.
      x-replaced-by: /v0/administration/careproviders/ura/{ura_number}
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /t/clients/{client_id}/care_providers:
    get:
      tags:
      - CareProvider
      summary: Return the care providers of a Client corresponding to the given id
      operationId: CareProviderAPI.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.CareProviderList'
      x-replaced-by: /v0/administration/clients/{client_id}/careproviders
      deprecated: true
      x-deprecated-since: 19-11-2025
    servers:
    - url: https://api-development.ons.io
  /v0/administration/careproviders:
    post:
      tags:
      - CareProvider
      summary: Create CareProvider
      operationId: CareProviderAPI.create
      requestBody:
        description: CareProvider to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CareProvider'
        required: true
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CareProvider'
        '400':
          description: Bad request
      x-cupido-common-method: true
      x-replacement-for:
      - /t/external_care_providers
    servers:
    - url: https://api-development.ons.io
  /v0/administration/careproviders/{care_provider_id}/assign_to_client/{client_id}:
    post:
      tags:
      - CareProvider
      summary: Assigns an external care provider to a client
      description: After doing this, that care provider will be returned when calling /clients/{id}/care_providers
      operationId: CareProviderAPI.assignCareProviderToClient
      parameters:
      - name: care_provider_id
        in: path
        description: the id of the care provider
        required: true
        schema:
          type: integer
          format: int64
      - name: client_id
        in: path
        description: the id of the client
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: External care provider assigned
      x-replacement-for:
      - /t/external_care_providers/{care_provider_id}/assign_to_client/{client_id}
    servers:
    - url: https://api-development.ons.io
  /v0/administration/careproviders/{care_provider_id}/unassign_from_client/{client_id}:
    delete:
      tags:
      - CareProvider
      summary: Unassigns an external care provider from a client
      description: After doing this, that care provider will no longer be returned when calling /clients/{id}/care_providers
      operationId: CareProviderAPI.unassignCareProviderFromClient
      parameters:
      - name: care_provider_id
        in: path
        description: the id of the care provider
        required: true
        schema:
          type: integer
          format: int64
      - name: client_id
        in: path
        description: the id of the client
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: External care provider unassigned
      x-replacement-for:
      - /t/external_care_providers/{care_provider_id}/unassign_from_client/{client_id}
    servers:
    - url: https://api-development.ons.io
  /v0/administration/careproviders/{id}:
    get:
      tags:
      - CareProvider
      summary: Return the Care Provider corresponding to the given id
      operationId: CareProviderAPI.byId
      parameters:
      - name: id
        in: path
        description: used for selecting CareProvider
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CareProvider'
        '404':
          description: Care provider not found
      x-cupido-common-method: true
      x-replacement-for:
      - /t/external_care_providers/{id}
    servers:
    - url: https://api-development.ons.io
  /v0/administration/careproviders/category/{category_id}/{identification}:
    get:
      tags:
      - CareProvider
      operationId: CareProviderAPI.byCategoryAndIdentification
      parameters:
      - name: category_id
        in: path
        description: Category of CareProvider
        required: true
        schema:
          type: integer
          format: int64
      - name: identification
        in: path
        description: ID of care provider (not object ID)
        required: true
        schema:
          type: string
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CareProvider'
      x-replacement-for:
      - /t/external_care_providers/category/{category_id}/{identification}
      summary: Care provider API by category and identification
      x-summary-source: derived
    servers:
    - url: https://api-development.ons.io
  /v0/administration/careproviders/identification/{identification}:
    get:
      tags:
      - CareProvider
      summary: Return the Care Provider corresponding to the given identification
      operationId: CareProviderAPI.byIdentification
      parameters:
      - name: identification
        in: path
        description: identification of care provider (not object ID)
        required: true
        schema:
          type: string
      responses:
        '200':
          description: No response was specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list.CareProviderList'
        '404':
          description: Care provider not found
      x-replacement-for:
      - /t/external_care_providers/identification/{identification}
    servers:
    - url: https://api-development.ons.io
  /v0/administration/careproviders/ura/{ura_number}:
    get:
      tags:
      - CareProvider
      summary: Return the Care Providers corresponding to the given URA number
      operationId: CareProviderAPI.byUraNumber
      parameters:
      - name: ura_number
        in: path
        description: URA number used for selecting CareProviders. Must consist of exactly 8 digits.
        required: true
        schema:
          pattern: ^[0-9]{8}$
          type: string
          example: '12345678'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list.CareProviderList'
        '400':
          description: Invalid URA number. Must consist of exactly 8 digits.
      x-replacement-for:
      - /t/external_care_providers/ura/{ura_number}
    servers:
    - url: https://api-development.ons.io
  /v0/administration/clients/{client_id}/careproviders:
    get:
      tags:
      - CareProvider
      summary: Return the care providers of a Client corresponding to the given id
      operationId: CareProviderAPI.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.CareProviderList'
      x-replacement-for:
      - /t/clients/{client_id}/care_providers
    servers:
    - url: https://api-development.ons.io
components:
  schemas:
    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: '<pre>

            Possible values:

            M - Male

            F - Female

            U - Unknown

            </pre>'
        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.

        identificationNumber and companyName should be filled.

        The identificationNumber should be the AGB-code of the pharmacy.

        All 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
    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
x-refined-from:
- nedap-ons-deprecated-openapi-original.json
- nedap-ons-openapi-original.json