COMPOSITION

Get versioned COMPOSITION version at time

Retrieves a VERSION from the VERSIONED_COMPOSITION identified by versioned_object_uid and associated with the EHR identified by ehr_id.

If version_at_time is supplied, retrieves the VERSION extant at specified time, otherwise retrieves the latest VERSION.

get/ehr/{ehr_id}/versioned_composition/{versioned_object_uid}/version

Path parameters

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

EHR identifier taken from EHR.ehr_id.value.

versioned_object_uidstring uuid required
Example:8849182c-82ad-4088-a07f-48ead4180515

VERSIONED_COMPOSITION identifier taken from VERSIONED_COMPOSITION.uid.value.

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'
Content-Type'application/json' | 'application/xml'

Response

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

_typestring
signaturestring

Example response

{
  "contribution": {
    "id": {
      "_type": "OBJECT_VERSION_ID",
      "value": "fb458d9c-1323-42bc-b7f8-787f3660a0b5::openEHRSys.example.com::1"
    },
    "namespace": "local",
    "type": "COMPOSITION"
  },
  "commit_audit": {
    "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F",
    "committer": {
      "_type": "PARTY_IDENTIFIED",
      "name": "A user name"
    },
    "time_committed": {
      "value": "2017-08-15T10:37:15.422+02:00"
    },
    "change_type": {
      "value": "creation",
      "defining_code": {
        "terminology_id": {
          "value": "openehr"
        },
        "code_string": "249"
      }
    },
    "description": {
      "value": "Description text"
    }
  }
}