Skip to content

Commit 1ff5319

Browse files
authored
hook versioning and naming
following version 1.x, the major version MAY be included in the name as "-2", "-3", etc. Fixes #291
1 parent cc25d3b commit 1ff5319

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/hooks/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ To help ensure the stability of CDS Hooks implementations, once a hook has been
167167

168168
In particular, the semantics of a hook (i.e. the meaning of the hook from the perspective of the EHR) cannot be changed. EHRs that implement specific hooks are responsible for ensuring the hook is called from the appropriate point in the workflow.
169169

170-
Note that this means that the name of the hook carries major version semantics. That is not to say that the name must include the major version, that is left as a choice by users of the specification. Clean hook names increase usability. Ideally, an active hook name accurately defines the meaning and workflow of the hook in actual words.
170+
Note that this means that the name of the hook carries major version semantics. That is not to say that the name must include the major version, that is left as a choice to authors of the specification. For example, following version 1.x, the major version MAY be included in the name as "-2", "-3", etc. Eg: patient-view-2, patient-view-3, etc. Clean hook names increase usability. Ideally, an active hook name accurately defines the meaning and workflow of the hook in actual words.
171171

172172
The following types of changes are possible for a hook definition:
173173

0 commit comments

Comments
 (0)