Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 28 additions & 26 deletions versioned_docs/version-3.1/concepts/clinical/care-team.mdx
Original file line number Diff line number Diff line change
@@ -1,52 +1,54 @@
---
sidebar_position: 15
sidebar_position: 11
---

# Care team
# Clinical - Care Team

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The concept template says the H1 is "the resource name in sentence case" (.claude/skills/care-concept-doc/assets/concept-template.md), and checklist item 9 repeats it. # Clinical - Care Team prefixes the domain and uses title case. Use # Care team. The same change is needed in diagnostic-report.mdx, files.mdx, service-request.mdx and specimen.mdx, which all gained a # Clinical - ... H1 in this pull request.


## Definition

The **care team** of an [encounter](../clinical/encounter.mdx) is the list of users who look after the patient during that episode of care. Each member holds a practitioner role, such as a physician or a nurse. The first member in the list is the primary member, and Care shows that member on the encounter card and on printed documents. A care team belongs to one encounter, so a patient with two open encounters has two separate care teams.
The **[care team](https://build.fhir.org/encounter.html#Encounter.participant)** lists the staff who look after a patient during one encounter. Each entry names a staff member and the clinical role that person holds on that encounter. Care keeps the team as a list on the encounter. Care does not keep the team as a separate record with its own identifier, status, or time period. The list matches the participant part of the FHIR R5 Encounter resource. It does not match the standalone [FHIR CareTeam](https://build.fhir.org/careteam.html) resource.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Checklist item 7 and the concept template both allow the FHIR link but forbid narrating the mapping. "The list matches the participant part of the FHIR R5 Encounter resource. It does not match the standalone FHIR CareTeam resource" is exactly that narration. Keep the linked bold term and drop both sentences. The same fix applies to notes.mdx line 11 and the ## FHIR R5 alignment section in questionnaire-response.mdx.


## Key Attributes

| Components | What it captures |
| --- | --- |
| Member | The Care user who takes part in the episode of care. |
| Role | The practitioner role of the member for this encounter, such as physician or nurse. |
| Primary | The first member in the list. Care shows this member as the main contact for the encounter. |
| Order | The position of each member in the list. The order sets which member is primary. |
| Staff member | The person who looks after the patient during the encounter. |
| Role | The clinical role that the staff member holds on the encounter. |
| Primary member | The one member who leads the care of the patient. |

### Member
### Role

You select a member in two steps. First you select a facility department. Then you select a user from that department. A user can appear only once in a care team. Care shows an error if you add the same user two times.
Care takes the roles from a clinical terminology set. The list of roles that you can choose differs between deployments.

### Role
Note: The roles available to you depend on your deployment's configuration.

The role comes from the Practitioner Role value set. The value set holds the SNOMED CT healthcare professional and healthcare-related organization codes. You must select a role for each member.
### Primary member

The care team has no status of its own. It follows the encounter: when the encounter is complete, you can no longer change the care team.
Care marks one member of the list as Primary. Care always treats the first person in the list as the primary member. To change the primary member, move a different person to the top of the list.

## Permissions
### How Care saves the team

Care saves the whole team together as one list each time the team changes. Every change replaces the complete list. There is no separate action to add one member or to remove one member.

Care controls the care team through the encounter, not through a separate permission of its own.
### Use in encounter lists

Care lets you filter the encounters of a patient by care team member. Keep the team correct, so that these filters show the right encounters.

## Permissions

| Permission | Description | System Roles |
| Permission | Who holds it | What it allows |
| --- | --- | --- |
| `can_read_encounter` | See the care team of an encounter. | Admin, Doctor, Nurse, Facility Admin |
| `can_write_encounter` | Add a member, remove a member, or change the primary member. | Admin, Doctor, Nurse, Facility Admin |
| Update Encounter non clinical | Administrator, Doctor, Nurse, Facility Administrator | Add members, remove members, and reorder members. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The permission table columns vary across the eight concepts in this pull request: Permission | Who holds it | What it allows here, Action | Permission in consent.mdx and files.mdx, Permission | Roles in diagnostic-report.mdx, Action | Permission | Roles in notes.mdx. Checklist item 14 asks for one term for one thing across the scope — pick one shape and use it in all eight. Also please confirm "Update Encounter non clinical" is the display name in care/security/permissions/encounter.py; the care team members list reads as clinical data, so this may be the wrong permission.


Two more rules apply to a change:
A user who can open the encounter but cannot change it sees the same list in read-only form.

- Care refuses the change when the encounter is in a completed state.
- Care refuses a member who cannot see the encounter.
## Where to find it

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

## Where to find it is not a template section (checklist item 8). Navigation belongs in the flow's Steps, and these pages already have view-the-care-team.mdx. Fold this into the flow and remove the section here; diagnostic-report.mdx line 58 has the same added section.


Users get these roles through their organization and facility memberships. Permissions cascade down the organization tree, so a role at a parent organization applies to the facilities and encounters below it.
Open an encounter. Select **Encounter Actions**, then select **Manage Care Team**. You can also select **Manage Care Team** on the side panel of the **Overview** tab.

## Related

- Concept: [Encounter](../clinical/encounter.mdx)
- Concept: [Patient](../clinical/patient)
- Flow: [Manage the care team of an encounter](../../flows/clinical/encounter/manage-encounter-care-team.mdx)
- Reference: [Care team](../../references/clinical/care-team.mdx)
- Reference: [Encounter](../../references/clinical/encounter.mdx)
- Flow: [Add care team members](../../flows/clinical/care-team/add-care-team-members.mdx)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The rewrite dropped the link to ../../references/clinical/care-team.mdx, but that reference page still exists and links back here. The concept template's Related section lists the matching reference. Please add - Reference: [Care team](../../references/clinical/care-team.mdx) back. The same reference link was dropped from consent.mdx.

- Flow: [View the care team](../../flows/clinical/care-team/view-the-care-team.mdx)
- Flow: [Modify the care team](../../flows/clinical/care-team/modify-the-care-team.mdx)
- Concept: [Encounter](../../concepts/clinical/encounter.mdx)
113 changes: 59 additions & 54 deletions versioned_docs/version-3.1/concepts/clinical/consent.mdx
Original file line number Diff line number Diff line change
@@ -1,84 +1,89 @@
---
sidebar_position: 12
sidebar_position: 8
---

# Consent

A **consent** records a patient's decision to permit or refuse a category of activity — treatment, research participation, sharing of their information, or a directive about end-of-life care. It is the auditable proof that a choice was made, by or for the patient, before that activity went ahead.
## Definition

## What it represents
A **[consent](https://build.fhir.org/consent.html)** in Care is a record of the permission or the refusal that a patient gives for a treatment, for a research study, or for the sharing of information. Each consent belongs to one encounter. Care shows the consents of an encounter on the **Consents** tab of that encounter, as a list of cards.

In Care's FHIR-aligned model, a consent maps to the **Consent** resource. Each record answers four questions:
## Key Attributes

- **What is being decided** — a category such as treatment, research, privacy of information, or an advance directive like a do-not-resuscitate order
- **What was decided** — a single decision to *permit* or *deny* it
- **When it applies** — the date it was recorded, plus an optional validity window
- **How it was confirmed** — who witnessed the decision and how, with any signed form attached alongside
| Components | What it captures |
| --- | --- |
| Status | The current state of the consent. |
| Category | The subject that the patient gives permission or refusal for. |
| Consent Decision | Whether the patient permits or denies the subject of the consent. |
| Consent Given On | The date and time when the patient gives the consent. |
| Consent Valid From | The date and time from which the consent is valid. |
| Consent Valid Until | The date and time until which the consent is valid. |
| Note | Free text that records more information about the consent. |
| Supporting Documents | Files that you attach to the consent, for example a scanned signed consent form. |

The key thing to understand is that a consent is *not* a permission setting. It does not grant anyone access to the system. It documents the **patient's** clinical and legal choice — a fact about the patient's care, not a rule about staff. Who can act in Care is governed separately by the [permission model](../../references/access-governance/permission.mdx).
### Consent Decision

## Lifecycle
Consent Decision records the answer of the patient. Select one of these values:

A consent's status mirrors whether its decision is currently in force:
| Consent Decision | Description |
| --- | --- |
| Permit | The patient allows the subject of the consent. |
| Deny | The patient refuses the subject of the consent. |

```text
draft → active → inactive
↘ not_done
↘ entered_in_error
```
On the consent card, Care shows **Permitted** for Permit, and **Denied** for Deny.

- **draft** — recorded but not yet in force
- **active** — in force; the decision currently governs the activity
- **inactive** — no longer in force, for example once its validity window has passed
- **not_done** — the consent activity never took place
- **entered_in_error** — recorded by mistake; kept for audit but disregarded
### Category

Status is a plain field on the record. Moving a consent to `entered_in_error` corrects the history without deleting it, and changing status has no automatic side effect elsewhere in the chart — nothing downstream is unlocked or revoked.
Category records the subject of the consent. The consent form shows these categories, with a short description for each one:

## Categories
| Category | Description |
| --- | --- |
| Research | Consent to take part in a research protocol and to share information. |
| Privacy Consent | Consent to collect, access, use, or share information. |
| Treatment | Consent to undergo a specific treatment. |
| Do Not Resuscitate | Consent to not receive CPR or resuscitation in a cardiac event. |
| Advance Directive | Consent that the patient gives before a possible need for medical treatment. |
| Advance Care Directive | Consent for the actions to take if the patient can no longer decide. |

The category names what the patient is deciding about. Care recognises seven:
Note: Care also holds a **Comfort Care** category, but the consent form has no option for it. You cannot select Comfort Care. This is a known gap in the product.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"This is a known gap in the product" is a judgement about the roadmap, not documentation of what Care does. State the behaviour plainly and stop: "You cannot select Comfort Care on the consent form." The same phrase appears at line 66 of this file and in files.mdx.


| Category | What it covers |
| --- | --- |
| Treatment | Consent to a clinical treatment or procedure |
| Research | Consent to take part in research |
| Patient privacy | Consent to disclose or share the patient's information |
| DNR | A do-not-resuscitate directive |
| Comfort care | A comfort or palliative care directive |
| Advance care directive | A directive about future care while the patient can still decide |
| Advance directive (other) | Any other advance directive |
### Verification

Every consent carries exactly one decision — **permit** or **deny** — so a refusal is captured with the same weight and auditability as an approval. A documented "no" is as much a part of the record as a "yes".
Care can hold a verification for a consent. A verification records who confirmed the consent, when they confirmed it, and the type of the confirmation. The type is **Family** for a confirmation by a family member or a representative. The type is **Validation** for a confirmation by the patient.

## How it connects
Note: The current version of Care has no screen to add, show, or remove a verification. This is a known gap in the product. For more information, see [Verify a consent](../../flows/clinical/consent/verify-a-consent.mdx).

A consent is always attached to a single [encounter](../clinical/encounter.mdx), and the owning [patient](../clinical/patient) is reached through that encounter. The encounter is fixed at creation and cannot be moved to a different visit later — this is deliberate, because it preserves *when and in what context* the decision was made.
### Changes after creation

Two neighbouring records hang off a consent:
Care fixes the Category, the Consent Decision, the Consent Given On date, and the validity period when you record the consent. The edit form does not show these fields. After creation, you can change the Status and the Note.

- **Documents** — a signed consent form or scanned file can be attached, so the paper trail lives beside the structured record
- **Verifiers** — each verification names the user who confirmed the consent, so a reviewer can later see exactly who witnessed it
## Status

| Status | Description |
| --- | --- |
| Draft | You prepared the consent, but it is not in effect. |
| Active | The consent is in effect. |
| Inactive | The consent is no longer in effect. |
| Not Done | The consent did not happen. |
| Entered in Error | Someone recorded the consent by mistake. |

## Permissions

There is no separate consent permission set. Because a consent always hangs off an encounter, it is governed by the **encounter** clinical-data permissions, with patient-level clinical-data access also accepted for reads.
| Action | Permission |
| --- | --- |
| View a consent | Can view clinical data about patients, or Can Read encounter related clinical data. |
| Record a consent | Update Encounter related clinical data. |
| Update a consent | Update Encounter related clinical data. |

| Permission | Description | System Roles |
| --- | --- | --- |
| `can_write_encounter_clinical_data` | Create, update, or delete a consent on an encounter, and add or remove its verifications (blocked once the encounter is closed) | Admin, Doctor, Nurse, Facility Admin |
| `can_view_clinical_data` | View a patient's clinical record, including their consents | Staff, Doctor, Nurse, Admin, Facility Admin |
| `can_read_encounter_clinical_data` | Read consents via the encounter when patient-level clinical-data access is absent | Admin, Doctor, Nurse, Facility Admin |
The Admin, Doctor, Nurse, and Facility Admin roles hold the **Update Encounter related clinical data** permission.

Roles are granted through organization, facility, or patient memberships, and permissions cascade down the organization tree — a role held higher up applies to the patients and consents beneath it.
Note: Care shows the buttons that record and change a consent only when the encounter is active, and only when you open the encounter from the facility.

## Related

- Reference: [Consent (technical)](../../references/clinical/consent.mdx)
- Concept: [Encounter](../clinical/encounter.mdx)
- Concept: [Patient](../clinical/patient)
- Reference: [Permission](../../references/access-governance/permission.mdx)

## FHIR reference

Care's consent aligns with the FHIR **Consent** resource: its status, category, decision, and validity period map to their FHIR counterparts, modelling a patient's recorded choice to permit or deny a category of activity.
- Concept: [Encounter](../../concepts/clinical/encounter.mdx)
- Concept: [Files](../../concepts/clinical/files.mdx)
- Flow: [Record a consent](../../flows/clinical/consent/record-a-consent.mdx)
- Flow: [View consents](../../flows/clinical/consent/view-consents.mdx)
- Flow: [Update a consent](../../flows/clinical/consent/update-a-consent.mdx)
- Flow: [Verify a consent](../../flows/clinical/consent/verify-a-consent.mdx)
Loading
Loading