Skip to content

Commit 5d15ca9

Browse files
isaacvetterkpshek
authored andcommitted
Clarify the naming of subsequent major hook versions (#389)
Additionally, indicate that the addition of new OPTIONAL fields would be a minor update. Fixes #290 and fixes #291
1 parent 39322bc commit 5d15ca9

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/hooks/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,15 +169,16 @@ To help ensure the stability of CDS Hooks implementations, once a hook has been
169169

170170
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.
171171

172-
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.
172+
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.
173173

174174
The following types of changes are possible for a hook definition:
175175

176176
Change | Version Impact
177177
------ | ----
178178
Clarifications and corrections to documentation that do not impact functionality | Patch
179179
Change of prefetch token status of an existing context field | Patch
180-
Addition of a new field to the context | Minor
180+
Addition of a new, REQUIRED field to the context | Major
181+
Addition of a new, OPTIONAL field to the context | Minor
181182
Change of optionality of an existing context field | Major
182183
Change of type or cardinality of an existing context field | Major
183184
Removal of an existing context field | Major

0 commit comments

Comments
 (0)