action
Get an action
Get a health action from a patient's plan.
get/action/{id}
Request
- Base URLhttps://api.twinehealth.com/pub
- Authnone declared
Path parameters
idstring required
Action identifier
Response
OK
Example response
{
"data": {
"type": "action",
"id": "59653f699fc8be3938f04491",
"attributes": {
"_thread": "weight",
"adherence": {
"due": 1,
"complete": 1,
"streak": {
"count": 1,
"updated_at": "2017-07-11T21:13:13.215Z"
}
},
"effective_from": "2017-07-10T21:13:13.212Z",
"effective_to": "2017-07-11T21:13:13.215Z",
"frequency_goal": {
"weeks": {
"days": [
0
]
}
},
"frequency_goal_prorated": 0,
"identifiers": [
{
"label": "Super Health Actions",
"system": "http://super.health.example.com",
"value": "action-0123",
"_id": "59653f699fc8be3938f04494"
}
],
"details": {
"some": "mixed value"
},
"metric_required": true,
"metrics": [
{
"metric_type": "weight",
"unit": "lb",
"goal": {
"data": {
"unit": "lb",
"value": 210
}
},
"_id": "59653f699fc8be3938f04493",
"accepted_values": [],
"validations": {
"maximum": {
"unit": "lb",
"value": 999
},
"minimum": {
"unit": "lb",
"value": 0
}
}
}
],
"title": "Measure Weight",
"tracking": true,
"windows": [
{
"title": "Morning",
"type": "morning",
"_id": "59653f699fc8be3938f04492"
}
],
"type": "weight",
"options": []
},
"links": {
"self": "/action/59653f699fc8be3938f04491"
},
"relationships": {
"plan": {
"links": {
"related": "/action/59653f699fc8be3938f04491/plan"
}
},
"bundles": {
"links": {
"related": "/action/59653f699fc8be3938f04491/bundles"
},
"data": []
}
}
},
"included": [],
"meta": {
"req_id": "63bf4340-f256-400e-b391-d801d2a251f6"
}
}Changes
No recorded changes to this operation across all 70 revisions of this API.