Functional standard / How they are / PatientInstance
Outcome
A target. When it is reached, the harness can propose a new clinical state.
- Kind
- outcome
- Collection
- /v1/outcomes
- Initial state
- expected
- Classification
- Clinical
Scope and usage
The closing of the loop: expected, then achieved or unachieved. The measure is an observation code.
Boundaries and relationships
- The measurement series is Observation. This resource is the target and the judgment that it was met.
- A protocol may instantiate outcomes. Achieving one does not silently change the state.
Resource content
Elements this resource adds. It also carries the Instance, including patient_id.
| Name | Card. | Type | Flags | Description |
|---|---|---|---|---|
| name | 1..1 | string | — | Name of the target. |
| outcome_type | 1..1 | code | B | clinical, functional, patient_reported, process, or experience. |
| perceived_by | 1..1 | code | B | patient or care_team. |
| condition_code | 0..1 | code | — | Condition this target belongs to. |
| measure_code | 0..1 | code | — | Observation code tracked, for example phq9_score. |
| comparator | 0..1 | code | B | <, <=, >, >=, or ==. |
| target | 0..1 | decimal | — | Numeric target. |
| due_by | 0..1 | dateTime | — | When it should have been met. |
| on_achieved_state | 0..1 | code | — | Clinical state to propose when achieved, for example remission. |
| protocol_assignment_id | 0..1 | id | — | Protocol that instantiated it. |
| evidence | 0..* | id | — | Observation ids that showed it. |
State machine
expected/ initial — The agreed target.achieved— Met. Frozen. May propose on_achieved_state.unachieved— Missed. May return to expected.
expected → achieved, unachieved. unachieved → expected.
Frozen: achieved.
Invariants
ccs-out-1— Achieving an outcome proposes on_achieved_state. It does not write the ClinicalState.
Operations
| Method | Path | Meaning |
|---|---|---|
| GET | /v1/outcomes | List outcome. Filter by patient_id, status, and where the model has them, encounter_id or definition_key. |
| POST | /v1/outcomes | Create a outcome. Body is the resource minus harness-owned elements. |
| GET | /v1/outcomes/{id} | Read one outcome. |
| PATCH | /v1/outcomes/{id} | Update elements that are not immutable, frozen, or harness-owned. |
| POST | /v1/outcomes/{id}/transition | Move status. Body is { to, reason }. A gated move returns 202 and an Approval. |
| DELETE | /v1/outcomes/{id}?reason= | Soft-delete. Reason is required. Refused when the resource is not deletable or is frozen. |
| GET | /v1/outcomes/{id}/evaluate | Trajectory of the measure against the target. |
Example
{ "patient_id": "pat_…", "name": "Remission", "measure_code": "phq9_score", "comparator": "<", "target": 5, "on_achieved_state": "remission" }