Overview for REST API 1.1.0 work to be done

New endpoints or resources

overall

• https://openehr.atlassian.net/browse/SPECITS-58

• https://openehr.atlassian.net/browse/SPECITS-35

  • add text (generic) that all GET support also HEAD

EHR

• Add /ehr/{ehr_id}/folder and /ehr/{ehr_id}/versioned_folder https://openehr.atlassian.net/browse/SPECITS-63

• missing EHR_ACCESS => yes

• fix EHR summary

Definitions

• https://openehr.atlassian.net/browse/SPECITS-43

• 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

• add alternative /definition/adl2/{archetype_id_matcher} and deprecate /definition/adl2/{template_id}/{version_pattern}

• query type => add “formalism” in text

Demographics / Registry

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 /registry/person/{version_uid} and /registry/versioned_person/{versioned_object_uid}

• Add /registry/agent/{version_uid} and /registry/versioned_agent/{versioned_object_uid}

• Add /registry/group/{version_uid} and /registry/versioned_group/{versioned_object_uid}

• Add /registry/organisation/{version_uid} and /registry/versioned_organisation/{versioned_object_uid}

• Add /registry/role/{version_uid} and /registry/versioned_role/{versioned_object_uid}

• Add /registry/party_relationship/{uid}

• Add also /registry/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

• https://openehr.atlassian.net/browse/SPECITS-60

• https://openehr.atlassian.net/browse/SPECITS-46

• https://openehr.atlassian.net/browse/SPECITS-44

Others

• Reformat Introduction

• Conformance info

• IANA https://openehr.atlassian.net/browse/SPECITS-39

• 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-62

• https://openehr.atlassian.net/browse/SPECITS-61

• 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: