Skip to content

Commit eed93a4

Browse files
isaacvetterisaacvetter
authored
Merge branch 'master' into propose-order-sign-hook
2 parents 0e9f965 + ffde209 commit eed93a4

File tree

2 files changed

+370
-4
lines changed

2 files changed

+370
-4
lines changed

‎docs/hooks/order-select.md

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

‎mkdocs.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,11 @@ nav:
1616
- '1.0': 'specification/1.0.md'
1717
- Hooks:
1818
- 'new-hook-template' : 'hooks/template.md'
19-
- 'patient-view' : 'hooks/patient-view.md'
20-
- 'medication-prescribe' : 'hooks/medication-prescribe.md'
21-
- 'order-sign' : 'hooks/order-sign.md'
22-
- 'order-review' : 'hooks/order-review.md'
19+
- 'patient-view 4' : 'hooks/patient-view.md'
20+
- 'medication-prescribe 2' : 'hooks/medication-prescribe.md'
21+
- 'order-review 3' : 'hooks/order-review.md'
22+
- 'order-select 1' : 'hooks/order-select.md'
23+
- 'order-sign 1' : 'hooks/order-sign.md'
2324
- Quick Start: 'quickstart.md'
2425
- Best Practices: 'best-practices.md'
2526
- Examples: 'examples.md'

0 commit comments

Comments
 (0)