2016-06-23 REST API Meeting notes

JSON format

• use @type = "DV_TEXT"

• for parametrised: @type = DV_INTERVAL<DV_QUANTITY>

  • Please note that changes have been suggested after the meeting, see https://github.com/openEHR/specifications-ITS/issues/15 and comment thread in AQL Result Set work area

• Attribute names are lowercase RM names - snakecase

• Any other meta-data attribute should start with a '@'

Datetime format

Recommendation: Canonical ISO8601 expanded format, i.e. 2016-06-23T13:42:16.117+02:00

But we accept any ISO8601. It should also preserve what was sent (i.e. if composition was saved as narrow format we should also return it that way)

Status codes

content application/json?

@Thomas Beale - I'm on the main FHIR list - they just decided to change everything in FHIR to application/fhir+json and application/fhir+xml (it used to be application/xml+fhir). I would imagine we should do the same - application/openehr+xml and application/openehr+json.

REST API calls for management of templates

We define calls for template management with proper authentication and authorisation.

Some vendors are likely not going to allow modifying templates in production environments.

Can we define a conformance REST call

It'll return back the set of ops supported, level of the API implemented, etc. TBD once we defined resources, calls, ops