Skip to content

Commit c195d20

Browse files
isaacvetterisaacvetter
authored
create medication-refill.md
1 parent 70fdc1e commit c195d20

File tree

1 file changed

+174
-0
lines changed

1 file changed

+174
-0
lines changed

‎docs/hooks/medication-refill.md‎

Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
# `medication-refill`
2+
3+
| Metadata | Value
4+
| ---- | ----
5+
| specificationVersion | 1.0
6+
| hookVersion | 0.1.0
7+
8+
## Workflow
9+
10+
The `medication-refill` hook fires when a medication refill is requested for an existing prescription of a specific medication. A refill request may be made as part of an encounter or out-of-band through a pharmacy. There may not be either an encounter or user in context when the refill request is received. A CDS service may use this hook to deliver medication refill protocol guidance to a clinician.
11+
12+
## Context
13+
14+
The set of medications proposed or in progress of being prescribed. All FHIR resources in this context MUST be based on the same FHIR version. All FHIR resources in the medications object MUST have a status of _draft_.
15+
16+
Field | Optionality | Prefetch Token | Type | Description
17+
----- | -------- | ---- | ---- | ----
18+
`userId` | OPTIONAL | 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`
19+
`patientId` | REQUIRED | Yes | *string* | The FHIR `Patient.id` of the current patient in context
20+
`encounterId` | OPTIONAL | Yes | *string* | The FHIR `Encounter.id` of the current encounter in context
21+
`medications` | REQUIRED | No | *object* | DSTU2 - FHIR Bundle of _draft_ MedicationOrder resources <br/> STU3 - FHIR Bundle of _draft_ MedicationRequest resources
22+
23+
### Example (STU3)
24+
25+
```json
26+
{
27+
"context":{
28+
"userId":"Practitioner/123",
29+
"patientId":"1288992",
30+
"encounterId":"89284",
31+
"medications":{
32+
"resourceType":"Bundle",
33+
"entry":[
34+
{
35+
"resource":{
36+
"resourceType":"MedicationRequest",
37+
"id":"smart-MedicationRequest-104",
38+
"status":"draft",
39+
"intent":"order",
40+
"medicationCodeableConcept":{
41+
"coding":[
42+
{
43+
"system":"http://www.nlm.nih.gov/research/umls/rxnorm",
44+
"code":"211307",
45+
"display":"Azithromycin 20 MG/ML Oral Suspension [Zithromax]"
46+
}
47+
],
48+
"text":"Azithromycin 20 MG/ML Oral Suspension [Zithromax]"
49+
},
50+
"subject":{
51+
"reference":"Patient/1288992"
52+
},
53+
"dosageInstruction":[
54+
{
55+
"text":"15 mL daily x 3 days",
56+
"timing":{
57+
"repeat":{
58+
"boundsPeriod":{
59+
"start":"2005-01-18"
60+
},
61+
"frequency":1,
62+
"period":1,
63+
"periodUnit":"d"
64+
}
65+
},
66+
"doseQuantity":{
67+
"value":15,
68+
"unit":"mL",
69+
"system":"http://unitsofmeasure.org",
70+
"code":"mL"
71+
}
72+
}
73+
],
74+
"dispenseRequest":{
75+
"numberOfRepeatsAllowed":1,
76+
"quantity":{
77+
"value":1,
78+
"unit":"mL",
79+
"system":"http://unitsofmeasure.org",
80+
"code":"mL"
81+
},
82+
"expectedSupplyDuration":{
83+
"value":3,
84+
"unit":"days",
85+
"system":"http://unitsofmeasure.org",
86+
"code":"d"
87+
}
88+
}
89+
}
90+
}
91+
]
92+
}
93+
}
94+
}
95+
```
96+
97+
### Example (DSTU2)
98+
99+
```json
100+
{
101+
"context":{
102+
"userId":"Practitioner/123",
103+
"patientId":"1288992",
104+
"encounterId":"89284",
105+
"medications":{
106+
"resourceType":"Bundle",
107+
"entry":[
108+
{
109+
"resource":{
110+
"resourceType":"MedicationOrder",
111+
"id":"smart-MedicationOrder-104",
112+
"status":"draft",
113+
"patient":{
114+
"reference":"Patient/1288992"
115+
},
116+
"medicationCodeableConcept":{
117+
"coding":[
118+
{
119+
"system":"http://www.nlm.nih.gov/research/umls/rxnorm",
120+
"code":"211307",
121+
"display":"Azithromycin 20 MG/ML Oral Suspension [Zithromax]"
122+
}
123+
],
124+
"text":"Azithromycin 20 MG/ML Oral Suspension [Zithromax]"
125+
},
126+
"dosageInstruction":[
127+
{
128+
"text":"15 mL daily x 3 days",
129+
"timing":{
130+
"repeat":{
131+
"boundsPeriod":{
132+
"start":"2005-01-18"
133+
},
134+
"frequency":1,
135+
"period":1,
136+
"periodUnits":"d"
137+
}
138+
},
139+
"doseQuantity":{
140+
"value":15,
141+
"unit":"mL",
142+
"system":"http://unitsofmeasure.org",
143+
"code":"mL"
144+
}
145+
}
146+
],
147+
"dispenseRequest":{
148+
"numberOfRepeatsAllowed":1,
149+
"quantity":{
150+
"value":1,
151+
"unit":"mL",
152+
"system":"http://unitsofmeasure.org",
153+
"code":"mL"
154+
},
155+
"expectedSupplyDuration":{
156+
"value":3,
157+
"unit":"days",
158+
"system":"http://unitsofmeasure.org",
159+
"code":"d"
160+
}
161+
}
162+
}
163+
}
164+
]
165+
}
166+
}
167+
}
168+
```
169+
170+
## Change Log
171+
172+
Version | Description
173+
---- | ----
174+
0.1.0 | Initial Release

0 commit comments

Comments
 (0)