Sign in

v41

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

Create COMPOSITION

Creates the first version of a new COMPOSITION in the EHR identified by ehr_id.

A list of ITEM_TAGs can be associated with the 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.

post/ehr/{ehr_id}/composition

Path parameters

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

EHR identifier taken from EHR.ehr_id.value.

Headers

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

201 Created is returned when the COMPOSITION is successfully created. If Prefer header is return=representation, the full resource is included in the response body; if is return=identifier, only its unique identifier is included. If the Prefer header is missing or set to return=minimal, the body is empty.

OR

Example response

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