CDS Hooks Library
1.0.1 - STU1 International flag

This page is part of the CDS Hooks Hook Library (v1.0.1: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Template

Page standards status: Informative

`hook-name-expressed-as-noun-verb`

This page defines a workflow hook for the purpose of providing clinical decision support using CDS Hooks. This is a build | snapshot | ballot | release at the level of Draft | Trial Use | Normative | Informative | Deprecated
Metadata Value
specificationVersion 1.0
hookVersion 0.1.0
hookMaturity 0 - Draft

Workflow

Describe when the hook occurs in a workflow. Hook creators SHOULD include as much detail and clarity as possible to minimize any ambiguity or confusion amongst implementers. The hook name should take the form `noun-verb`, such as `encounter-start`, or `order-select` according to the [Hook Definition Format](http://cds-hooks.hl7.org/STU2/index.html#hook-definition-format).

Context

Define context values that are available when this hook occurs, and indicate whether they must be provided, and whether they are available for parameterizing prefetch templates.

Field Optionality Prefetch Token Type Description
`exampleId` REQUIRED Yes string Describe the context value
`encounterId` OPTIONAL Yes string Describe the context value

Examples

"context":{
  "patientId" : "1288992"
}

"context":{
  "patientId" : "1288992",
  "encounterId" : "456"
}

</mark>

Change Log

Version Description
1.0 Initial Release