Update COMPOSITION
Changed onUpdates 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.
Request
- Base URLhttps://openEHRSys.example.com/v1
- Authnone required
Path parameters
EHR identifier taken from EHR.ehr_id.value.
An identifier in a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a versioned_object_uid).
Headers
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.
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.
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"
}
]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
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.
Example response
{
"uid": "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2"
}Changes
- breaking
added the new required request property
/////// - breaking
added the new required request property
/////// - breaking
added the new required request property
//////// - breaking
added the new required request property
//////// - breaking
added the new required request property
//// - breaking
added the new required request property
/////// - breaking
added the new required request property
/////// - breaking
added the new required request property
//// - breaking
the
request property's minItems was increased to1 - breaking
the response property
/became optional for the status - breaking
the response property
/became optional for the status - warning
changed the pattern of the request property
///////////////from/^[><=?]$/to^[><=?]$ - warning
changed the pattern of the request property
/////////////from/^[><=?]$/to^[><=?]$ - warning
changed the pattern of the request property
///////////////from/^[><=?]$/to^[><=?]$ - warning
changed the pattern of the request property
/////////////from/^[><=?]$/to^[><=?]$ - warning
changed the pattern of the request property
///////from/^[><=?]$/to^[><=?]$ - warning
changed the pattern of the request property
///////from/^[><=?]$/to^[><=?]$ - warning
changed the pattern of the request property
/////from/^[><=?]$/to^[><=?]$ - warning
changed the pattern of the request property
////////////////from/^[><=?]$/to^[><=?]$ - warning
changed the pattern of the request property
//////////////from/^[><=?]$/to^[><=?]$ - warning
changed the pattern of the request property
////////////////from/^[><=?]$/to^[><=?]$ - warning
changed the pattern of the request property
//////////////from/^[><=?]$/to^[><=?]$ - warning
changed the pattern of the request property
////////from/^[><=?]$/to^[><=?]$ - warning
changed the pattern of the request property
////////from/^[><=?]$/to^[><=?]$ - warning
changed the pattern of the request property
//////from/^[><=?]$/to^[><=?]$ - warning
changed the pattern of the request property
////////////from/^[><=?]$/to^[><=?]$ - warning
changed the pattern of the request property
//////////from/^[><=?]$/to^[><=?]$ - warning
changed the pattern of the request property
//////from/^[><=?]$/to^[><=?]$ - warning
changed the pattern of the request property
///////////////from/^[><=?]$/to^[><=?]$ - warning
changed the pattern of the request property
/////////////from/^[><=?]$/to^[><=?]$ - warning
changed the pattern of the request property
///////////////from/^[><=?]$/to^[><=?]$ - warning
changed the pattern of the request property
/////////////from/^[><=?]$/to^[><=?]$ - warning
changed the pattern of the request property
////////////from/^[><=?]$/to^[><=?]$ - warning
changed the pattern of the request property
//////////from/^[><=?]$/to^[><=?]$ - info
the request property
became optional - info
the request property
became optional - info
added
SECTIONdiscriminator mapping keys to the/request property - info
added
SECTIONdiscriminator mapping keys to the//request property - info
added
SECTIONdiscriminator mapping keys to the/request property - info
added
SECTIONdiscriminator mapping keys to the//request property - info
added
SECTIONdiscriminator mapping keys to the///request property - info
added
SECTIONdiscriminator mapping keys to the/request property - info
added
SECTIONdiscriminator mapping keys to the//response property for the response status - info
added
SECTIONdiscriminator mapping keys to the///response property for the response status - info
added
SECTIONdiscriminator mapping keys to the//response property for the response status - info
added
SECTIONdiscriminator mapping keys to the///response property for the response status - info
added
SECTIONdiscriminator mapping keys to the////response property for the response status - info
added
SECTIONdiscriminator mapping keys to the//response property for the response status - info
the
////////////////response's property pattern was changed from/^[><=?]$/to^[><=?]$for the status - info
the
//////////////response's property pattern was changed from/^[><=?]$/to^[><=?]$for the status - info
the
////////////////response's property pattern was changed from/^[><=?]$/to^[><=?]$for the status - info
the
//////////////response's property pattern was changed from/^[><=?]$/to^[><=?]$for the status - info
the
////////response's property pattern was changed from/^[><=?]$/to^[><=?]$for the status - info
the
////////response's property pattern was changed from/^[><=?]$/to^[><=?]$for the status - info
the
//////response's property pattern was changed from/^[><=?]$/to^[><=?]$for the status - info
the
/////////////////response's property pattern was changed from/^[><=?]$/to^[><=?]$for the status - info
the
///////////////response's property pattern was changed from/^[><=?]$/to^[><=?]$for the status - info
the
/////////////////response's property pattern was changed from/^[><=?]$/to^[><=?]$for the status - info
the
///////////////response's property pattern was changed from/^[><=?]$/to^[><=?]$for the status - info
the
/////////response's property pattern was changed from/^[><=?]$/to^[><=?]$for the status - info
the
/////////response's property pattern was changed from/^[><=?]$/to^[><=?]$for the status - info
the
///////response's property pattern was changed from/^[><=?]$/to^[><=?]$for the status - info
the
/////////////response's property pattern was changed from/^[><=?]$/to^[><=?]$for the status - info
the
///////////response's property pattern was changed from/^[><=?]$/to^[><=?]$for the status - info
the
///////response's property pattern was changed from/^[><=?]$/to^[><=?]$for the status - info
the
////////////////response's property pattern was changed from/^[><=?]$/to^[><=?]$for the status - info
the
//////////////response's property pattern was changed from/^[><=?]$/to^[><=?]$for the status - info
the
////////////////response's property pattern was changed from/^[><=?]$/to^[><=?]$for the status - info
the
//////////////response's property pattern was changed from/^[><=?]$/to^[><=?]$for the status - info
the
/////////////response's property pattern was changed from/^[><=?]$/to^[><=?]$for the status - info
the
///////////response's property pattern was changed from/^[><=?]$/to^[><=?]$for the status - info
added the required property
////////to the response with the status - info
added the required property
////////to the response with the status - info
added the required property
/////////to the response with the status - info
added the required property
/////////to the response with the status - info
added the required property
/////to the response with the status - info
added the required property
////////to the response with the status - info
added the required property
////////to the response with the status - info
added the required property
/////to the response with the status
- breaking
- info
added the new optional
headerrequest parameterAccept - info
added the new optional
headerrequest parameterContent-Type
- info