plan

Get the plan summary for a patient

Get the plan summary for a patient.

get/patient_plan_summary/{id}

Request

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

Path parameters

idstring required

Plan summary identifier

Query parameters

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

List of related resources to include in the response

Response

OK

Example response

{
  "data": {
    "type": "patient_plan_summary",
    "id": "5964f831f65725bf25558b50",
    "attributes": {
      "adherence": {
        "due": 0,
        "complete": 0,
        "streak": {
          "count": 0
        }
      },
      "critical": {
        "blood_glucose": {
          "data": {
            "maximum": {
              "unit": "mg/dL",
              "value": 300
            },
            "minimum": {
              "unit": "mg/dL",
              "value": 70
            }
          }
        },
        "effective_from": "2017-07-01T04:00:00.000Z"
      },
      "window_order": [],
      "effective_from": "2017-07-01T04:00:00.000Z",
      "window_notification_times": {
        "morning": 25200,
        "afternoon": 43200,
        "evening": 64800,
        "night": 75600
      }
    },
    "links": {
      "self": "/patient_plan_summary/5964f831f65725bf25558b50"
    },
    "relationships": {
      "bundles": {
        "links": {
          "related": "/patient_plan_summary/5964f831f65725bf25558b50/bundles"
        },
        "data": []
      },
      "actions": {
        "links": {
          "related": "/patient_plan_summary/5964f831f65725bf25558b50/actions"
        },
        "data": [
          {
            "id": "5964f831f65725bf25558b4b",
            "type": "action"
          }
        ]
      },
      "patient": {
        "links": {
          "related": "/patient_plan_summary/5964f831f65725bf25558b50/patient"
        },
        "data": {
          "type": "patient",
          "id": "5964f831f65725bf25558b4f"
        }
      },
      "current_results": {
        "links": {
          "related": "/patient_plan_summary/5964f831f65725bf25558b50/current_results"
        },
        "data": []
      }
    }
  },
  "included": [
    {
      "type": "action",
      "id": "5964f831f65725bf25558b4b",
      "attributes": {
        "_thread": "blood_pressure",
        "adherence": {
          "due": 0,
          "complete": 0,
          "streak": {
            "count": 0
          }
        },
        "effective_from": "2017-07-01T04:00:00.000Z",
        "frequency_goal": {
          "weeks": {
            "days": [
              0,
              1,
              2,
              3,
              4,
              5,
              6
            ]
          }
        },
        "frequency_goal_prorated": 0,
        "identifiers": [],
        "metric_required": false,
        "metrics": [
          {
            "metric_type": "blood_pressure",
            "unit": "mmHg",
            "goal": {
              "data": {
                "systolic": {
                  "value": 150,
                  "unit": "mmHg"
                },
                "diastolic": {
                  "value": 95,
                  "unit": "mmHg"
                }
              }
            },
            "_id": "5964f831f65725bf25558b51",
            "accepted_values": []
          }
        ],
        "title": "Record Blood Pressure",
        "tracking": true,
        "windows": [],
        "type": "blood_pressure",
        "options": []
      },
      "links": {
        "self": "/action/5964f831f65725bf25558b4b"
      },
      "relationships": {
        "plan": {
          "links": {
            "related": "/action/5964f831f65725bf25558b4b/plan"
          }
        },
        "bundles": {
          "links": {
            "related": "/action/5964f831f65725bf25558b4b/bundles"
          },
          "data": []
        }
      }
    }
  ],
  "meta": {
    "req_id": "e0e78ef5-c0fd-415b-9b9f-a1b5c77c1198"
  }
}

Changes

No recorded changes to this operation across all 70 revisions of this API.