TWtwinehealth
health profile

Get a health profile

Changed on

Get a health profile by id

get/health_profile/{id}

Request

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

Path parameters

idstring required

Health profile identifier

Query parameters

include'patient' | 'questions'

List of related resources to include in the response

Response

OK

Example response

{
  "data": {
    "type": "health_profile",
    "id": "59d441ac21741161bbe266b5",
    "attributes": {
      "created_at": "2017-07-07T19:15:56.229Z",
      "stats": [
        {
          "category": "lifestyle_behaviors",
          "answered": 5,
          "total": 11
        },
        {
          "category": "mental_wellbeing",
          "answered": 3,
          "total": 5
        },
        {
          "category": "preventative_care",
          "answered": 1,
          "total": 3
        },
        {
          "category": "overall",
          "answered": 9,
          "total": 19
        }
      ],
      "updated_at": "2017-07-07T19:15:56.229Z"
    },
    "relationships": {
      "patient": {
        "data": {
          "id": "595fddea28c5041b84466bbe",
          "type": "patient"
        },
        "links": {
          "related": "/pub/health_profile/59d441ac21741161bbe266b5/patient"
        }
      },
      "questions": {
        "data": [
          {
            "id": "595fddea28c5041b84466bbe",
            "type": "health_profile_question"
          }
        ],
        "links": {
          "related": "/pub/health_profile/59d441ac21741161bbe266b5/questions"
        }
      }
    },
    "links": {
      "self": "/pub/health_profile/59d441ac21741161bbe266b5"
    }
  }
}

Changes