Skip to content

Commit 5bbea3c

Browse files
isaacvetterisaacvetter
authored
Propose order-sign hook
Note that this hook is intended to deprecate order-review.
1 parent 70fdc1e commit 5bbea3c

File tree

1 file changed

+361
-0
lines changed

1 file changed

+361
-0
lines changed

‎docs/hooks/order-sign.md

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

0 commit comments

Comments
 (0)