Functional standard / People / PatientInstance
Relationship
A link from a patient to a family member who is also a Patient.
- Kind
- relationship
- Collection
- /v1/relationships
- Initial state
- active
- Classification
- Operational
Scope and usage
Records who is related, who may grant consent, and who receives communication.
Boundaries and relationships
- The related person must already be a Patient.
- Consent itself is a Consent resource. This record only names the scopes a guardian may grant.
Resource content
Elements this resource adds. It also carries the Instance, including patient_id.
| Name | Card. | Type | Flags | Description |
|---|---|---|---|---|
| related_patient_id | 1..1 | id | — | The other Patient. |
| relation | 1..1 | string | — | mother, spouse, son, friend, or a local term. |
| is_guardian | 1..1 | boolean | — | May grant consent for the scopes listed. |
| is_care_taker | 1..1 | boolean | — | May see the record as a representative. |
| consent_scopes | 0..* | code | B | Scopes this person may grant. See Consent. |
| receives_communication | 1..1 | boolean | — | Operational contact flag. Not a clinical consent. |
State machine
active/ initial — The link is in force.ended— The link has been closed.
active → ended.
Frozen: None.
Invariants
ccs-rel-1— A guardian may grant only the scopes listed on the active relationship.
Operations
| Method | Path | Meaning |
|---|---|---|
| GET | /v1/relationships | List relationship. Filter by patient_id, status, and where the model has them, encounter_id or definition_key. |
| POST | /v1/relationships | Create a relationship. Body is the resource minus harness-owned elements. |
| GET | /v1/relationships/{id} | Read one relationship. |
| PATCH | /v1/relationships/{id} | Update elements that are not immutable, frozen, or harness-owned. |
| POST | /v1/relationships/{id}/transition | Move status. Body is { to, reason }. A gated move returns 202 and an Approval. |
| DELETE | /v1/relationships/{id}?reason= | Soft-delete. Reason is required. Refused when the resource is not deletable or is frozen. |
Example
{ "patient_id": "pat_…", "related_patient_id": "pat_…", "relation": "mother", "is_guardian": true, "consent_scopes": ["treatment"] }