You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: versioned_docs/version-3.1/concepts/definitions/activity-definition.mdx
+37-46Lines changed: 37 additions & 46 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,64 +4,55 @@ sidebar_position: 6
4
4
5
5
# Activity Definition
6
6
7
-
An **activity definition** is a reusable, facility-scoped template for a clinical activity — a lab test, an imaging study, a counselling session — holding every default needed to order it. A facility defines the activity once, then turns it into a real order for a specific patient with a single "apply" action.
7
+
## Definition
8
8
9
-
## What it represents
9
+
An **[activity definition](https://build.fhir.org/activitydefinition.html)** in Care is a reusable template for a service, a procedure, or a test that clinicians order. A common example is a "CBC Test". The template holds the details that a clinician otherwise types each time. When a clinician orders from the template, Care creates a [Service Request](../../concepts/clinical/service-request.mdx).
10
10
11
-
In Care's FHIR-aligned model, an activity definition maps to the **ActivityDefinition** resource: a reusable description of an action to perform, defined independently of any patient.
11
+
## Key Attributes
12
12
13
-
The key distinction is that an activity definition is a blueprint, not a record of anything that happened. It carries the defaults — the procedure code, the specimens to collect, the observations to result, the locations and charges — but no patient. It belongs to a facility's catalog of services; the actual work for a patient lives in the [service request](../clinical/service-request.mdx) it generates. Define "Complete Blood Count" once and apply it to twenty patients, and you get twenty separate orders, all sharing the same template.
14
-
15
-
## Classification
16
-
17
-
Every activity definition carries one classification describing the nature of the work:
18
-
19
-
| Classification | Typical use |
13
+
| Components | What it captures |
20
14
| --- | --- |
21
-
|`laboratory`| Blood panels, cultures, and other lab investigations |
22
-
|`imaging`| X-ray, ultrasound, CT, and similar studies |
23
-
|`counselling`| Structured counselling or advisory sessions |
24
-
|`surgical_procedure`| Operative and bedside procedures |
25
-
|`education`| Patient education and instruction activities |
26
-
27
-
## How it connects
15
+
| Title | The name of the template that staff see when they order the service. Required. |
16
+
| Status | The stage of the template in its lifecycle. Required. |
17
+
| Category | The type of the service: Laboratory, Imaging, Surgical Procedure, Counselling, or Education. Required. |
18
+
| Kind | The type of order that Care creates from the template. Required. The value is always "Service Request". |
19
+
| Code | The standard medical code for the service or the procedure. Required. |
20
+
| Body Site | The part of the body for the service or the procedure. Optional. |
21
+
| Resource Category | The catalogue category of your facility that holds this template. Required. |
22
+
| Healthcare Service | The healthcare service that provides this activity. Optional. |
23
+
| Locations | The locations where staff can do this activity. Optional. |
24
+
| Diagnostic Report Codes | The codes for the diagnostic reports that come from this activity. Optional. |
25
+
| Requirements | The Specimen Definitions, the Observation Definitions, and the Charge Item Definitions that this template needs. |
28
26
29
-
An activity definition is the assembly point that wires a facility's reusable pieces together, so a single order carries everything it needs without anyone reassembling it by hand:
27
+
### Category and Resource Category
30
28
31
-
-**What to collect and measure** — [specimen definitions](../definitions/specimen-definition.mdx) and [observation definitions](../definitions/observation-definition.mdx)
32
-
-**Where it happens** — the [locations](../facility/location.mdx) and [healthcare service](../facility/healthcare-service.mdx) the activity runs under
33
-
-**What it costs** — [charge item definitions](../definitions/charge-item-definition.mdx), so applying the activity can raise the right billing lines automatically
29
+
Category and Resource Category are two different fields on the same form.
34
30
35
-
Patient and encounter are supplied at apply time, never stored on the template. The definition is applied against an [encounter](../clinical/encounter.mdx), which binds the result to a specific patient. Applying merges the stored defaults with that encounter context to produce a draft service request — plus a charge item for each linked charge, tied back to the same request.
31
+
-**Category** holds the type of the service. Care gives you a fixed list of choices: Laboratory, Imaging, Surgical Procedure, Counselling, and Education. Care copies this value to the service request when a clinician orders the service.
32
+
-**Resource Category** holds the catalogue category of your facility. Your facility makes these categories and names them, for example "Blood Tests".
36
33
37
-
## Lifecycle
34
+
The Activity Definitions page shows the Resource Categories first. Open a Resource Category to see the templates in it.
38
35
39
-
```text
40
-
draft → active → retired
41
-
```
36
+
### Requirements
42
37
43
-
-**draft** — being authored, not yet ready for routine use
44
-
-**active** — published and available to apply to encounters
45
-
-**retired** — withdrawn from use but kept for history and reference
38
+
Requirements connect a template to the items that the service needs. Add a Specimen Definition for each sample that staff collect. Add an Observation Definition for each result that staff record. Add a Charge Item Definition for each charge that applies to the service.
46
39
47
-
A separate `unknown` status covers definitions whose state cannot be determined. Activity definitions are also versioned: editing a definition appends a new version to a chain rather than overwriting it, with one marked as the latest. Older order templates stay referenceable even after the catalog moves on.
40
+
### Status
48
41
49
-
## Permissions
50
-
51
-
Access is governed at the facility level — whether a role can author the catalog or only read from it and apply.
52
-
53
-
| Permission | Description | System Roles |
54
-
| --- | --- | --- |
55
-
|`can_write_activity_definition`| Create and edit activity definitions on a facility | Facility Admin, Admin |
56
-
|`can_read_activity_definition`| List and view activity definitions on a facility | Facility Admin, Administrator, Admin, Staff, Doctor, Nurse, Volunteer |
57
-
58
-
Roles are granted through a user's organization and facility memberships, and cascade down the organization tree — a role held higher up applies to the facilities and resources beneath it.
42
+
| Status | Description |
43
+
| --- | --- |
44
+
| Draft | The template is in preparation. Staff cannot use it to order a service. |
45
+
| Active | The template is ready. Staff can use it to order a service. |
46
+
| Retired | The template is no longer in use. |
47
+
| Unknown | The stage of the template is not known. |
0 commit comments