# openEHR EHR STATUS API

**Canonical:** https://apis.io/apis/openehr/openehr-ehr-status-api/  
**Provider:** openEHR — https://apis.io/providers/openehr/  
**Documentation:** https://specifications.openehr.org/releases/ITS-REST/latest/ehr.html

openEHR EHR STATUS API is one of 16 APIs that [openEHR](https://apis.io/providers/openehr/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 2 JSON Schema definitions. Tagged areas include EHR_STATUS. The published artifact set on APIs.io includes an OpenAPI specification and 2 JSON Schemas.

Management of [EHR_STATUS](https://specifications.openehr.org/releases/RM/latest/ehr.html#_ehr_status_class) and [VERSIONED_EHR_STATUS](https://specifications.openehr.org/releases/RM/latest/ehr.html#_versioned_ehr_status_class) resources. Operations include retrieval by time or version, update, and inspection of revision history for the versioned status of an EHR.

## Operations (7)

| Method | Path | Summary |
|---|---|---|
| GET | `/ehr/{ehr_id}/ehr_status/{version_uid}` | Get EHR_STATUS by version id |
| GET | `/ehr/{ehr_id}/ehr_status` | Get EHR_STATUS at time |
| PUT | `/ehr/{ehr_id}/ehr_status` | Update EHR_STATUS |
| GET | `/ehr/{ehr_id}/versioned_ehr_status` | Get versioned EHR_STATUS |
| GET | `/ehr/{ehr_id}/versioned_ehr_status/revision_history` | Get versioned EHR_STATUS revision history |
| GET | `/ehr/{ehr_id}/versioned_ehr_status/version` | Get versioned EHR_STATUS version at time |
| GET | `/ehr/{ehr_id}/versioned_ehr_status/version/{version_uid}` | Get versioned EHR_STATUS version by id |

## Machine-readable artifacts (15)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/openehr/refs/heads/main/openapi/openehr-ehr-status-api-openapi.yml
- **Specification** — https://specifications.openehr.org/releases/ITS-REST/latest/ehr.html
- **SourceCode** — https://github.com/openEHR/specifications-ITS-REST/blob/master/computable/OAS/ehr-validation.openapi.yaml
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/openehr/refs/heads/main/json-schema/openehr-rm-1.1.0-all.json
- **JSONSchema** — https://specifications.openehr.org/releases/ITS-JSON/latest/components/openehr_rm_1.1.0_all.json
- **Specification** — https://specifications.openehr.org/releases/ITS-REST/latest/query.html
- **SourceCode** — https://github.com/openEHR/specifications-ITS-REST/blob/master/computable/OAS/query-validation.openapi.yaml
- **Specification** — https://specifications.openehr.org/releases/ITS-REST/latest/definition.html
- **SourceCode** — https://github.com/openEHR/specifications-ITS-REST/blob/master/computable/OAS/definition-validation.openapi.yaml
- **Specification** — https://specifications.openehr.org/releases/ITS-REST/latest/overview.html
- **SourceCode** — https://github.com/openEHR/specifications-ITS-REST/blob/master/computable/OAS/system-validation.openapi.yaml
- **Specification** — https://specifications.openehr.org/releases/ITS-REST/latest/demographic.html
- **SourceCode** — https://github.com/openEHR/specifications-ITS-REST/blob/master/computable/OAS/demographic-validation.openapi.yaml
- **Specification** — https://specifications.openehr.org/releases/ITS-REST/latest/admin.html
- **SourceCode** — https://github.com/openEHR/specifications-ITS-REST/blob/master/computable/OAS/admin-validation.openapi.yaml

## Other openEHR APIs (12)

- [openEHR ADL1.4 API](https://apis.io/apis/openehr/openehr-adl1-4-api/)
- [openEHR ADL2 API](https://apis.io/apis/openehr/openehr-adl2-api/)
- [openEHR AGENT API](https://apis.io/apis/openehr/openehr-agent-api/)
- [openEHR COMPOSITION API](https://apis.io/apis/openehr/openehr-composition-api/)
- [openEHR CONTRIBUTION API](https://apis.io/apis/openehr/openehr-contribution-api/)
- [openEHR DIRECTORY API](https://apis.io/apis/openehr/openehr-directory-api/)
- [openEHR EHR API](https://apis.io/apis/openehr/openehr-ehr-api/)
- [openEHR GROUP API](https://apis.io/apis/openehr/openehr-group-api/)
- [openEHR ITEM TAG API](https://apis.io/apis/openehr/openehr-item-tag-api/)
- [openEHR Options API](https://apis.io/apis/openehr/openehr-options-api/)
- [openEHR ORGANISATION API](https://apis.io/apis/openehr/openehr-organisation-api/)
- [openEHR PERSON API](https://apis.io/apis/openehr/openehr-person-api/)

## Tags

EHR_STATUS

---

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