Overview for REST API 1.1.0 work to be done

New endpoints or resources




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


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




Missing (specification) details

All issues

The followings are all Jira issues scheduled for REST API Release 1.1.0: