Clinical Intelligence StandardsVersion 0.2

Functional standard / People / Instance

ClinicalSetting

A place or service line that can fulfil orders: clinic, ward, lab, pharmacy, home, teleconsult.

Kind
clinical_setting
Collection
/v1/clinical-settings
Initial state
active
Classification
Operational

Scope and usage

What the setting offers, and which external systems it talks to.

Boundaries and relationships

Resource content

Elements this resource adds. It also carries the Instance.

NameCard.TypeFlagsDescription
name1..1string—Name shown when placing an order.
setting_type0..1code—opd, ipd, home, tele, lab, pharmacy, or a local code.
services0..*code—Order or service codes this setting can fulfil.
flags0..1object—Capabilities, for example has_pharmacy or accepts_referrals.
integrations0..*object—Named endpoints: { name, kind, endpoint }. Fulfilment lives outside the record.

State machine

active → inactive. inactive → active.

Frozen: None.

Invariants

No invariant beyond the common operation rules.

Operations

MethodPathMeaning
GET/v1/clinical-settingsList clinical setting. Filter by patient_id, status, and where the model has them, encounter_id or definition_key.
POST/v1/clinical-settingsCreate a clinical setting. Body is the resource minus harness-owned elements.
GET/v1/clinical-settings/{id}Read one clinical setting.
PATCH/v1/clinical-settings/{id}Update elements that are not immutable, frozen, or harness-owned.
POST/v1/clinical-settings/{id}/transitionMove status. Body is { to, reason }. A gated move returns 202 and an Approval.
DELETE/v1/clinical-settings/{id}?reason=Soft-delete. Reason is required. Refused when the resource is not deletable or is frozen.

Notes

Example

{ "name": "Main OPD", "setting_type": "opd", "services": ["consult"] }