Health Profile Tools
Read and update the structured health questionnaire.
Workflow rule
Always call getHealthProfileSchema first to discover question IDs, types, and expected value formats. Updates fail if types don't match.
getHealthProfileSchema
Returns the schema: sections, question IDs, display labels, types, examples.
| Parameter | Notes |
|---|---|
sectionAcronym | Filter to one section (e.g. "HWP", "DMH"). Omit for all. |
Each question has: id, label, type (e.g. BOOLEAN, ARRAY_STRING, BOOLEAN_KEY_VALUE_LIST), typeDescription, example.
Section acronyms
| Acronym | Title |
|---|---|
| HWP | Health & Wellness Profile |
| WEALH | Wellness Goals & Assessments |
| DMH | Detailed Medical History |
| DA | Diets & Allergies |
| FHSS | Family Health & Safety Screening |
| WHT | Wearables & Health Tracking |
| BS | Body Snapshot |
| PRSUP | Prescriptions & Supplements |
| FHIS | Family History |
getHealthProfile
Returns the user's full health profile as a flat map of question IDs to answers across all sections.
Parameters: none
getHealthProfileSection
Filters answers to one section.
| Parameter | Required |
|---|---|
sectionAcronym | yes |
updateHealthProfile
PATCH semantics — only provided fields change. Confirm with the user before calling.
| Parameter | Required |
|---|---|
data | yes — JSON string with question IDs as keys and answers as values |
Value shapes must match the schema's type. See the health profile recipe for type examples.
Errors: response includes invalidFields array if any IDs are unrecognized — re-check schema.
resetHealthProfileSection
Clears every answer in a section. Destructive — confirm first.
| Parameter | Required |
|---|---|
sectionAcronym | yes (must match table above) |