CDS Hooks Library, published by Clinical Decision Support WG. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cds-hooks-library/ and changes regularly. See the Directory of published versions
| Page standards status: Informative |
| Metadata | Value |
|---|---|
| specificationVersion | 1.0 |
| hookVersion | 0.1.0 |
| hookMaturity | 0 - Draft |
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.
Consider creating a diagram to illustrate the workflow in which this hook is called. The order-sign workflow diagram was created with a tool like: Railroad Diagram Generator.
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 |
"context":{
"patientId" : "1288992"
}
"context":{
"patientId" : "1288992",
"encounterId" : "456"
}
| Version | Description |
|---|---|
| 0.1.0 | Initial Release |