# Ocean Health Systems Archetypes API

**Canonical:** https://apis.io/apis/ocean-health-systems/ocean-health-systems-archetypes-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 Archetypes 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 Archetypes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

Endpoint for archetype-related services, including listing and getting archetypes.

## Operations (14)

| Method | Path | Summary |
|---|---|---|
| GET | `/archetypes/{cid-archetype}/hash` | Gets the (non-canonical) MD5 hash of the specified archetype in ADL format |
| GET | `/archetypes/{cid-archetype}/parent` | Gets main data about the specified archetype's parent archetype, if any |
| GET | `/archetypes/citeable-identifier/{archetype-id}` | Gets the citeable identifier of an archetype based on the specified archetype id |
| GET | `/archetypes/{cid-archetype}/status` | Gets the current status of the archetype in CKM |
| GET | `/archetypes/{cid-archetype}/status/{asset-version}` | Gets the status of the archetype in CKM for the specified asset version (i.e. |
| GET | `/archetypes/{cid-archetype}/project` | Gets the CKM project of the archetype |
| GET | `/archetypes` | Lists a selection of archetypes in CKM |
| POST | `/archetypes` | Imports a new archetype into a CKM project. |
| GET | `/archetypes/{cid-archetype}` | Gets the main data of one archetype |
| PUT | `/archetypes/{cid-archetype}` | Updates the stated archetype on the trunk. |
| DELETE | `/archetypes/{cid-archetype}` | PERMANENTLY and IRREVOCABLY DELETES the specified archetype in CKM. |
| GET | `/archetypes/{cid-archetype}/adl` | Gets the specified archetype in ADL format |
| GET | `/archetypes/{cid-archetype}/xml` | Gets the specified archetype in XML format |
| GET | `/archetypes/{cid-archetype}/mindmap` | Get archetype mindmap |

## Machine-readable artifacts (9)

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

## Other Ocean Health Systems APIs (8)

- [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 Templates API](https://apis.io/apis/ocean-health-systems/ocean-health-systems-templates-api/)
- [Ocean Health Systems Users API](https://apis.io/apis/ocean-health-systems/ocean-health-systems-users-api/)

## Tags

Archetypes

---

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