Functional standard / What can be done / PatientInstance
CohortMembership
The patient is in a cohort. Entry and exit run the cohort definition's actions.
- Kind
- cohort_membership
- Collection
- /v1/cohort-memberships
- Initial state
- active
- Classification
- Clinical
Scope and usage
Enrollment. The cohort rule may match automatically, but matching proposes membership. A person confirms it. Manual enrollment requires a reason.
Boundaries and relationships
- The cohort definition is shared configuration. This resource is one patient's membership.
- Being in a cohort does not assign the protocol. That assignment is proposed.
Resource content
Elements this resource adds. It also carries the Instance, including patient_id.
| Name | Card. | Type | Flags | Description |
|---|---|---|---|---|
| cohort_key | 1..1 | code | I | Definition key of kind cohort. |
| overridden | 1..1 | boolean | — | True when enrolled even though the rule did not match. |
| reason | 1..1 | string | — | Why, at least three characters. |
State machine
active/ initial — Enrolled.closed— Enrollment ended. Frozen.
active → closed.
Frozen: closed.
Invariants
ccs-coh-1— The cohort rule must match unless overridden is true and a reason is given.ccs-coh-2— No second active membership for the same cohort key.ccs-coh-3— Entry actions that are clinical become proposals.
Operations
| Method | Path | Meaning |
|---|---|---|
| GET | /v1/cohort-memberships | List cohort membership. Filter by patient_id, status, and where the model has them, encounter_id or definition_key. |
| POST | /v1/cohort-memberships | Create a cohort membership. Body is the resource minus harness-owned elements. |
| GET | /v1/cohort-memberships/{id} | Read one cohort membership. |
| PATCH | /v1/cohort-memberships/{id} | Update elements that are not immutable, frozen, or harness-owned. |
| POST | /v1/cohort-memberships/{id}/transition | Move status. Body is { to, reason }. A gated move returns 202 and an Approval. |
Notes
- Definition kind cohort.
Example
{ "patient_id": "pat_…", "cohort_key": "cohort_mdd", "reason": "Working diagnosis of MDD" }