Additions or changes requested
overall
EHR
Add
/ehr/{ehr_id}/folder
and/ehr/{ehr_id}/versioned_folder
- SPECITS-63Getting issue details... STATUSAdd missing EHR_ACCESS
fix EHR summary - not “very” restful => this is a breaking change
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
add alternative /definition/adl2/{archetype_id_matcher} and deprecate /definition/adl2/{template_id}/{version_pattern}
query type => add “formalism” in text
(new endpoint) 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}
(new endpoint) 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
Headers
Audit headers with JSON Simplified Format - SPECITS-64Getting issue details... STATUS
converting location response header to content-location (see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Location ) => breaking change
Missing (specification) details
- SPECITS-50Getting issue details... STATUS try with prefer=identifiers
- SPECITS-48Getting issue details... STATUS discussed on discourse, we should allow it (todo check), no need to do anything on REST level
Others
Reformat Introduction
Conformance info
Reformat and reorganize - SPECITS-36Getting issue details... STATUS
Overall Layout
sync with SM, add UV models (relaxed RM) - SPECITS-34Getting issue details... STATUS
authentication endpoint => (still) no needed
audit service endpoint => not prio, perhaps 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
simplify, consolidate and reuse yaml-blocks whiel building up specs
All issues
The followings are all Jira issues scheduled for REST API Release 1.1.0: