0.8.1 - ci-build

MDTIG - Local Development build (v0.8.1). See the Directory of published versions

Api

The Medtronic FHIR API

This is a DRAFT FHIR Implementation Guide. This version is not final yet. DO NOT USE, except for trial and test.

Medtronic follows the FHIR RESTful API.

Most of the API is implemented using FHIR search.

All RESTful uris follow this format:

  • method name, i.e. ‘GET’ or ‘POST’
  • [base] which is a shortened uri where the data is retrieved from
  • resource name, i.e. ‘Observation’
  • parameters, often optional

Reporting API

The Reporting API builds on Observation Panels and single Observations. Most Observations are retrieved using the FHIR search API. This means all results are returned as a FHIR Bundle, which contains the requested resources. This is particularly convenient since most often one does not want just an Observation panel, but also the individual Observations therein.

In some cases we use a FHIR READ operation, which returns just the requested resource without a Bundle. FHIR search is implemented using POST. (Note that parameters for POST can be provided in the query string or Body - the examples below use query string parameters for readability only.)

The following parameters and operations are common:

  • $lastn : Return only the last of several resources. This applies to Observations. For instance, for the Diabetes MVP panel containing the glucose and insulin data over a 2-week period, only the latest is retrieved. Similar, when requesting the average sensor glucose value, only the last one is returned. Currently, the max parameter is not supported and only the single last Observation is returned.
  • patient or subject: Data can be retrieved for a particular Device or a particular Patient. Both are queried using these parameters, where a particular (identified) Patient or Device is the parameter value.
  • date: Retrieve resources starting from some date.
  • _include: Include Observations which are a member of a Panel.
  • _include:iterate: Include Observation panels which consists of panels.
  • _summary: Return just summary data. Default is ‘false’.

Cases where no data is returned (patient not known, no data uploaded etc.) return a Bundle with an OperationOutcome with details about the reason.

Examples

Retrieving a single Observation Panel

Similar to the report, the Diabetes MVP panel is retrieved. The Observations which are a member of this search are included in the Result Bundle.

POST [base]/Observation/$lastn?patient=Patient/example-patient&code=`http://terminology.medtronic.com`|200015&_include:Observation:hasMember