search

openEHR / specifications-ITS-REST

openEHR REST API Specifications
https://specifications.openehr.org/releases/ITS-REST/latest
Apache License 2.0
18 stars 15 forks source link

Clarify RM types for returned data when creating an EHR #64

Closed serefarikan closed 6 years ago

serefarikan commented 6 years ago

The POST request for creating a new EHR is documented to return a data structure that consists of objects and string fields. However, it is not clear what these objects should look like in terms of RM types.

Please specify expected structures in regards to RM.

bjornna commented 6 years ago

Will the following changes be sufficient?

  1. Define that the returned object is of class:EHR

  2. Change the (json) definition of the EHR_STATUS to match the reference mode: 1..1 | ehr_status: OBJECT_REF | Reference to EHR_STATUS object for this EHR.

serefarikan commented 6 years ago

@bjornna I think referring to EHR type and removing the incorrect

"versioned ehr status uid"

bit would be sufficient. It would be clear enough to refer to EHR type and provide

"ehr_status": {..} like the other fields. Please see my comment in #63 also re mandatory fields.