Clinical Intelligence StandardsVersion 0.2

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

Resource content

Elements this resource adds. It also carries the Instance, including patient_id.

NameCard.TypeFlagsDescription
name1..1string—Profile name.
profile_type1..1codeBgeneral, condition, or episode.
tags1..1ProfileTags—conditions, measurements, medications, outcomes to watch.
priority_states0..*code—Clinical states that raise this profile.
expires_at0..1dateTime—When a short-lived profile expires.

State machine

active → pinned, inactive. pinned → active, inactive. inactive → active.

Frozen: None.

Invariants

No invariant beyond the common operation rules.

Operations

MethodPathMeaning
GET/v1/health-profilesList health profile. Filter by patient_id, status, and where the model has them, encounter_id or definition_key.
POST/v1/health-profilesCreate 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}/transitionMove 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}/viewPresent and absent items for the tagged codes.

Notes

Example

{ "patient_id": "pat_…", "name": "General", "profile_type": "general" }