Skip to content

Commit b1dc959

Browse files
isaacvetterisaacvetter
authored
Merge pull request #429 from cds-hooks/propose-order-sign-hook
Propose order-sign hook (lay groundwork to deprecate order-review).
2 parents ffde209 + eed93a4 commit b1dc959

File tree

2 files changed

+363
-1
lines changed

2 files changed

+363
-1
lines changed

‎docs/hooks/order-sign.md

Lines changed: 362 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,362 @@
1+
# `order-sign`
2+
3+
| Metadata | Value
4+
| ---- | ----
5+
| specificationVersion | 1.0
6+
| hookVersion | 1.0
7+
| Hook maturity | 1 - Submitted
8+
9+
## Workflow
10+
11+
The `order-sign` hook fires when a clinician is ready to sign one or more orders for a patient, (including orders for medications, procedures, labs and other orders).
12+
This hook is among the last workflow events before an order is promoted out of a draft status.
13+
The context contains all order details, such as dose, quantity, route, etc,
14+
although the order has not yet been signed and therefore still exists in a draft status.
15+
Use this hook when your service requires all order details, and the clinician will accept recommended changes.
16+
17+
This hook is intended to replace (deprecate) the `order-review` hook.
18+
19+
## Context
20+
21+
Field | Optionality | Prefetch Token | Type | Description
22+
----- | -------- | ---- | ---- | ----
23+
`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`
24+
`patientId` | REQUIRED | Yes | *string* | The FHIR `Patient.id` of the current patient in context
25+
`encounterId` | OPTIONAL | Yes | *string* | The FHIR `Encounter.id` of the current encounter in context
26+
`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
27+
28+
29+
30+
### Examples
31+
32+
### Example (STU3)
33+
34+
```json
35+
{
36+
"context":{
37+
"userId":"Practitioner/123",
38+
"patientId":"1288992",
39+
"encounterId":"89284",
40+
"draftOrders":{
41+
"resourceType":"Bundle",
42+
"entry":[
43+
{
44+
"resource":{
45+
"resourceType":"NutritionOrder",
46+
"id":"pureeddiet-simple",
47+
"identifier":[
48+
{
49+
"system":"http://goodhealthhospital.org/nutrition-requests",
50+
"value":"123"
51+
}
52+
],
53+
"status":"draft",
54+
"patient":{
55+
"reference":"Patient/1288992"
56+
},
57+
"dateTime":"2014-09-17",
58+
"orderer":{
59+
"reference":"Practitioner/example",
60+
"display":"Dr Adam Careful"
61+
},
62+
"oralDiet":{
63+
"type":[
64+
{
65+
"coding":[
66+
{
67+
"system":"http://snomed.info/sct",
68+
"code":"226211001",
69+
"display":"Pureed diet"
70+
},
71+
{
72+
"system":"http://goodhealthhospital.org/diet-type-codes",
73+
"code":"1010",
74+
"display":"Pureed diet"
75+
}
76+
],
77+
"text":"Pureed diet"
78+
}
79+
],
80+
"schedule":[
81+
{
82+
"repeat":{
83+
"boundsPeriod":{
84+
"start":"2015-02-10"
85+
},
86+
"frequency":3,
87+
"period":1,
88+
"periodUnit":"d"
89+
}
90+
}
91+
],
92+
"texture":[
93+
{
94+
"modifier":{
95+
"coding":[
96+
{
97+
"system":"http://snomed.info/sct",
98+
"code":"228055009",
99+
"display":"Liquidized food"
100+
}
101+
],
102+
"text":"Pureed"
103+
}
104+
}
105+
],
106+
"fluidConsistencyType":[
107+
{
108+
"coding":[
109+
{
110+
"system":"http://snomed.info/sct",
111+
"code":"439021000124105",
112+
"display":"Dietary liquid consistency - nectar thick liquid"
113+
}
114+
],
115+
"text":"Nectar thick liquids"
116+
}
117+
]
118+
},
119+
"supplement":[
120+
{
121+
"type":{
122+
"coding":[
123+
{
124+
"system":"http://snomed.info/sct",
125+
"code":"442971000124100",
126+
"display":"Adult high energy formula"
127+
},
128+
{
129+
"system":"http://goodhealthhospital.org/supplement-type-codes",
130+
"code":"1040",
131+
"display":"Adult high energy pudding"
132+
}
133+
],
134+
"text":"Adult high energy pudding"
135+
},
136+
"productName":"Ensure Pudding 4 oz container",
137+
"instruction":"Ensure Pudding at breakfast, lunch, supper"
138+
}
139+
]
140+
}
141+
},
142+
{
143+
"resource":{
144+
"resourceType":"MedicationRequest",
145+
"id":"smart-MedicationRequest-103",
146+
"meta":{
147+
"lastUpdated":"2018-04-30T13:25:40.845-04:00"
148+
},
149+
"text":{
150+
"status":"generated",
151+
"div":"<div xmlns=\"http://www.w3.org/1999/xhtml\">Amoxicillin 120 MG/ML / clavulanate potassium 8.58 MG/ML Oral Suspension (rxnorm: 617993)</div>"
152+
},
153+
"status":"draft",
154+
"intent":"order",
155+
"medicationCodeableConcept":{
156+
"coding":[
157+
{
158+
"system":"http://www.nlm.nih.gov/research/umls/rxnorm",
159+
"code":"617993",
160+
"display":"Amoxicillin 120 MG/ML / clavulanate potassium 8.58 MG/ML Oral Suspension"
161+
}
162+
],
163+
"text":"Amoxicillin 120 MG/ML / clavulanate potassium 8.58 MG/ML Oral Suspension"
164+
},
165+
"subject":{
166+
"reference":"Patient/1288992"
167+
},
168+
"dosageInstruction":[
169+
{
170+
"text":"5 mL bid x 10 days",
171+
"timing":{
172+
"repeat":{
173+
"boundsPeriod":{
174+
"start":"2005-01-04"
175+
},
176+
"frequency":2,
177+
"period":1,
178+
"periodUnit":"d"
179+
}
180+
},
181+
"doseQuantity":{
182+
"value":5,
183+
"unit":"mL",
184+
"system":"http://unitsofmeasure.org",
185+
"code":"mL"
186+
}
187+
}
188+
],
189+
"dispenseRequest":{
190+
"numberOfRepeatsAllowed":1,
191+
"quantity":{
192+
"value":1,
193+
"unit":"mL",
194+
"system":"http://unitsofmeasure.org",
195+
"code":"mL"
196+
},
197+
"expectedSupplyDuration":{
198+
"value":10,
199+
"unit":"days",
200+
"system":"http://unitsofmeasure.org",
201+
"code":"d"
202+
}
203+
}
204+
}
205+
}
206+
]
207+
}
208+
}
209+
}
210+
```
211+
212+
### Example (DSTU2)
213+
214+
```json
215+
"context":{
216+
"userId":"Practitioner/123",
217+
"patientId":"1288992",
218+
"encounterId":"89284",
219+
"draftOrders":{
220+
"resourceType":"Bundle",
221+
"entry":[
222+
{
223+
"resource":{
224+
"resourceType":"NutritionOrder",
225+
"id":"nest-patient-1-NUTR1",
226+
"patient":{
227+
"reference":"Patient/1288992"
228+
},
229+
"orderer":{
230+
"display":"Dr Adam Careful"
231+
},
232+
"identifier":[
233+
{
234+
"system":"http://goodhealthhospital.org/nutrition-orders",
235+
"value":"123"
236+
}
237+
],
238+
"dateTime":"2014-09-17",
239+
"status":"draft",
240+
"oralDiet":{
241+
"type":[
242+
{
243+
"coding":[
244+
{
245+
"system":"http://snomed.info/sct",
246+
"code":"435801000124108",
247+
"display":"Texture modified diet"
248+
},
249+
{
250+
"system":"http://goodhealthhospital.org/diet-type-codes",
251+
"code":"1010",
252+
"display":"Texture modified diet"
253+
}
254+
],
255+
"text":"Texture modified diet"
256+
}
257+
],
258+
"schedule":[
259+
{
260+
"repeat":{
261+
"boundsPeriod":{
262+
"start":"2015-02-10"
263+
},
264+
"frequency":3,
265+
"period":1,
266+
"periodUnits":"d"
267+
}
268+
}
269+
],
270+
"texture":[
271+
{
272+
"modifier":{
273+
"coding":[
274+
{
275+
"system":"http://snomed.info/sct",
276+
"code":"228049004",
277+
"display":"Chopped food"
278+
}
279+
],
280+
"text":"Regular, Chopped Meat"
281+
},
282+
"foodType":{
283+
"coding":[
284+
{
285+
"system":"http://snomed.info/sct",
286+
"code":"22836000",
287+
"display":"Vegetable"
288+
}
289+
],
290+
"text":"Regular, Chopped Meat"
291+
}
292+
}
293+
]
294+
}
295+
}
296+
},
297+
{
298+
"resource":{
299+
"resourceType":"MedicationOrder",
300+
"id":"smart-MedicationOrder-103",
301+
"status":"draft",
302+
"patient":{
303+
"reference":"Patient/1288992"
304+
},
305+
"medicationCodeableConcept":{
306+
"coding":[
307+
{
308+
"system":"http://www.nlm.nih.gov/research/umls/rxnorm",
309+
"code":"617993",
310+
"display":"Amoxicillin 120 MG/ML / clavulanate potassium 8.58 MG/ML Oral Suspension"
311+
}
312+
],
313+
"text":"Amoxicillin 120 MG/ML / clavulanate potassium 8.58 MG/ML Oral Suspension"
314+
},
315+
"dosageInstruction":[
316+
{
317+
"text":"5 mL bid x 10 days",
318+
"timing":{
319+
"repeat":{
320+
"boundsPeriod":{
321+
"start":"2005-01-04"
322+
},
323+
"frequency":2,
324+
"period":1,
325+
"periodUnits":"d"
326+
}
327+
},
328+
"doseQuantity":{
329+
"value":5,
330+
"unit":"mL",
331+
"system":"http://unitsofmeasure.org",
332+
"code":"mL"
333+
}
334+
}
335+
],
336+
"dispenseRequest":{
337+
"numberOfRepeatsAllowed":1,
338+
"quantity":{
339+
"value":1,
340+
"unit":"mL",
341+
"system":"http://unitsofmeasure.org",
342+
"code":"mL"
343+
},
344+
"expectedSupplyDuration":{
345+
"value":10,
346+
"unit":"days",
347+
"system":"http://unitsofmeasure.org",
348+
"code":"d"
349+
}
350+
}
351+
}
352+
}
353+
]
354+
}
355+
}
356+
```
357+
358+
## Change Log
359+
360+
Version | Description
361+
---- | ----
362+
1.0 | Initial Release

‎mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ nav:
2020
- 'medication-prescribe 2' : 'hooks/medication-prescribe.md'
2121
- 'order-review 3' : 'hooks/order-review.md'
2222
- 'order-select 1' : 'hooks/order-select.md'
23-
23+
- 'order-sign 1' : 'hooks/order-sign.md'
2424
- Quick Start: 'quickstart.md'
2525
- Best Practices: 'best-practices.md'
2626
- Examples: 'examples.md'

0 commit comments

Comments
 (0)