Ocean Health Systems

Ocean Health Systems Templates API

Endpoint for template-related services, including listing and getting templates.

GitHub OpenAPI

Operations 17

GET /templates Lists all or a selection of templates in CKM #
POST /templates Imports a new template into a CKM project. #
GET /templates/{cid-template} Gets the main data of one template #
PUT /templates/{cid-template} Updates the specified template on the trunk. #
DELETE /templates/{cid-template} PERMANENTLY and IRREVOCABLY DELETES the specified template in CKM. #
GET /templates/{cid-template}/embedded-templates Lists the templates embedded in the specified template, if any #
GET /templates/{cid-template}/required-archetypes Lists the archetypes required for (i.e. used by) the specified template #
GET /templates/{cid-template}/oet Gets the specified template in OET format #
GET /templates/{cid-template}/opt Gets the operational template (OPT) for the specified template #
GET /templates/{cid-template}/hash Gets the MD5 hash of the specified template in OET format #
GET /templates/{cid-template}/file-set-url Gets the URL for a file set of the template. #
GET /templates/{cid-template}/status Gets the current status of the template in CKM #
PUT /templates/{cid-template}/status Updates the status of the specified trunk template #
POST /templates/validation-report Gets CKM's template validation report for the template provided as OET. #
GET /templates/{cid-template}/status/{asset-version} Gets the status of the template in CKM for the specified asset version (i.e. #
GET /templates/{cid-template}/project Gets the CKM project of the template #
GET /templates/citeable-identifier/{template-id} Gets the citeable identifier of a template based on the specified template id #

Documentation

📖
Documentation
https://ckm.openehr.org/ckm/rest-doc/
📖
APIReference
https://ckm.openehr.org/ckm/rest-doc/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/ocean-health-systems/refs/heads/main/authentication/ocean-health-systems-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/ocean-health-systems/refs/heads/main/rate-limits/ocean-health-systems-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ocean-health-systems/refs/heads/main/openapi/ocean-health-systems-templates-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/ocean-health-systems/refs/heads/main/conventions/ocean-health-systems-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/ocean-health-systems/refs/heads/main/errors/ocean-health-systems-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/ocean-health-systems/refs/heads/main/data-model/ocean-health-systems-data-model.yml

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/ocean-health-systems-templates-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.

GitHub Google LinkedIn

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

OpenAPI Specification

ocean-health-systems-templates-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: REST API for the Clinical Knowledge Manager.
  version: 1.6.0
  title: CKM REST Templates API
  contact:
    name: CKM Support
    url: https://oceanehr.atlassian.net/servicedesk/customer/portal/15
    email: ckm@oceaninformatics.com
servers:
- url: /ckm/rest/v1
tags:


# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ocean-health-systems/refs/heads/main/openapi/ocean-health-systems-templates-api-openapi.yml