2025-09-10 Call Notes REST API

Tags

@Sebastian Iancu

todo: reviewing

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

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

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

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

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

• also https://github.com/openEHR/specifications-ITS-REST/pull/118 added to SPECITS-77

notes:

• SPECITS-50

  • make return=identifier default, deprecate default as return=minimal- need ask feedback from EHRbase also

    • for now default remain as it was = minimal

    • mention that a configurable flag may exists on the CDR side - but this flag is not a hard requirement

    • add note that in future version this default will be changed from minimal to identifier; recommend client application to ask explicit preferred header so that they are align with upcoming changes (forward compatibility)

  • done: use singular “unique identifier” not “identifiers”

• SPECITS-74

  • question if we should deprecate the Location header also from Update and Delete

    • what do we get when as response on a GET on the version that is deleted?

    • remove it (deprecated) from delete

    • done: removed from DELETE

Template Id impact on REST API

@Former user (Deleted) @Sebastian Iancu @Severin Kohler

• not discussed, see previous meeting

flat format headers

get opt definition

• application/xml => OPT in XML

• application/json => OPT in json

• application/openehr.wt+json => WebTemplate in json

get example endpoint (under definition)

• application/xml canonical XML

• application/openehr.wt.flat+json flat json

• application/openehr.wt.structured+json flat json

get composition, folder, ehr_satus, etc instances

• application/xml canonical XML

• application/json canonical JSON

• application/openehr.wt.flat+json flat json

• application/openehr.wt.structured+json flat json

deprecate older formats

• application/openehr.wt.flat.schema+json

• application/openehr.wt.structured.schema+json

TBD links https://github.com/better-care/web-template

https://docs.ehrbase.org/docs/category/simplified-data-template-sdt