Sign in

v41

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

Update COMPOSITION

Updates COMPOSITION identified by uid_based_id and associated with the EHR identified by ehr_id.

The uid_based_id can take only a form of an HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a versioned_object_uid).

If the request body already contains a COMPOSITION.uid.value, it must match the uid_based_id in the URL.

The existing latest version_uid of COMPOSITION resource (i.e. the preceding_version_uid) must be specified in the If-Match header.

A list of ITEM_TAGs can be associated with the updated COMPOSITION, in which case a openehr-item-tag or openehr-version-item-tag request header can be set as well. The corresponding response header(s) will return ITEM_TAGs as they were set by the server - see item tags headers for more details.

put/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 uuid required
Example:8849182c-82ad-4088-a07f-48ead4180515

An identifier in a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a versioned_object_uid).

Headers

If-Matchstring required
Example:"6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::1"

Header to make the request conditional. Together with ETag request tag, it helps to prevent simultaneous updates of a resource from overwriting each other ("mid-air collisions"). The format is always an version_uid identifier enclosed by double quotes. The operation will be performed only if the existing latest version_uid of the resource (i.e. the preceding_version_uid) matches this header's value.

Prefer'return=representation' | 'return=minimal' | 'return=identifier'

Request header to indicate the preference over response details. The response will contain the entire resource when the Prefer header has a value of return=representation, or only the resource identifier (e.g., the uid) when the value is return=identifier.

Accept'application/json' | 'application/xml' | 'application/openehr.wt.flat+json' | 'application/openehr.wt.structured+json'
Content-Type'application/json' | 'application/xml' | 'application/openehr.wt.flat+json' | 'application/openehr.wt.structured+json'
keystring required

Tag key (identifier)

valuestring

Tag value

target_pathstring

An AQL path withing the target used to tag a fine-grained element

The list of all ITEM_TAG to be set and associated with the current VERSIONED_OBJECT - see details.

[
  {
    "key": "flag",
    "value": "follow-up",
    "target_path": "/context/start_time/value"
  }
]
keystring required

Tag key (identifier)

valuestring

Tag value

target_pathstring

An AQL path withing the target used to tag a fine-grained element

The list of all ITEM_TAG to be set and associated with the current VERSION - see details.

[
  {
    "key": "flag",
    "value": "follow-up",
    "target_path": "/context/start_time/value"
  }
]

Request body

_typestring

Response

200 OK is returned when the COMPOSITION is successfully updated, with the full resource in the response body when Prefer header is return=representation, or only its identifiers when Prefer header is return=identifier.

OR

Example response

{
  "uid": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}