Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

overall

  • Jira Legacy
    serverSystem JIRAJira
    serverId7788407e-95fd-3d19-96c6-946a2bd486dc
    keySPECITS-58

    • it supporting flat and json/xml, controlling with Accept header

    • /definition/adl1.4/{templateId}/example[?type={filterType}&detailLevel={detailLevel}]

      • filterType = input|output

    • it contains a larger set of data, but not necessary the largest, given values for some optional fields

      • detailLevel = min|medium|max

    • can be used for validation and developments

  • Jira Legacy
    serverSystem JIRAJira
    serverId7788407e-95fd-3d19-96c6-946a2bd486dc
    keySPECITS-35

  • serializing errors:

EHR

  • Add /ehr/{ehr_id}/folder and /ehr/{ehr_id}/versioned_folder

    Jira Legacy
    serverSystem JIRAJira
    serverId7788407e-95fd-3d19-96c6-946a2bd486dc
    keySPECITS-63

  • Add missing EHR_ACCESS ?

    • similar to EHR_STATUS

    • we will mention in specs that this resource is created automatically by the system when the EHR is created, and is not possible to add it in the payload of EHR creation (like we do for EHR_STATUS)

  • fix EHR summary - not “very” restful => this is a breaking change

Definitions

  • Jira Legacy
    serverSystem JIRAJira
    serverId7788407e-95fd-3d19-96c6-946a2bd486dc
    keySPECITS-43
    => admin?

  • 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} - potentially breaking change

  • query type => add “formalism” in text

...

see also Pablo’s proposal

Jira Legacy
serverSystem JIRAJira
serverId7788407e-95fd-3d19-96c6-946a2bd486dc
keySPECPR-406
and
Jira Legacy
serverSystem JIRAJira
serverId7788407e-95fd-3d19-96c6-946a2bd486dc
keySPECITS-70

...

  • 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” - but on the other hand this is an admin endpoint, so it should be fine

  • export (and import), later also (partial) extract/ import

    • /admin/ehr/{ehr_id}/export - exports

    • /admin/ehr/import

    • configure the export/import task scope with a payload (e.g. all-ehrs, subset of ehrs based on their ehrIds, “some compositions”)

    • background tasks - consider polling

    • need to define what will be the format for this dump - zip? (Seref:) sqlite? (Severin:) csv or json?

      • we will need

      something for ehr_extract ?
  • merging EHRs

      • to define schema for this export format

      • Ian: see Josh Mandel on dumping ehr-data

      • do we need something like ehr_extract ?

      • self-contained package, including templates, archetypes; maintaining cross references, versioning, contribution

      • import should work on existing populated CDR

        • what if template or other data already exists?

        • Alex: consider keycloak import/export strategies

      • consider flag to anonymize data upon export

    • can be used for data migration from one CDR to another, or another version

    • Ian: https://msc-ehi-export.medsphere.com/

  • merging EHRs

    • parameters: source ehr-id and target ehr-id

    • Sebastian: it will move data from old ehr to new ehr

    • Sebastian: might be possible to use ehr_status to indicate that source ehr was merged, perhaps use folders or tags to mark the merged content

    • Alex: use ehr_status other_details or feeder_audit to indicate merging information

    • see also https://discourse.openehr.org/t/linking-and-merging-ehr-ids/1192/14

    • Erik: I wonder if merge is a variant action of moving data

    • better has also unmerge and move operations

    • how to deal with merge-conflicts ? imagine merging persisting compositions, episodes, demographic data, duplicates tags, etc

  • archiving/shredding Person/EHR (partial, cohort)

  • system?

Bugs

  • Jira Legacy
    serverSystem JIRAJira
    serverId7788407e-95fd-3d19-96c6-946a2bd486dc
    keySPECITS-60

  • Jira Legacy
    serverSystem JIRAJira
    serverId7788407e-95fd-3d19-96c6-946a2bd486dc
    keySPECITS-46
    - might be a breaking change

  • Jira Legacy
    serverSystem JIRAJira
    serverId7788407e-95fd-3d19-96c6-946a2bd486dc
    keySPECITS-44
    but also to other places

  • Jira Legacy
    serverSystem JIRAJira
    serverId7788407e-95fd-3d19-96c6-946a2bd486dc
    keySPECITS-68

...

  • Audit headers with JSON Simplified Format

    Jira Legacy
    serverSystem JIRAJira
    serverId7788407e-95fd-3d19-96c6-946a2bd486dc
    keySPECITS-64

  • converting location response header to content-location (see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Location ) => breaking change

    • Pablo: an idea to backport functionality from v2 to v1 but do it with right headers, we should actually deprecate the “wrong” headers and already add the new-future headers

Missing (specification) details

  • Jira Legacy
    serverSystem JIRAJira
    serverId7788407e-95fd-3d19-96c6-946a2bd486dc
    keySPECITS-62

  • Jira Legacy
    serverSystem JIRAJira
    serverId7788407e-95fd-3d19-96c6-946a2bd486dc
    keySPECITS-61

  • Jira Legacy
    serverSystem JIRAJira
    serverId7788407e-95fd-3d19-96c6-946a2bd486dc
    keySPECITS-50
    try with prefer=identifiers

  • Jira Legacy
    serverSystem JIRAJira
    serverId7788407e-95fd-3d19-96c6-946a2bd486dc
    keySPECITS-48
    discussed on discourse, we should allow it (todo check), no need to do anything on REST level

...

  • Reformat Introduction

  • Conformance info

  • IANA

    Jira Legacy
    serverSystem JIRAJira
    serverId7788407e-95fd-3d19-96c6-946a2bd486dc
    keySPECITS-39

  • Reformat and reorganize

    Jira Legacy
    serverSystem JIRAJira
    serverId7788407e-95fd-3d19-96c6-946a2bd486dc
    keySPECITS-36

  • Overall Layout

  • sync with SM, add UV models (relaxed RM)

    Jira Legacy
    serverSystem JIRAJira
    serverId7788407e-95fd-3d19-96c6-946a2bd486dc
    keySPECITS-34

  • 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 while building up specs

...