Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

create medication-refill.md #432

Merged
merged 9 commits into from
Oct 6, 2023
Merged

create medication-refill.md #432

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c195d20
create medication-refill.md
isaacvetter Nov 15, 2018
6e1c6d7
add draft med-refill hook to menu
isaacvetter Nov 19, 2018
a5eaf0f
Update medication-refill.md
isaacvetter Sep 20, 2023
84a37e4
Merge branch 'master' into propose-medication-refill-hook
isaacvetter Sep 21, 2023
651084d
clarify user and encounter
isaacvetter Sep 22, 2023
71677d1
Update medication-refill.md
isaacvetter Sep 25, 2023
159c3c6
from may not to does not
isaacvetter Oct 4, 2023
7270de6
hook spec to 2.0 from 1.0
isaacvetter Oct 4, 2023
188b319
trigger checks
isaacvetter Oct 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
174 changes: 174 additions & 0 deletions docs/hooks/medication-refill.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
# `medication-refill`

| Metadata | Value
| ---- | ----
| specificationVersion | 1.0
| hookVersion | 0.1.0

## Workflow

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.

## Context

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_.

Field | Optionality | Prefetch Token | Type | Description
----- | -------- | ---- | ---- | ----
`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`
`patientId` | REQUIRED | Yes | *string* | The FHIR `Patient.id` of the current patient in context
`encounterId` | OPTIONAL | Yes | *string* | The FHIR `Encounter.id` of the current encounter in context
`medications` | REQUIRED | No | *object* | DSTU2 - FHIR Bundle of _draft_ MedicationOrder resources <br/> STU3 - FHIR Bundle of _draft_ MedicationRequest resources

### Example (STU3)

```json
{
"context":{
"userId":"Practitioner/123",
"patientId":"1288992",
"encounterId":"89284",
"medications":{
"resourceType":"Bundle",
"entry":[
{
"resource":{
"resourceType":"MedicationRequest",
"id":"smart-MedicationRequest-104",
"status":"draft",
"intent":"order",
"medicationCodeableConcept":{
"coding":[
{
"system":"http://www.nlm.nih.gov/research/umls/rxnorm",
"code":"211307",
"display":"Azithromycin 20 MG/ML Oral Suspension [Zithromax]"
}
],
"text":"Azithromycin 20 MG/ML Oral Suspension [Zithromax]"
},
"subject":{
"reference":"Patient/1288992"
},
"dosageInstruction":[
{
"text":"15 mL daily x 3 days",
"timing":{
"repeat":{
"boundsPeriod":{
"start":"2005-01-18"
},
"frequency":1,
"period":1,
"periodUnit":"d"
}
},
"doseQuantity":{
"value":15,
"unit":"mL",
"system":"http://unitsofmeasure.org",
"code":"mL"
}
}
],
"dispenseRequest":{
"numberOfRepeatsAllowed":1,
"quantity":{
"value":1,
"unit":"mL",
"system":"http://unitsofmeasure.org",
"code":"mL"
},
"expectedSupplyDuration":{
"value":3,
"unit":"days",
"system":"http://unitsofmeasure.org",
"code":"d"
}
}
}
}
]
}
}
}
```

### Example (DSTU2)

```json
{
"context":{
"userId":"Practitioner/123",
"patientId":"1288992",
"encounterId":"89284",
"medications":{
"resourceType":"Bundle",
"entry":[
{
"resource":{
"resourceType":"MedicationOrder",
"id":"smart-MedicationOrder-104",
"status":"draft",
"patient":{
"reference":"Patient/1288992"
},
"medicationCodeableConcept":{
"coding":[
{
"system":"http://www.nlm.nih.gov/research/umls/rxnorm",
"code":"211307",
"display":"Azithromycin 20 MG/ML Oral Suspension [Zithromax]"
}
],
"text":"Azithromycin 20 MG/ML Oral Suspension [Zithromax]"
},
"dosageInstruction":[
{
"text":"15 mL daily x 3 days",
"timing":{
"repeat":{
"boundsPeriod":{
"start":"2005-01-18"
},
"frequency":1,
"period":1,
"periodUnits":"d"
}
},
"doseQuantity":{
"value":15,
"unit":"mL",
"system":"http://unitsofmeasure.org",
"code":"mL"
}
}
],
"dispenseRequest":{
"numberOfRepeatsAllowed":1,
"quantity":{
"value":1,
"unit":"mL",
"system":"http://unitsofmeasure.org",
"code":"mL"
},
"expectedSupplyDuration":{
"value":3,
"unit":"days",
"system":"http://unitsofmeasure.org",
"code":"d"
}
}
}
}
]
}
}
}
```

## Change Log

Version | Description
---- | ----
0.1.0 | Initial Release
1 change: 1 addition & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ nav:
- 'new-hook-template' : 'hooks/template.md'
- 'patient-view' : 'hooks/patient-view.md'
- 'medication-prescribe' : 'hooks/medication-prescribe.md'
- 'medication-refill' : 'hooks/medication-refill.md'
- 'order-review' : 'hooks/order-review.md'
- Quick Start: 'quickstart.md'
- Examples: 'examples.md'
Expand Down