Skip to content

Commit 29a58cb

Browse files
isaacvetterisaacvetter
authored
Propose order-select hook
1 parent 70fdc1e commit 29a58cb

File tree

1 file changed

+366
-0
lines changed

1 file changed

+366
-0
lines changed

‎docs/hooks/order-select.md

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

0 commit comments

Comments
 (0)