API discoverability
DI001: API specifications SHOULD be published in the Dutch API library for healthcare
Applicable roles | API specifier |
Standardization levels | OA, TSA, FSA |
Status | Final |
Since version | 1.0.0 |
Sub-requirements
- DI001.001: The API specifier MUST specify the status of each version of its API specification published in the Dutch API library for healthcare
- DI001.002: The API specifier MUST provide (a link to) all specification, documentation and qualification documents available for each version of its API specification published in the Dutch API library for healthcare
- DI001.003: API specifications that are published in the Dutch API library for healthcare MUST at least comply with all requirements for Open APIs (Open API standardization level) that apply to the API specifier role
DI002: API implementations SHOULD be published in the Dutch API library for healthcare
Applicable roles | API server developer |
Standardization levels | OA, TSA, FSA |
Status | Final |
Since version | 1.0.0 |
Sub-requirements
- DI002.001: The API server developer MUST specify the status of each version of its API implementation published in the Dutch API library for healthcare
- DI002.002: The API server developer MUST provide the name and version of the system that contains the API implementation for each version of its API implementation published in the Dutch API library for healthcare
- DI002.003: API implementations that are published in the Dutch API library for healthcare MUST refer to (one or more versions of) an API specification that is published in the Dutch API library for healthcare
- DI002.004: API implementations that are published in the Dutch API library for healthcare MUST at least comply with all requirements for Open APIs (Open API standardization level) that apply to the API server developer role
DI003: API deployments SHOULD be published in the Dutch API library for healthcare
Applicable roles | API server deployer |
Standardization levels | OA, TSA, FSA |
Status | Final |
Since version | 1.0.0 |
Sub-requirements
- DI003.001: The API server deployer MUST specify the status of each version of its API deployment published in the Dutch API library for healthcare
- DI003.002: The API server deployer MUST provide (a link to) all information considering agreements and conditions for using the API, onboarding and testing procedures and endpoint information for each version of its API deployment published in the Dutch API library for
- DI003.003: API deployments that are published in the Dutch API library for healthcare MUST refer to an API implementation that is published in the Dutch API library for healthcare
- DI003.004: API deployments that are published in the Dutch API library for healthcare MUST at least comply with all requirements for Open APIs (Open API standardization level) that apply to the API server deployer role