Clinical Intelligence StandardsVersion 0.2

Functional standard / Interactions / PatientInstance

JournalEntry

A patient log through a journal plugin. Mapped fields become patient-perceived observations.

Kind
journal_entry
Collection
/v1/journal-entries
Initial state
recorded
Classification
Operational

Scope and usage

The patient, or staff on their behalf, records the plugin's fields. The row is frozen once recorded. Correct with entered_in_error.

Boundaries and relationships

Resource content

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

NameCard.TypeFlagsDescription
plugin_key1..1code—journal_plugin definition key.
care_action_id0..1id—The journal action this log fulfils.
data0..1object—Field key to value.
recorded_at1..1dateTime—When the patient recorded it.

State machine

recorded → entered_in_error.

Frozen: recorded and entered_in_error.

Invariants

Operations

MethodPathMeaning
GET/v1/journal-entriesList journal entry. Filter by patient_id, status, and where the model has them, encounter_id or definition_key.
POST/v1/journal-entriesCreate a journal entry. Body is the resource minus harness-owned elements.
GET/v1/journal-entries/{id}Read one journal entry.
PATCH/v1/journal-entries/{id}Update elements that are not immutable, frozen, or harness-owned.
POST/v1/journal-entries/{id}/transitionMove status. Body is { to, reason }. A gated move returns 202 and an Approval.

Example

{ "patient_id": "pat_…", "plugin_key": "journal_plugin_mood_diary", "data": { "mood": 3 } }