Get folder in directory version at time

Retrieves the version of the directory FOLDER 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 directory FOLDER version.

If path is supplied, retrieves from the directory only the sub-FOLDER that is associated with that path.

Path Parameters

ehr_id
Type: string
required

EHR identifier taken from EHR.ehr_id.value.

Query Parameters

version_at_time
Type: string

A given time in the extended ISO 8601 format.
path
Type: string

A path to a sub-folder; consists of slash-separated values of the name attribute of FOLDERs in the directory.

Responses

application/json
204

204 No Content is returned when the resource identified by the request parameters (at specified version_at_time) time has been deleted.
404

404 Not Found is returned when an EHR with ehr_id does not exist, or when a directory does not exist at the specified version_at_time, or when path does not exists within the directory.

get/ehr/{ehr_id}/directory

curl https://cataniamc.prod.cadasto.com/openehr/v1/ehr/7d44b88c-4199-4bad-97dc-d78268e01398/directory

Show Schema

{
  "archetype_node_id": "openEHR-EHR-FOLDER.directory.v1",
  "name": {
    "value": "Directory"
  },
  "uid": {
    "_type": "OBJECT_VERSION_ID",
    "value": "8849182c-82ad-4088-a07f-48ead4180515::cataniamc.prod.cadasto.com::1"
  },
  "items": [],
  "folders": []
}

200 OK is returned when the FOLDER is successfully retrieved.