medication-prescribe

Metadata Value
specificationVersion 1.0
hookVersion 1.0
Hook maturity 2 - Tested

Deprecation Notice

This hook is deprecated in favor of the order-select and order-sign hooks, with the goal of clarifying workflow trigger points and supporting orders beyond medications. In this refactoring, medication-prescribe and order-review hooks are being deprecated in favor of newly created order-select and order-sign hooks. This notice is a placeholder to this effect while CDS Hooks determines the appropriate process for deprecating hooks.

Workflow

The user is in the process of prescribing one or more new medications.

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 REQUIRED Yes string The id of the current user.
For this hook, the user is expected to be of type Practitioner.
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
STU3 - FHIR Bundle of draft MedicationRequest resources

Example (STU3)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
{
  "context":{
    "userId":"Practitioner/123",
    "patientId":"1288992",
    "encounterId":"89284",
    "medications":{
      "resourceType":"Bundle",
      "entry":[
        {
          "resource":{
            "resourceType":"MedicationRequest",
            "id":"smart-MedicationRequest-103",
            "meta":{
              "lastUpdated":"2018-04-30T13:25:40.845-04:00"
            },
            "text":{
              "status":"generated",
              "div":"<div xmlns=\"http://www.w3.org/1999/xhtml\">Amoxicillin 120 MG/ML / clavulanate potassium 8.58 MG/ML Oral Suspension (rxnorm: 617993)</div>"
            },
            "status":"draft",
            "intent":"order",
            "medicationCodeableConcept":{
              "coding":[
                {
                  "system":"http://www.nlm.nih.gov/research/umls/rxnorm",
                  "code":"617993",
                  "display":"Amoxicillin 120 MG/ML / clavulanate potassium 8.58 MG/ML Oral Suspension"
                }
              ],
              "text":"Amoxicillin 120 MG/ML / clavulanate potassium 8.58 MG/ML Oral Suspension"
            },
            "subject":{
              "reference":"Patient/1288992"
            },
            "dosageInstruction":[
              {
                "text":"5 mL bid x 10 days",
                "timing":{
                  "repeat":{
                    "boundsPeriod":{
                      "start":"2005-01-04"
                    },
                    "frequency":2,
                    "period":1,
                    "periodUnit":"d"
                  }
                },
                "doseQuantity":{
                  "value":5,
                  "unit":"mL",
                  "system":"http://unitsofmeasure.org",
                  "code":"mL"
                }
              }
            ],
            "dispenseRequest":{
              "numberOfRepeatsAllowed":1,
              "quantity":{
                "value":1,
                "unit":"mL",
                "system":"http://unitsofmeasure.org",
                "code":"mL"
              },
              "expectedSupplyDuration":{
                "value":10,
                "unit":"days",
                "system":"http://unitsofmeasure.org",
                "code":"d"
              }
            }
          }
        },
        {
          "resource":{
            "resourceType":"MedicationRequest",
            "id":"smart-MedicationRequest-104",
            "meta":{
              "lastUpdated":"2018-04-30T13:26:48.124-04:00"
            },
            "text":{
              "status":"generated",
              "div":"<div xmlns=\"http://www.w3.org/1999/xhtml\">Azithromycin 20 MG/ML Oral Suspension [Zithromax] (rxnorm: 211307)</div>"
            },
            "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)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
{
  "context":{
    "userId":"Practitioner/123",
    "patientId":"1288992",
    "encounterId":"89284",
    "medications":{
      "resourceType":"Bundle",
      "entry":[
        {
          "resource":{
            "resourceType":"MedicationOrder",
            "id":"smart-MedicationOrder-103",
            "status":"draft",
            "patient":{
              "reference":"Patient/1288992"
            },
            "medicationCodeableConcept":{
              "coding":[
                {
                  "system":"http://www.nlm.nih.gov/research/umls/rxnorm",
                  "code":"617993",
                  "display":"Amoxicillin 120 MG/ML / clavulanate potassium 8.58 MG/ML Oral Suspension"
                }
              ],
              "text":"Amoxicillin 120 MG/ML / clavulanate potassium 8.58 MG/ML Oral Suspension"
            },
            "dosageInstruction":[
              {
                "text":"5 mL bid x 10 days",
                "timing":{
                  "repeat":{
                    "boundsPeriod":{
                      "start":"2005-01-04"
                    },
                    "frequency":2,
                    "period":1,
                    "periodUnits":"d"
                  }
                },
                "doseQuantity":{
                  "value":5,
                  "unit":"mL",
                  "system":"http://unitsofmeasure.org",
                  "code":"mL"
                }
              }
            ],
            "dispenseRequest":{
              "numberOfRepeatsAllowed":1,
              "quantity":{
                "value":1,
                "unit":"mL",
                "system":"http://unitsofmeasure.org",
                "code":"mL"
              },
              "expectedSupplyDuration":{
                "value":10,
                "unit":"days",
                "system":"http://unitsofmeasure.org",
                "code":"d"
              }
            }
          }
        },
        {
          "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
1.0 Initial Release