DIRECTORY

Get folder in directory version

Changed on

Retrieves a particular version of the directory FOLDER identified by version_uid and associated with the EHR identified by ehr_id.

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

get/ehr/{ehr_id}/directory/{version_uid}

Request

  • Base URL
    https://openEHRSys.example.com/v1
  • Auth
    none required

Path parameters

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

EHR identifier taken from EHR.ehr_id.value.

version_uidstring required
Example:6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::2

VERSION identifier taken from VERSION.uid.value.

Query parameters

pathstring
Example:episodes/a/b/c

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

Headers

Accept'application/json' | 'application/xml' | 'application/openehr.wt.flat+json' | 'application/openehr.wt.structured+json'

Response

200 OK is returned when the FOLDER is successfully retrieved.

_typestring

Changes

    • info

      added SECTION discriminator mapping keys to the / response property for the response status

    • info

      added SECTION discriminator 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

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the new optional header request parameter Accept