Skip to main content Link Menu Expand (external link) Copy Copied
Ons API

Hierarchy of connectors

In this article, we explain the hierarchy that links possess and what this implies.

Definitions:

  • Supplier
    The external supplier/external party that designs and manages links. An external party becomes a supplier if accepted during intake. The supplier has access to the Ons API Dashboard from which they manage connectors and versions.
  • Connector
    The link; the ‘product’ that the supplier delivers as a service to a healthcare organisation.
  • Version
    The version of a connector.

Hierarchy

The hierarchy we know is as follows:

  • Supplier
    • Connector
      • Version

Each version is subordinate to one connector, and each connector to one supplier. A supplier can have multiple connectors, and a connector can have multiple versions. For example:

  • Supplier A
    • Connector X
      • 0.1.0
      • 1.0.0
      • 2.0.0
    • Connector Y
      • 0.1.0
      • 0.2.0

Versioning denotation

Numbering
WWe do not mandate a convention for version notation, but recommend the Semantic Versioning convention: major.minor.patch. Example:

  • 0.0.1
  • 0.0.2
  • 0.1.0
  • 2.0.0

Description
It is possible to fill in a version description in the Ons API Dashboard. The version description can be changed at a later time, but not the version number.

Versions and Development Stages

Every version is always in one of two possible stages: editable or uneditable.

Editable: In this phase, the version is still in the design phase. Changes to the functional and technical design of the version are still possible.

Uneditable: Once the version has been finalized, it is considered definitive. From this moment on, the version can be linked to the test and production environments of healthcare organizations. Changes are no longer allowed from that point onward.

  • Supplier A
    • Connector X
      • 1.0.0 ⟶ uneditable
      • 1.0.1 ⟶ uneditable
      • 2.0.0 ⟶ editable

Use the Create editable copy of this version button to easily add a missing model or field.

All specifications that are tested and on which healthcare organisations grant consent (certificates) are at the version level. Therefore, a healthcare organisation cannot actually give consent to enable a connector but only for a version of a connector. Nedap also approves not a connector but only a version of a connector.

When to Create a New Version and When a New Connector?

When do you choose to create a new version, and when a new connector? This is a bit of a gray area, but as a guideline, it is good to relate the product that a supplier delivers to a healthcare organisation to a connector and a specification thereof as a version. For example:

  • Care 2 Media Concepts B.V. (supplier)
    • NedapOns-Youtube-integration (connector)
      • 0.9.0 (version for pilot customers)
      • 1.0.0 (first released version)
      • 1.1.0 (version with subtitle support)
      • 1.1.1 (version with working subtitles)
    • NedapOns-Instagram-integration (connector)
      • 0.9.0 (version for pilot customers)
      • 1.0.0 (first released version)
      • 1.1.0 (version with subtitle support)
      • 1.1.1 (version with working subtitles)

Updating a Connector Version for a Healthcare Organization

If you want to change the version of a connection for an already connected healthcare organization, the organization must grant permission again. Once that permission is given, the certificates linked to the old version will automatically be transferred to the new version.