Functional standard / How they are / PatientInstance
HealthProfile
A tagged view over observations: what is present and what is absent.
- Kind
- health_profile
- Collection
- /v1/health-profiles
- Initial state
- active
- Classification
- Operational
Scope and usage
Every patient has a general profile. Others are condition-specific or short-lived, such as a surgery episode.
Boundaries and relationships
- The profile does not copy observations. It points at codes and conditions.
- Priority is not a clinical state.
Resource content
Elements this resource adds. It also carries the Instance, including patient_id.
| Name | Card. | Type | Flags | Description |
|---|---|---|---|---|
| name | 1..1 | string | — | Profile name. |
| profile_type | 1..1 | code | B | general, condition, or episode. |
| tags | 1..1 | ProfileTags | — | conditions, measurements, medications, outcomes to watch. |
| priority_states | 0..* | code | — | Clinical states that raise this profile. |
| expires_at | 0..1 | dateTime | — | When a short-lived profile expires. |
State machine
active/ initial — In the summary.pinned— Kept at the top of the summary.inactive— Hidden from the default summary.
active → pinned, inactive. pinned → active, inactive. inactive → active.
Frozen: None.
Invariants
No invariant beyond the common operation rules.
Operations
| Method | Path | Meaning |
|---|---|---|
| GET | /v1/health-profiles | List health profile. Filter by patient_id, status, and where the model has them, encounter_id or definition_key. |
| POST | /v1/health-profiles | Create a health profile. Body is the resource minus harness-owned elements. |
| GET | /v1/health-profiles/{id} | Read one health profile. |
| PATCH | /v1/health-profiles/{id} | Update elements that are not immutable, frozen, or harness-owned. |
| POST | /v1/health-profiles/{id}/transition | Move status. Body is { to, reason }. A gated move returns 202 and an Approval. |
| DELETE | /v1/health-profiles/{id}?reason= | Soft-delete. Reason is required. Refused when the resource is not deletable or is frozen. |
| GET | /v1/health-profiles/{id}/view | Present and absent items for the tagged codes. |
Notes
- Created from definition kind health_profile.
Example
{ "patient_id": "pat_…", "name": "General", "profile_type": "general" }