Skip to content

Commit af412e7

Browse files
authored
Merge pull request #469 from mattvarghese/master
Deprecate medication-prescribe and order-review
2 parents b1dc959 + 3e6fc55 commit af412e7

File tree

4 files changed

+15
-3
lines changed

4 files changed

+15
-3
lines changed

docs/hooks/medication-prescribe.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@
66
| hookVersion | 1.0
77
| Hook maturity | [2 - Tested](../../specification/1.0/#hook-maturity-model)
88

9+
10+
## Deprecation Notice
11+
12+
This hook is deprecated in favor of the `order-select` and `order-sign` hooks, with the goal of clarifying workflow trigger points and supporting orders beyond medications. In this refactoring, `medication-prescribe` and `order-review` hooks are being deprecated in favor of newly created [`order-select`](../order-select) and [`order-sign`](../order-sign) hooks. This notice is a placeholder to this effect while CDS Hooks determines the [appropriate process for deprecating hooks](https://github.com/cds-hooks/docs/issues/433).
13+
914
## Workflow
1015

1116
The user is in the process of prescribing one or more new medications.

docs/hooks/order-review.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66
| hookVersion | 1.0
77
| Hook maturity | [3 - Considered](../../specification/1.0/#hook-maturity-model)
88

9+
## Deprecation Notice
10+
11+
This hook is deprecated in favor of the `order-sign` hooks, with the goal of clarifying workflow trigger points and supporting orders beyond medications. In this refactoring, `medication-prescribe` and `order-review` hooks are being deprecated in favor of newly created [`order-select`](../order-select) and [`order-sign`](../order-sign) hooks. This notice is a placeholder to this effect while CDS Hooks determines the [appropriate process for deprecating hooks](https://github.com/cds-hooks/docs/issues/433).
12+
913
## Workflow
1014

1115
The user is in the process of reviewing a set of orders to sign.

docs/hooks/order-select.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
| ---- | ----
55
| specificationVersion | 1.0
66
| hookVersion | 1.0
7+
| Hook maturity | [1 - Submitted](../../specification/1.0/#hook-maturity-model)
78

89
## Workflow
910

@@ -14,6 +15,8 @@ as it first occurs immediately upon the clinician selecting the order from the o
1415
Additionally, the context may include previously selected orders that are not yet signed from the same ordering session.
1516
The `order-select` hook occurs after the clinician selects the order and before signing.
1617

18+
This hook is intended to replace (deprecate) the `medication-prescribe` hook.
19+
1720
## Context
1821

1922
The context of this hook distinguishes between the list of unsigned orders from the clinician's ordering session, and one or orders just added to this list. The `selections` field contains a list of ids of these newly selected orders; the `draftOrders` Bundle contains an entry for all unsigned orders from this session, including newly selected orders.
@@ -23,7 +26,7 @@ Field | Optionality | Prefetch Token | Type | Description
2326
`userId` | REQUIRED | Yes | *string* | The id of the current user.<br />For this hook, the user is expected to be of type [Practitioner](https://www.hl7.org/fhir/practitioner.html).<br />For example, `Practitioner/123`
2427
`patientId` | REQUIRED | Yes | *string* | The FHIR `Patient.id` of the current patient in context
2528
`encounterId` | OPTIONAL | Yes | *string* | The FHIR `Encounter.id` of the current encounter in context
26-
`selections` | REQUIRED | No| *array* | The FHIR id of the newly selected order(s).<br />The `selections` field references FHIR resources in the `orders` Bundle. For example, `MedicationRequest/103`.
29+
`selections` | REQUIRED | No| *array* | The FHIR id of the newly selected order(s).<br />The `selections` field references FHIR resources in the `draftOrders` Bundle. For example, `MedicationRequest/103`.
2730
`draftOrders` | REQUIRED | No | *object* | DSTU2 - FHIR Bundle of MedicationOrder, DiagnosticOrder, DeviceUseRequest, ReferralRequest, ProcedureRequest, NutritionOrder, VisionPrescription with _draft_ status <br/> STU3 - FHIR Bundle of MedicationRequest, ReferralRequest, ProcedureRequest, NutritionOrder, VisionPrescription with _draft_ status
2831

2932

docs/hooks/order-sign.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
| ---- | ----
55
| specificationVersion | 1.0
66
| hookVersion | 1.0
7-
| Hook maturity | 1 - Submitted
7+
| Hook maturity | [1 - Submitted](../../specification/1.0/#hook-maturity-model)
88

99
## Workflow
1010

@@ -14,7 +14,7 @@ The context contains all order details, such as dose, quantity, route, etc,
1414
although the order has not yet been signed and therefore still exists in a draft status.
1515
Use this hook when your service requires all order details, and the clinician will accept recommended changes.
1616

17-
This hook is intended to replace (deprecate) the `order-review` hook.
17+
This hook is intended to replace (deprecate) the `medication-prescribe` and `order-review` hooks.
1818

1919
## Context
2020

0 commit comments

Comments
 (0)