New endpoints or resources
overall
EHR
Add
/ehr/{ehr_id}/folder
and/ehr/{ehr_id}/versioned_folder
https://openehr.atlassian.net/browse/SPECITS-63missing EHR_ACCESS => yes
Definitions
should we support also archetypes? => no, or at least is low prio, perhaps next version
are we going to support (reading) terminology / value sets? => no, this is the job of terminology service
Demographics
group is ok to do the following, in a separate api page, but it should remain optional, not be required by conformance testing
ACTOR is abstract, so we’ll need concrete types
Sync SM specs
Add
/demographics/person/{version_uid}
and/demographics/versioned_person/{versioned_object_uid}
Add
/demographics/agent/{version_uid}
and/demographics/versioned_agent/{versioned_object_uid}
Add
/demographics/group/{version_uid}
and/demographics/versioned_group/{versioned_object_uid}
Add
/demographics/organisation/{version_uid}
and/demographics/versioned_organisation/{versioned_object_uid}
Add
/demographics/role/{version_uid}
and/demographics/versioned_role/{versioned_object_uid}
Add
/demographics/party_relationship/{uid}
Add also
/demographics/contribution/{contribution_uid}
similar to/ehr/{ehr_id}/contribution/{contribution_uid}
Admin
how should we deal with admin required functionality, e.g. destroy EHR, Compositions, Actors, etc ? Need a specific endpoint /admin or use DELETE action over resources, assuming ACL permits ?
DELETE /admin/ehr/{:ehr_id}
DELETE /admin/ehr/{:ehr_id}/composition/{:composition_id}
see https://ehrbase.readthedocs.io/en/latest/03_development/07_admin/index.html
later (less prio) also merge, unmerge, move content
delete template is problematic, if is “in use”
export (and import), later also extract
/admin/ehr/{ehr_id}/export - need to define what will this dump - zip?
Bugs
Others
Reformat Introduction
Conformance info
Reformat and reorganize https://openehr.atlassian.net/browse/SPECITS-36
Overall Layout
sync with SM, add UV models (relaxed RM) https://openehr.atlassian.net/browse/SPECITS-34
authentication endpoint => (still) no needed
audit service endpoint => not prio, perhpas not part of rest api
(cds) hooks => if Cambio can help with a proposal then it can be included, but we should also look into generalized triggers
Headers
Audit headers with JSON Simplified Format https://openehr.atlassian.net/browse/SPECITS-64
Missing (specification) details
https://openehr.atlassian.net/browse/SPECITS-50 try with prefer=identifiers
https://openehr.atlassian.net/browse/SPECITS-48 discussed on discourse, we should allow it (todo check), no need to do anything on REST level
All issues
The followings are all Jira issues scheduled for REST API Release 1.1.0: