# Ocean Health Systems Templates API

**Canonical:** https://apis.io/apis/ocean-health-systems/ocean-health-systems-templates-api/  
**Provider:** Ocean Health Systems — https://apis.io/providers/ocean-health-systems/  
**Base URL:** https://ckm.openehr.org/ckm/rest/v1  
**Documentation:** https://ckm.openehr.org/ckm/rest-doc/

Ocean Health Systems Templates API is one of 9 APIs that [Ocean Health Systems](https://apis.io/providers/ocean-health-systems/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Templates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

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

## Operations (17)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (8)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/ocean-health-systems/refs/heads/main/openapi/ocean-health-systems-templates-api-openapi.yml
- **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
- **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
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/ocean-health-systems/refs/heads/main/rate-limits/ocean-health-systems-rate-limits.yml

## Other Ocean Health Systems APIs (8)

- [Ocean Health Systems Archetypes API](https://apis.io/apis/ocean-health-systems/ocean-health-systems-archetypes-api/)
- [Ocean Health Systems Change Requests API](https://apis.io/apis/ocean-health-systems/ocean-health-systems-change-requests-api/)
- [Ocean Health Systems Projects API](https://apis.io/apis/ocean-health-systems/ocean-health-systems-projects-api/)
- [Ocean Health Systems Resource Proposals API](https://apis.io/apis/ocean-health-systems/ocean-health-systems-resource-proposals-api/)
- [Ocean Health Systems Resources API](https://apis.io/apis/ocean-health-systems/ocean-health-systems-resources-api/)
- [Ocean Health Systems Sessions API](https://apis.io/apis/ocean-health-systems/ocean-health-systems-sessions-api/)
- [Ocean Health Systems Subdomains API](https://apis.io/apis/ocean-health-systems/ocean-health-systems-subdomains-api/)
- [Ocean Health Systems Users API](https://apis.io/apis/ocean-health-systems/ocean-health-systems-users-api/)

## Tags

Templates

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/ocean-health-systems/ocean-health-systems-templates-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/ocean-health-systems/.