plan

List patient plan summaries

Changed on

Get a list of patient plan summaries

get/patient_plan_summary

Request

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

Query parameters

filter[patient]string

Patient id to fetch plan summary for. 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].

include'actions' | 'bundles' | 'patient' | 'current_results'

List of related resources to include in the response

Response

OK

Example response

{
  "data": [
    {
      "id": "57b36e3c04ad8c2224f2af38",
      "type": "patient_plan_summary",
      "links": {
        "self": "/patient_plan_summary/57b36e3c04ad8c2224f2af38"
      }
    }
  ]
}

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