metric

List patient health metrics

Changed on

Get a list of patient health metrics.

get/patient_health_metric

Request

  • Base URL
    https://api.twinehealth.com/pub
  • Auth
    none declared

Query parameters

filter[patient]string

Filter the patient health metrics for a specified patient. Note that one of the following filters must be specified: filter[patient], filter[groups], filter[organization].

filter[groups]string

Comma-separated list of group ids. Note that one of the following filters must be specified: filter[patient], filter[groups], filter[organization].

filter[organization]string

Fitbit Plus organization id. Note that one of the following filters must be specified: filter[patient], filter[groups], filter[organization].

page[number]integer

Page number

page[size]integer

Page size

page[limit]integer

Page limit

page[cursor]string

Page cursor

Response

OK

Example response

{
  "data": [
    {
      "data": {
        "type": "patient_health_metric",
        "attributes": {
          "code": {
            "system": "LOINC",
            "value": "13457-7"
          },
          "type": "ldl_cholesterol",
          "occurred_at": "2017-03-14T11:00:57.000Z",
          "value": 121,
          "unit": "mg/dl"
        },
        "relationships": {
          "patient": {
            "data": {
              "type": "patient",
              "id": ""
            }
          }
        }
      }
    }
  ]
}

Changes

    • info

      added the new optional query request parameter filter[groups]

    • info

      added the new optional query request parameter filter[organization]

    • info

      the query request parameter filter[patient] became optional

    • info

      added the new optional query request parameter page[cursor]

    • info

      added the new optional query request parameter page[limit]