Sign in

v41

latestOpenAPI 3.0.3Creative Commons Attribution-NoDerivs 3.0 Unportedraw.githubusercontent.com2026-06-1133105142.4 KB
COMPOSITION

Get COMPOSITION

Retrieves a version of the COMPOSITION identified by uid_based_id and associated with the EHR identified by ehr_id.

The uid_based_id can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a version_uid), or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a versioned_object_uid). The former is used to retrieve a specific known version of the COMPOSITION (e.g. one identified by 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1), whereas the latter (e.g. an identifier like 8849182c-82ad-4088-a07f-48ead4180515) is be used to retrieve a version from the version container whenever the version_tree_id is unknown or irrelevant (such as when most recent version is requested).

When the uid_based_id has the form of a HIER_OBJECT_ID, if the version_at_time is supplied, retrieves the version extant at specified time, otherwise retrieves the latest COMPOSITION version.

See Resource identification for more details about the identifiers usage and meaning.

When there are ITEM_TAGs associated with the retrieved COMPOSITION, they will be returned as openehr-item-tag and openehr-version-item-tag response headers, respectively - see item tags headers for more details.

get/ehr/{ehr_id}/composition/{uid_based_id}

Path parameters

ehr_idstring uuid required
Example:7d44b88c-4199-4bad-97dc-d78268e01398

EHR identifier taken from EHR.ehr_id.value.

uid_based_idstring required
Example:8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1

An abstract identifier: it can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a version_uid), or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a versioned_object_uid).

Query parameters

version_at_timestring datetime
Example:2015-01-20T19:30:22.765+01:00

A given time in the extended ISO 8601 format.

Headers

Accept'application/json' | 'application/xml' | 'application/openehr.wt.flat+json' | 'application/openehr.wt.structured+json'

Response

200 OK is returned when the requested COMPOSITION is successfully retrieved.

_typestring